Enable Gotham integration through type mapping

Type mapping enables a unified representation of an Ontology across Foundry and Gotham that users manage within Foundry's Ontology Manager application. Users can create new Gotham types based on existing Foundry object types, property types, and shared property types which remain synchronized as an Ontology evolves over time. After completing the type mapping process, Gotham will be able to query Foundry object types and their metadata through the Object Set Service - a Foundry backend service which supports object data searching, filtering, aggregating, and loading.

Toggle on type mapping in Foundry's Ontology Manager

To integrate data in your Foundry Ontology with Gotham, you will first need to toggle on type mapping for your object type of interest within Foundry's Ontology Manager by following the steps below:

1. Launch Ontology Manager from your home screen.
2. Locate and select your object type to type map.
3. Select Capabilities within the object type's left-hand panel.
4. Scroll down to the Gotham Integration panel and toggle on Allow objects of this type to be accessed from Gotham applications.

Configure an object type's parent category and Gotham property types

Once you toggle on Gotham Integration, you can follow the steps below to create a new Gotham object type derived from an existing Foundry object type, specify the object type's Parent category, and configure its Property types:

1. Select Create a new object type within the Object type section of Gotham Integration to create a new object type in Gotham from an existing Foundry object type.
2. Identify the Parent category of the new object type in Gotham by selecting between Entity (such as a person, organization, or vehicle), Event (such as a flight, meeting, or concert), or Document (such as a PDF file, text document, or report) based on your use case.
3. Use the Property types section to map Foundry object type properties to Gotham - a property can be shared or cloned into the Gotham ontology. You will see a blue Mapped tag next to the property's name once you complete that configuration on a given property.
   • Assign to shared property enables you to select an existing shared property to map against.
   • Promote to shared property creates a new shared property for use by other objects.
   • Create a local clone of the property in Gotham creates a duplicate of the selected property in Gotham that is compatible with its applications.
   • Do not map property to Gotham is the default option - Foundry properties you do not map will not propagate in the Gotham ontology.
4. Select the green Save button on the right side of the top ribbon of your screen and review.
5. Review the changes made to your object type and select Save to ontology.

After you save your changes to the Ontology, scroll back up to the Gotham Integration section of the Capabilities page of your object type. You will now see a Gotham URI assigned to the object type and be able to view the Installation status reported by Gotham.

Foundry's Ontology Manager will display one of the following installation statuses:

• Ready to integrate: An object type is ready for type mapping to enable Gotham integration.
• Installation in progress: The object type's installation process is underway.
• Installation complete: The installation process is complete, so the object type is available for use in Gotham.
• Installation failed: {failureMessage}: The object type's installation failed at least once and will be retried on the next installation run. The {failureMessage} outlines the reason for failure. Common installation failures include:
  • Live reindex: If there is a live reindex running on Gotham, the ontology cannot be updated. Instead of staging changes during this time, the installation will fail and rerun automatically once the live reindex finishes.
  • Required types are not installed: For an object type's successful installation, all related property installations - or mappings - must be completed, including shared property types.
  • Other ontology updates: If there are ontology updates running concurrently, then the type mapper will not be able to update the ontology and will rerun automatically.

Once your object type's installation status reads Installation complete, you will be able to search for and use your object type in Gotham's applications.

To deprecate a type mapped object type in Gotham, you can delete the object type in Foundry's Ontology Manager. Once deleted in Foundry, the corresponding object type and its property types will not be accessible in Gotham or available to its applications.