Create Ontology objects from Gaia

Similar to how you can add data from the Ontology to a Gaia map, you can also create Ontology objects from a shape you draw on a map by tagging the object within a type-mapped object type which implements the Gaia Geocreatable interface.

The sections below outline the end-to-end process to integrate Gaia shapes with the Ontology:

• Install all necessary Marketplace products.
• Implement the Gaia Geocreatable interface on a supported object type backed by a restricted view.
• Register and search for your object type in Gaia.
• Draw a new shape on your map and tag it within your object type.

Install prerequisite Marketplace products

Marketplace is Foundry's storefront for published data products or collections of platform resources made available for user installation. You can access Marketplace through the Search... bar or the Applications portal on your home screen.

Once you launch Marketplace, install the following products:

• Core Property Types from the Core Ontology Store, which contains core shared property types, such as an object's classification and geoshape, that can be used on multiple object types in your Ontology.
• Gaia Geocreatable interface from the Gaia App Store, which describes the shape of a geospatial object type to enable consistent modeling of and interaction with other object types of the same shape.

Core Property Types from the Core Ontology Store

To install the Core Property Types product from the Core Ontology Store:

1. Search for and select Core Ontology Store using the Search stores... bar on the right side of your screen.
2. Select the Core Property Types product from the store menu.

3. Choose the blue Install button on the right side of your screen to launch a draft installation. You can optionally add a descriptive suffix to your installation.

4. Identify a Namespace where your installation will save. Marketplace will automatically create a new Project within the chosen Namespace.
5. Configure the product's classification and access controls under Permissions. The classification you select under Classification based access control (CBAC) defines the maximum classification for the installation.
6. Select Next.
7. Validate the Shared property list generated by the Core Property Types product, which may vary based on the product's version, before you select Next.
8. Update the automatic configurations in New versions as necessary for your use case before you select Next. Marketplace pre-configures certain products to upgrade automatically.

9. Review your product's configurations and select Install.

You can search for your newly installed and suffixed Core Property Types product using Quicksearch.

You will next install the Gaia Geocreatable interface from the Gaia App Store in Marketplace.

Gaia Geocreatable interface from the Gaia App Store

In Foundry, interfaces exist within your Ontology to describe an object type's shape as well as its capabilities, enabling consistent modeling and interaction between object types of a common shape. You can implement an interface on multiple object types, and interfaces may extend any number of other interfaces. Once implemented on an object type, the Gaia Geocreatable interface enables you to create objects in your Ontology from shapes drawn on a Gaia map.

To install the Gaia Geocreatable interface from Marketplace:

1. Navigate back to Marketplace and search for the Gaia App Store in Search stores....
2. Choose the Gaia Geocreatable product.
3. Select the blue Install button on the right side of your screen to launch a draft installation. You can optionally add a descriptive suffix to your installation.
4. Identify a Namespace where your installation will save. Marketplace will automatically create a new Project within the chosen Namespace.
5. Configure the product's classification and access controls under Permissions. The classification you select under Classification based access control (CBAC) defines the maximum classification for the installation.
6. Select Next to launch the installation window's Inputs page.
7. Select the Shared properties tab under Inputs in the left panel to map shared properties from your Ontology to your new interface, such as Classification, Geoshape, and Map ID.

8. Map shared properties for the missing inputs, such as Classification, Geoshape, and Map ID before you select Next to launch the installation window's Content page.

9. Optionally toggle on Prefix Ontology entities and insert a valid prefix. Note that your prefix may not contain certain special characters, such as parentheses or brackets.
10. Choose which Ontology schema migrations to enable on the right side of your screen. You can reference additional schema management information within the existing object edits and materializations documentation.
11. Update the automatic configurations in New versions as necessary for your use case before you select Next. Marketplace pre-configures certain products to upgrade automatically.
12. Review your interface's configurations and select Install.

Create an object type that implements the Gaia Geocreatable interface

Gaia can discover object types backed by a restricted view in your Ontology after they implement the Gaia Geocreatable interface. In the following sections, you will:

• Create an object type-backing restricted view.
• Create an object type and enable its integration with Gotham through type mapping.
• Configure an Action type to enable object creation in Gaia.
• Implement the Gaia Geocreatable interface.

Create an object type-backing restricted view

To create an object type that can integrate with Gaia, you will first need to create a restricted view from a dataset that contains, at a minimum, the following columns:

• Name, which you will set as a string to enable a user to title their shape as an object.
• Classification, which you will set as an array to capture your object's classification.
• Geoshape, which you will set as a string for Gaia to automatically populate with your drawn object's shape.
• Map ID, which you will set as a string for Gaia to automatically populate with your drawn object's map ID.
• Object ID, which you will set as a string for Foundry to automatically populate with a unique ID for each Gaia shape you create as an object.

Select the New button in your Project to upload an existing file, such as a .csv, or use Fusion to create the dataset which backs your restricted view.

Your restricted view should contain a granular policy that restricts user access to the data contained in the view based on their classification access. Compose the granular policy as the second step in the Create restricted view window.

You can reference an example policy in JSON below.

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "condition": {
    "type": "and",
    "and": {
      "conditions": [
        {
          "type": "markings",
          "markings": {
            "value": {
              "type": "field",
              "field": {
                "fieldName": "classification",
                "nestedField": null
              }
            },
            "filters": [
              {
                "type": "markingTypes",
                "markingTypes": {
                  "markingTypes": [
                    "CBAC"
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

Create and type-map an object type

Once you configure your restricted view, launch Ontology Manager and follow the steps below to create your object type and type-map it to enable integration with Gotham:

1. Select New > Object type from the top right of your screen.
2. Select Use existing datasource and choose Select datasource to locate and Select your restricted view before choosing Next.
3. Name your object type and optionally enter a Description.
4. Set Object ID as the Primary Key and Name as the Title.
5. Ensure Classification's Property is an array of strings and Geoshape's Property is geoshape.

6. Select the Create {object type name} action type before you add users or groups who may execute that action. Next, choose to Create your draft object type.

With your draft object type viewable in Ontology Manager, you will next select the Classification, Geoshape, and Map ID properties as shared property types in your Ontology. Select the Properties panel beneath Overview and follow the steps below to complete the shared property type selection process:

1. Select Classification from your list of properties to launch the Property editor window on the right side of your screen.
2. Update the Base type dropdown menus to contain Marking and CBAC Marking, respectively.
3. Configure the property's Max Classification.

4. Scroll to the bottom of the window to the Shared property section to assign Classification as a shared property in the Select a shared property dropdown menu.

Repeat steps one and four above for your Geoshape and Map ID properties, as you will not need to configure their Markings or classification. Select the green Save button at the top of the screen to publish incremental changes to your Ontology before proceeding.

Next, you will render objects within your object type as discoverable from Gotham applications by completing the type mapping process. Select the Capabilities panel beneath Datasources and follow the steps below to type-map your object type's properties:

1. Scroll down to and toggle on Gotham Integration.
2. Select Create new object type under Object type.
3. Choose the appropriate Parent category for your object type.
4. Optionally clone your non-shared property types by selecting Create a clone of the property in Gotham to the right of each in the dropdown menu.

Ontology Manager automatically type-maps Geoshape and populates your other shared property types, such as Classification and Map ID, in the Property types dropdown menu to the right of each property type.

Additionally, Ontology Manager provides an optional interface to configure intrinsic values on Gotham objects derived from properties you type-map from your Ontology. Gotham's object model enables you to set property types in your Ontology that contain geotemporal data as metadata of an object in Gotham. As an example, if you create a Vessel object type in your Ontology whose object instances contain a geohash property type that records the object's location, then you can set the geohash property type as an object-level intrinsic in Gotham.

Configure an Action type to enable object creation in Gaia

Once the properties of your object type are configured to enable Gotham integration, you can navigate back to the Overview window in Ontology Manager. Here, you will modify your Create {object type name} Action type to enable users to create objects from shapes and configure their properties, such as Name and Category, from Gaia. Follow the steps below to configure your Action type:

1. Select Create {object type name} from the Action types section of your object type's Overview window.
2. Select Rules from the left side of the screen.
3. Reconfigure the Geoshape property as a string type by selecting the arrow icon next to Configure parameter.
   • Select String from the Type dropdown menu on the right side of the screen.
   • Ensure the Disabled option is selected in the General panel so a user cannot manually configure the location of a Geoshape.

4. Select your Classification property's Configure parameter arrow icon to verify its Type is Marking.
5. Select Map Id from the Form content panel on the left side of your screen and toggle on Disabled in the General panel to ensure a user cannot manually configure a Map Id.
6. Navigate back to Form and remove Object Id from Form content by selecting the X icon on the far right side of the Object Id panel. Foundry will automatically generate a unique ID for each object created from Gaia.

Implement the Gaia Geocreatable interface

The final step in creating and configuring your object type in Ontology Manager is to implement the Gaia Geocreatable interface that you previously installed from Marketplace. Navigate back to your object type's Overview page and follow the steps below to implement the interface before saving changes to your Ontology:

1. Navigate to the Interfaces window beneath Object Views on the left side of your screen.
2. Select Implement new interface and search for Gaia Geocreatable before choosing Next.
3. Map your Ontology's shared property types to the object type implementing the interface by selecting Replace existing for your Classification and Geoshape properties. Map ID will map automatically.

4. Select Confirm to close the Implement an interface window and Save the newly configured interface to your Ontology.

Register your object type in the Gaia admin application

Now, you have an object type that implements the Gaia Geocreatable interface and contains an Action type to enable a user to configure objects they create from shapes drawn on a Gaia map. Next, you will register the object and Action type in Gaia's admin application.

To register your object and Action type, launch the Gaia admin application and follow the steps below:

1. Locate the Foundry Object Creation Config panel and select Show.
2. Select Add at the bottom of your enrollment's existing object and Action type list.
3. Copy and paste the RIDs for both your object type and Action type into the Object type rid and Action type rid text boxes, respectively.
4. Select Preview and save in the top right ribbon.

You can access your object type's RID from the Overview window in Ontology Manager. Select the clipboard icon to copy the RID. Additionally, you can access your Action type's RID by selecting Create {object type name} in the Action types section of the Overview window. The Action type's RID can also be copied through the clipboard icon.

Next, you will launch Gotham's Gaia application to create objects from shapes you draw on a map using its Create annotation layer menu.

Draw a new shape on your Gaia map and tag it to an object type

With your Gaia map open, select a shape to draw from the Create annotation layer menu in the top left region of your map. When you finish drawing your shape, the Create shape window will appear in Gaia's left panel. Follow the steps below to configure your shape and save it to your Ontology as an object:

1. Select the arrow on the far right of the Tag object (optional) panel.
2. Search for and select your object type in the Object type dropdown menu.
3. Enter a Category and Name for your object type before you select Finish.

Once you save your shape as an object, it will render as a Map layer in Gaia's left panel. You can select the object's name to launch the Selection panel on the right side of your screen, where you can view its properties and customize its appearance.

You can also view your object in Foundry's Object Explorer.

To learn more about the various methods you can use to add data from your Ontology to Gotham, review the existing geospatial data integration documentation.