• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationPeer Manager [Experimental]Configure Ontology peering

    Configure Ontology peering

    After you establish a peering relationship between two spaces, you can use Peer Manager to create and approve object type mappings which enable you to peer its objects over the connection.

    Make the object type available to peer

    Navigate to Peer Manager and follow the instructions below for both the local and remote sides of the peer connection to make the object type available to peer:

    1. Choose the relevant peer connection and select the Ontology tab from the top of your screen.
    2. Select the Unmapped tab before choosing + Add ontology entities.
    3. Search for and select one or multiple object types you will make available for peering over the connection before choosing Confirm selection to launch the Configure sharing permissions popup window.
    4. Optionally change Peer Manager's default sharing permissions state, which allows both exports and imports and ensures the object type's state remains synchronized across the local and remote spaces.

    If you want to establish a unidirectional object type peering relationship where the local space sends objects to the remote space without receiving object edits the remote side makes, then you can select Imports blocked.

    1. Select Add ontology entities to add the object types to the Unmapped section of the Ontology.

    An object type is made available for peering in Peer Manager.

    Create the object type mapping

    Once you make the object type available to peer across both sides of the peer connection, you can next follow the instructions below to configure the object type mapping from either side of the relationship:

    1. Align the corresponding object types from the Local ontology and Remote ontology in the Unmapped section of the Ontology tab.
    2. Select + on the right side of the Remote ontology object type to launch the Create ontology mapping popup window.
    3. Map the corresponding properties across the local and remote object types in the Map properties section.

    Create a mapping between local and remote object types in the Create ontology mapping popup window to enable peering between the two.

    You do not need to map every property; however, you must map any properties you wish to peer over the established connection.

    1. Optionally configure the peering relationship's Source data and Actions directionality in the Configure peering section.
    • Source data is the base data for the object type derived from its backing datasource(s), such as datasets, virtual tables, or restricted views. You can export source data from a cloud to edge instance or between edge instances.

    Peer Manager is in the beta phase of its development lifecycle and does not yet support the ability to export source data between cloud instances.

    • Actions produce data from user edits applied onto Source data. You should bidirectionally peer Actions if edits are enabled for the object type, so you should ensure both Export and Import are selected.
    1. Review the configuration for the object type in the Summary section and choose Submit to save the mapping.

    Foundry immediately instantiates the peering relationship for your object type after you press submit. You can monitor the connection's health in Peer Manager's Overview panel.