Disclaimer: Client users should not modify any integration event definition configuration except at the direction of Equus. Doing so may break connections and result in data corruption.

Integration Events define the rules that govern what data is sent to a vendor that does not use Equus Platform. For example, a specific Vendor requires specific data about a service, and that data is not part of an Equus standard Push Script. An Integration Event can be created for that vendor to use a custom Integration Push Script that contains the data the vendor needs.

Customize Integration Event Definitions

The Integration Event Definition screen is used to manage this. To navigate to the screen, go to the Configuration>Integration>Event Definition menu item. This displays the Integration Event Definition screen. The screen should be used in conjunction with the Integration Push Scripts Screen.

You can use the page to Create, Edit and Delete an Event Definition.

Create

To create a customize event definition, click

on the grid.

Select one of the following and click

Defining A New Integration Event - to create a new one from scratch
Copying an Existing Integration Event - to copy an existing one and make modifications to it.

Specify the following:

Integration Event Definition Details

Name: Enter the name that describes the Integration Event Definition.
Integration Push Event: Select the event that initiates the Integration Event.
Choose from:
- <Order Service Order>: The Integration Event will be initiated when a Note/Communication is sent for a Service Order.
- <Update Value(s)>: The Integration Event will be initiated when one or more field(s) is updated. Only data that is updated (or inserted, in the case of a child record added to an existing parent record), along with its appropriate unique identifiers, will be sent to the vendor. Define these fields in the Trigger Fields section. Otherwise, when the Trigger Fields defined for the Integration Event change, then the selected Push Script will be sent to the vendor; if there is a need for the the Trigger Fields to be sent, then they should be present in the Push Script.
Service Type: Optionally select the Service Type that initiates the Integration Event. If nothing is selected, the Integration Event will be used for all Service Types.
Only custom Service Types not mapped to Equus standard Service Types display in this list. Custom Service Types can be mapped to Equus standard ones so that they can utilize the same Integration Event and Permission Set that is associated with the Equus standard Service Types. For details about how to do this, please see the Service Management User Manual.
Company: Optionally select the Company that initiates the Integration Event. If nothing is selected, the Integration Event will be used for all companies. The list of companies displayed are those to which the user is authorized. If the user’s account is not restricted to one or more company(ies), all companies will display in the list.
Vendor: Optionally select the Vendor that initiates the Integration Event. If nothing is selected, the Integration Event will be used for all Vendors.
Integration Push Script: Select the script that contains the data that will be sent to the vendor. Push Scripts that display here are identified as Active on the Integration Push Scripts screen. If the Push Script is associated with a Company, it will only display if it is the same as the Company identified for the Integration Event. In all other cases, it does not display.
Restrict Updates to Associated Service Orders: This check box is only available when the Integration Push Event is <Update Value(s)>. It governs whether only the vendor with the Service Order associated with the updated data receives the updated data, or all vendors that have Service Orders associated with the assignment receive the updated data. Selecting a Vendor for the Event Definition restricts the updated data to be sent to only that vendor. In order for the data to be sent to a vendor, it must have an Ordered Service Order associated with the assignment.

This check box is only evaluated when the record updated can be associated with a Service Order (i.e., service-level data, for example Move Management or Temporary Living). It can be used to send service-related data to vendors that depend on that data, but don’t provide that service.

For example, a Tax vendor may be interested in knowing about changes to an assignee’s Visa & Work Permits information. Another example could be a vendor needs to know about Training the assignee has received, but doesn't provide the Training services.

- Value is <True> and no Vendor is identified: Data will only be sent to the Vendor that has the Service Order that is associated with the updated data.
- Value is <True> and a Vendor is identified: Data will only be sent to the Vendor that has the Service Order that is associated with the updated data; the Service Order’s vendor must also be the vendor identified in the Event Definition.
- Value is <False> and no Vendor is identified: Data will be sent to all vendors that have Service Orders for the assignment, regardless if their Service Orders are associated with the updated field(s).Value is <False> and a Vendor is identified: Data will be sent only to the Vendor identified in the Event Definition, even if that Vendor does not have a Service Order associated with the updated field(s).

However, that Vendor must have a Service Order associated with the assignment; otherwise, the data will not be sent. In all of these cases, if a Company is identified for the Integration Event, the data updated must be for an assignment within that Company. If a Service Type is identified for the Integration Event, updates will only be sent to Vendors associated with Service Orders that reference that Service Type.

Restrict Updates To Associated Client: This check box is only available when the Integration Push Event is <Update Value(s)>.
- Value is <True> - Ensures updates to the service order are only sent to the client for those Orders.
- Value is <False> - Updates to the service order are sent to clients & Vendors.
Inactive: By default, this is checked, indicating that the Integration Event will not be used. Checking this check box puts the Integration Event into effect immediately.

Required Fields section

When Order Service Order is selected as the Integration Push Event, and an Integration Push Script is selected, the Required Fields section will be present. Fields that the Vendor must receive in order to begin services can be specified here. Service Orders will not be sent to a Vendor if at least one field designated as required in this section is blank.

The ‘Block Email Send if Required Field Values Missing’ checkbox will also be available if the Integration Push Event is 'Order Service Order'. Checking this will prevent emails from sending and service orders from being submitted when all the required field information is not provided.

For Equus-standard event definitions for Order Service Order, users can still configure this setting if they have the necessary rights.

Click
creates that number of rows. Enter the number of field(s) to be added in the text box
Delete: Check to delete the field row when saved.
Table: Identify the table that contains the required field. The list of tables is limited to those that are present in the selected Integration Push Script.
Field: Identify the field that which contains the required field. The list of fields is limited to those that are present in the selected Integration Push Script.

Trigger Fields section

When Update Value(s) is selected as the Integration Push Event, fields that initiate the event must be specified. Do this by adding one or more fields in this section.

Click
creates that number of rows. Enter the number of field(s) to be added in the text box
Delete: Check to delete the field row when saved.
Table: Identify the table that contains the required field. The list of tables is limited to those that are present in the selected Integration Push Script.
Field: Identify the field that which contains the required field. The list of fields is limited to those that are present in the selected Integration Push Script.
Send Lookup Value: Select the value(s) to be sent for the lookup field:
- Display Name Only: Sends the display value for the selected field. For fields that are maintained in the Lookup Maintenance screen, this sends the Display Value. For resources, this sends the Resource Name.
- ID Only: Sends the unique identifier for the selected field. For fields that are maintained in the Lookup Maintenance screen, this sends the Code. For resources, this sends the ID.
- ID and Display Name: Sends both values as described above.
The Hide Trigger Conditions checkbox determines if the Event Definition has the 'Trigger Only' if These Conditions are True. When this value is not checked, the old required fields method of update values will work the user can use either required fields or triggers based on this setting. Note, that this field setting only appears on the create functionality.
- If a user copies a record - the previous record used (triggers or required fields) will be copied over and will not be editable once selected.

Click

. A System Code is automatically assigned to user-created Integration Events. This cannot be edited. Note: You can create more than 1 active Update Value(s) Event Definitions for the same Vendor/Service Type/Company/Push Script. This allow for multiple event definitions to send the same push script.