Enterprise Collaborator

Use Agreements to change the state of an agreement and edit values for the agreement’s control properties. The control properties contain environment-specific settings.

This configuration is used for both standard agreements and custom agreements.

To change between active and inactive state for two agreements with the same detection, include configuration resources for both agreements in the same local package. For example, you can deactivate a standard BOD agreement and activate a custom BOD agreement for the same BOD.

If you activate an agreement and there already is another active agreement with the same detection for the target tenant, that is not included as inactive in the same local package, the import fails.

The control properties’ names in the local package must match the control properties’ names for the agreement in the target tenant. Otherwise, the agreement versions cannot be the same, and the meaning of the control properties might have been changed. In this case, include the custom agreement content resource for the agreement in the same local package.

Hard-coded companies and divisions in agreement group names, agreement names, and control properties, are not updated to the organization for the target tenant.

A custom agreement must already exist for the target tenant, or it must be included as content in the same local package.

Use Custom Agreements to manage these categories of agreements:

• custom BOD agreements with paths starting with 'Custom/'
• custom non-BOD agreements with paths starting with 'Agreements/'

You can export and import both active and inactive custom agreements.

A new custom agreement in the target tenant is inactive after import by default.

An updated custom agreement in the target tenant maintains its current active or inactive status and its current control properties’ values (for matching control properties) by default. You can set the state and the control properties’ values for a custom agreement with the custom agreement configuration resource in the same local package.

Hard-coded companies and divisions in agreement group names, agreement names, control properties values, and other agreement and configuration settings, are not updated to the organization for the target tenant.

All mappings used by the agreement are included. There is no validation that custom APIs used by the mappings exist or have the correct configuration in the target tenant. The mappings use the custom APIs and their configurations from the source tenant. If these do not match, a runtime error appears when processing a message in the target tenant. Use M3 Business Engine configurations and XtendM3 extension content for transactions to export and import custom APIs in the same or other local packages.

This content for custom agreement configuration data is not yet included for custom non-BOD agreements, and you must set it manually in the Enterprise Collaborator Configuration administration tool for the target tenant after import:

• Event Hub subscription is required for outbound agreements
• Document is required for inbound agreements, document for the Send process is created in the agreement but not as a configuration
• String Replacer is optional, if used by a mapping

If these custom configurations are missing in the target tenant, the imported agreement does not work as intended.

Content for custom String Replacer, if used, is not included for custom BOD agreements, and you must set it manually for the target tenant after import.

Agreement groups are created for the target tenant on import if needed. Description and control properties for agreement groups are not included in the export and remain as they are for existing agreement groups for the target tenant.