Disclaimer: Client users should not modify any push script configuration except at the direction of Equus. Doing so may break connections and result in data corruption.
Integration Push Scripts identify the data that is sent to a Vendor that does not use AssignmentPro. For instance, a specific Vendor requires specific data about a service and that data is not part of an Equus standard Push Script. An Integration Push Script can be created for that vendor to be used in an Integration Event.
Customize Integration Push Scripts
Integration Data Mapping screen is used to manage them. To navigate to this screen, go to:
Configuration>Integration>Push Scripts
This displays the Integration Push Scripts screen. The Integration Push Scripts listed below ship with AssignmentPro, and are referenced by the Equus standard Integration Events.
There are two modes for building Integration Push Scripts:
Basic: Users select tables and fields from existing lists or user reports and AssignmentPro builds the script based on the selected tables and fields. All new Integration Push Scripts start in Basic mode.
Advanced: Users develop the Epic script themselves. This mode requires knowledge of the Epic scripting language. Any work done in Basic mode will be transformed into the Epic scripting language when entering Advanced mode. Click
to work in the Advanced mode. Note - Entering the Advanced mode cannot be undone.
Create
To create a customize event definition, click
on the grid.
Select one of the following and click
:
Defining A New Push Script - to create a new one from scratch
Copying an Existing Push Script - to copy an existing one and make modifications to it.
Specify the following:
Inactive: When not checked, identifies that the Push Script does not display on the Integration Event Definition screen as a one that can be selected.
Name: Enter a name that describes the Push Script.
Company: Optionally select the company with which the Integration Push Script is associated. Users must be authorized to that company in order to update the push script. If no company is selected, the Push Script is considered to be system-level, and all users who can see the screen can edit the Push Script.
Base64 Encode Documents: This will encode all Documents in the Push Scripts to Base64. If this field is not checked then the default encoding of Hexadecimal will be used.
Compress Documents: Checking the "Compress Documents" checkbox will cause AssignmentPro to compress all the documents being sent to the vendor in the data map, using the DEFLATE algorithm. Note - DEFLATE is not a common compression algorithm and vendor systems should be specifically configured to accept documents compressed in that way.
Click
. A System Code is automatically assigned to user-created Integration Push Scripts. This cannot be edited.
All new Integration Push Scripts start in Basic mode. Click
to work in Advanced mode.
Basic Mode
In Basic mode, users select tables and fields from predefined lists. The tables to select are those that contain the fields that must be sent to the vendor.
Add Tables
1. Click
on the Integration Push Script Tables grid to add a new table.
2. Select a table and click
. The list of tables displayed is limited to those that are part of the vendor integration feature.
Hint: To select fields from Note/Communications, choose <Note Comm Service Order>. To select fields from Documents, choose <Document Note Communication>
The table is added, as well as any parent table(s) associated with that table.
The following fields are automatically populated and cannot be edited:
• Sequence: Identifies the order in which the table is processed by the Epic engine.
• Parent Table Name: The table’s parent, if one exists.
Rules for deleting tables are:
• Parent tables cannot be deleted until all their child tables are deleted.
• The Service Order table can only be deleted if it is the last table in the list.
Deleting a table will also delete all of its child tables and fields in the All Integration Push Script Table Fields grid.
Adding Fields
Click
to create that number of rows. Enter the number of field(s) to be added in the text box.
Select the AssignmentPro Field Name; this is the field that contains the data to be sent.
Select an option from the Send Lookup Value choice list as needed. This is only enabled for fields that display a choice list. The values are:
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.
Client Code Only: Sends the client code for the selected field. For fields that are maintained in the Lookup Maintenance screen, this sends the Client Code Value.
Click
for changes to be reflected.
Note: Be sure to click
before selecting a different table, otherwise the fields you have selected will be lost.
Add User Report
1. Click
on the Integration Push Script Tables grid to add a new user report.
2. Type the name of your user report and click
. The list of tables displayed is limited to those that are part of the vendor integration feature.
The User Report is added, as well as any field(s) associated with that report. Fields that are marked as hidden in the User Report will not appear on the Push Script.
Once User Report is added, you can:
Remove User Report
To Remove a User Report from the Push Script:
1. Click the
within the User Report being removed.
2. Click
on the confirmation message.
Add User Report Fields
1. Navigate to the User Report to add fields
2. Click
for the fields to appear in the Push Script. Resynchronizing the User Report will also save the Push Script.
Things to Note
If the User Report is not locked, then the User Report on the Push Script will show a warning. Unlocked User Reports in Push Scripts can lead to errors. If there is a deleted or hidden field on the User Report and the user has not resynchronized the Push Script, then the deleted field on the Integration Data Mapping Details page will appear as invalid and the hidden field will show a warning. The Push Script will also be inactive until the deleted and hidden field warnings are resolved.
Attempting to execute the Push Script while there are any warnings about fields that the Push Script expects, but are missing or hidden from the User Report will result in an error.
If the Destination Table Name or Destination Field Name is duplicated or empty, then a warning will appear, and the Push Script will be forcibly set to inactive
If the User Report does not prompt for a Service Order Id and the user tries to execute the Push Script, the Push Script will error
Note, once the tables, fields and user report identified in Basic mode can be transformed into the Epic scripting language by clicking the
. This cannot be undone.
Advanced Mode
Using Advanced mode, users develop the Epic script themselves. This mode requires knowledge of the Epic scripting language. Note - Entering the Advanced mode cannot be undone. Check with your Equus Representative first if you need to use Advanced Mode for Push Scripts
