Integration Wizard
Last updated
Was this helpful?
XMPro WorkFlow
Last updated
Was this helpful?
The XMPro Integration Wizard provides a user-friendly way to integrate WorkFlow Connector Plugins with XMPro Activities. It allows users to create activities based on structures specified by a connector and to map the existing Activity objects to the connectors.
Right-click the relevant Activity or Trigger or Control.
Click XMPro Integration.
The XMPro Integration Wizard, Connector Tab will be displayed as shown in the following figure. The Connector page lists all the plugins, registered in XMConnect Administration, to which the user has access rights.
Select a plugin from the Configure Connector drop-down menu.
Once the plugin is selected, its initialization parameters appear, as defined in the Plugin.
Provide the expected parameters.
Click Next. The Wizard will attempt to, in the background, retrieve a list of Objects supplied by the Plugin.
Select an Object from the list. A Preview function is available, if supported by the Plugin. The Preview window shows the first 200 records of the selected object.
Click Next.
The Operations tab allows the user to select the operation to be performed on the selected Object. The Insert, Delete, and Update functions are the same regardless of the level the Integration is called. However, the Read operation’s outcome depends on following:
Look Up – If Integration is performed on a Lookup control and the control is mapped to at least one Column then the Lookup is filled with the retrieved Dataset.
Browse Page – If Integration is performed on a Browse Page control, the outcome of the operation is used to populate the Browse Page.
In all other cases, the Read Operation just fills the mappings, which will be demonstrated later in this document.
Select the operation to be performed.
Click Next.
The Output Properties tab lists all the Properties of the selected Object. Only input properties appear for Non-Returning Operations.
Select the properties to include in mappings or click Select All check box.
Click Next.
The Output Mappings tab allows the selected properties to be mapped to Activity Controls, Objects, or <New> which means the Control or Object will be created for the property.
Users can add new mappings here or delete any of the existing ones. However, duplicate columns are not allowed in input mappings while duplicate controls are not allowed in output mappings. The user can add new mappings even if the Control is Identity of delete a Not Null mapping, but such scenarios must be avoided by reconsidering the business logic.
Select the Mapped Control from the drop-down list for the object or leave as <<New>> to generate a new control.
Click Next.
If the operation is to be performed on multiple Records, then an Object Group can be selected from the List. If a Control is specified in the mappings, which belongs to an Object Group then the selected operation is performed for every line in the Object Group. Non-Returning operations run for all the rows while Returning operation fills the Object Group with all the records retrieved from Database.
Controls mappings can be mixed between Object Group controls and Non-Object Group controls, operations still run for all the line items, but the Non-Object Group controls become constants for each line item.
The Object Group column can be checked. The <<New>> Control will be created in the selected Object Group.
Select the Mapped Control from the drop-down list for the object or leave as <<New>> to generate a new control.
Select the relevant Object Group from the drop-down list.
If required, select the Object Group check box to add all new controls into the selected group or individually select each control by selecting the Object Group check box.
Click Next.
Conditional Mappings allow user to define the Where clause for the Operation, if the selected operation is Conditional. The User can define conditions on both the Columns and Control Values. Names starting with @ represent activity controls.
Select the icon to add a new condition for the selected operation.
Click the left-hand side of the condition to select the appropriate object or activity control, for example, [ID].
Click the conditional to select the respective condition for example, [@Current User].
Click the right-hand side of the condition to enter a static value alternatively or click the pencil to turn it into a drop-down to select the appropriate object or activity control, for example, [@Current User]. Repeat Steps 1-4 to add additional conditions.
Click Next.
Execution Conditions have been added to improve integration.
Integration to non-XMPro databases to create, read, update, or delete information can be performed during the on-load of an activity (or a screen) or when a screen is refreshed. This function is provided in the XMPro Integration Wizard.
