The configuration file is divided into two sections:
Applications
This section contains entries for all applications/programs that can serve as CrossLink sources or targets.
The Applications section lists all applications (for example, GeoOffice analyst or Google Chrome) and their associated projects (such as a GeoOffice analyst MXD project file or a WebOffice project). These applications and projects can be used as either sources or targets in Integrator.
If a project is also intended to be used as a target, a TargetDefinition must be specified. This definition serves two purposes:
•It identifies the table and field in which values are searched.
•It defines the operation to be performed on the matching objects in the target application, such as selecting and zooming to the objects or editing the identified values.
Application
ID Defines a unique application ID within the configuration.
This ID is predefined for certain programs (GeoOfficeAnalyst, TestClient, UrlClient, WebOffice, ProOffice, DefaultBrowser) and can otherwise be freely chosen (for example, Firefox). ArcMap uses the application ID "GeoOffice Analyst".
ApplicationType
Available application types:
ExeAndParam: For executable programs started with parameters (for example, TestClient). This is the default.
BrowserAndUrl: For browser applications (for example, Chrome, Edge, Firefox).
Path
For ExeAndParam applications: The Path attribute contains the full path to the executable, including the executable name and file extension.
For BrowserAndUrl applications: The Path attribute contains the full path to the browser executable. If the path is empty, the system's default browser is launched.
Instances
Instance Configuration for a specific instance of an application.
Name Instance name. Can be freely chosen. Must be unique within the configuration. Is reused in the Sources section.
Project The project associated with this instance, such as an MXD file, URL, etc.
Transformer Specifies the message transformer to be used. If left empty, a DefaultTransformer is used. For BrowserAndUrl, a transformer is used that replaces the values in the URL at the {value} placeholder. For a WebOffice project, the WebOffice transformer is required.
Hint If the target application supports the POST method (for example, WebOffice or Google Search), it can be used to transfer a larger number of objects at once. Default: GET
TargetDefinition Defined when the instance is intended to act as a target.
StartBehaviour Available options: IfNecessary and Always. Depending on the setting, the target project is either: opened only if it is not already running, or always reopened.
BringTargetToForeGround If set to true, the target application is brought to the foreground. Default: false.
StartTimeout Maximum time, in seconds, during which the integration startup is attempted. Default: 30.
Operations
Operation Defines the action to be executed in the target instance.
Run Must be supported by the application.
Name Label displayed in the target selection dialog for this target operation. Can be freely chosen.
Visible If Visible="false" is specified, the operation is not shown in the target selection dialog.
Order Optional integer parameter that controls the order of operations within a TargetDefinition in the target selection dialog.
Tables Tables used in the target application.
Table
Name Name of the table.
TargetFields
TargetField
TargetFieldName Field on which the operation is performed. For example: Transferred values from a source can be searched in this field. Values in this field can be edited.
Values Placeholder value. The placeholder must match the placeholder configured in the corresponding SourceConfiguration, allowing the target operation to be linked to that source configuration.
ShowMismatch If users should be notified about features or values that could not be found, set this optional parameter to true.
Transform Optional. When specified: uppercase converts text values in Values to uppercase before sending them to the target. lowercase converts text values to lowercase.
The value is case-insensitive. Examples such as upperCase are also valid.
Sources
The Sources section defines the integration paths by specifying which of the previously defined projects act as the source and which act as the target for a particular integration.
This section also specifies the source tables and fields from which the values used for the Integrator transfer are read.
Sources Defines the tables and fields that serve as sources for values transferred to specific targets.
Source A separate Source block should be created for each Source Instance/Target Instance combination.
SourceInstances Lists the source instances for which integrations are configured in this source block.
SourceInstance
Name Name of the instance acting as the source. The name must exactly match the corresponding instance name in the Applications section.
SourceConfigurations
SourceConfiguration Defines: the source tables and fields from which values are transferred. the target instances for the integration.
TargetInstances Lists all target instances that can be reached from this source configuration.
TargetInstance
Name Name of the instance acting as the target. The name must exactly match the corresponding instance name defined in the Applications section.
Visible If Visible="false" is specified here, none of the available operations for that target will be displayed in the target selection dialog.
Order Optional integer parameter that controls the order of TargetInstance entries within a SourceConfiguration in the target selection dialog.
Tables Tables used in the source instance. All tables defined here must exist in the source application (for example, in the source MXD).
Table
Name Name of the table from which values are read for transfer.
Fields
Field
SourceFieldName The field from which values for the integration are read.
Placeholder Placeholder used to coordinate the integration. The value(s) from SourceFieldName are assigned to this placeholder. The same placeholder must also be present in a target operation. During integration, values are transferred from the source placeholder to the matching placeholder of the target operation. It is important that the placeholder: is unique, and appears exactly once in a target operation of an application. This ensures an unambiguous mapping between the SourceConfiguration and the target operation.
Separator Optional parameter. Defines the delimiter used to separate values when they are passed to the Integrator.
