IS2 Or MS2 Connectors

An IS2 or MS2 Connector can do the following things:

  • Return metadata describing the following: 
    • Actions —ActionDefinitions
    • Entities — ObjectDefinitions
    • Fields — PropertyDefinitions
  • If your Connector supports relationships, return metadata describing each object’s relationships with other objects via RelationshipDefinitions.
  • If you are using hierarchical data, do not define relationships.
  • If you are using hierarchal data structures, do not define relationships. Hierarchical data works like relationships for user defined types, however the relationships can extend beyond two levels. When you set the PropertyType of a PropertyDefinition to be the name of one of your ObjectDefinitions, one of two new relationships is created automatically, either Property (1 to 1) or PropertyCollection (1 to N). For more information on hierarchical data, see Hierarchical Data — Sample Connector Code.

  • If your Connector supports queries:
    • Perform queries filtered and sorted on a specified DateTime field in ascending order.
    • If your Connector is declaring any relationships, perform queries that return fields from both a root object and from related parent objects. It should also be able to return fields from child entities, and be able to handle both inner and outer joins.
    • Handle queries with complex lookup conditions that involve more than one field. You must handle or gracefully reject, but not necessarily support, conditions linked with AND’s and OR’s. You may use metadata to describe which fields can be filtered on, and return errors on lookup conditions you cannot support.

Some data technologies, such as REST Web Services, may not support all the listed functionality. However, you can use metadata to limit the user’s actions. For example, if your Connector does not support parent or child relationships, you can simply not declare the existence of any relationships in your metadata.

See Also

IS2 Or MS2 Connector Methods

Installing A Connector Locally

Testing A Connector