Working with Integration Scripts

Integration Scripts

Integration scripts are the same as scripts used when creating Ebase Forms and can be coded in any of the supported server side languages. See Working with FPL Scripts, Javsacript script editor.

Any script statements that operate on web pages or controls are not supported in an Integration Script – as an Integration Service has no pages.

Working with Integration Scripts

Integration scripts are only associated with Integration Services. The Integration Scripts can be found on the Designer Tree: Integration Server -> Integration Services -> Scripts. An Integration Script can be created from the main menu: File -> New -> Integration -> Integration Script.

For FPL scripts, see Working with FPL Scripts for further details of using this dialog, and FPL Script syntax for further details on the scripting language.

For Javascript scripts, see Javsacript script editor for further details of using this dialog, and Javascript Developer’s Guide for further details on the scripting language.

Integration Service Tables and Forms

It is possible to call other scripts from Integration Scripts using the FPL callscript command. This can be used to call a script in any programming language.

FPL command fetchtable or API method Table.fetchTable() must be called from an Integration Script to read the contents of a table from an Integration Resource.

FPL command updatetable or API method Table.updateTable() must be called from in an Integration Script to write the contents of a table back to an Integration Resource.

Error handling

If an error occurs processing an Integration Service, a Soap Fault is generated automatically by the system and returned to the caller; this will be either a Soap 1.1 or Soap 1.2 Fault based on the protocol used by the client.

A Soap Fault can be explicitly generated by the application and returned to the caller by using the FPL abort script command; the Soap Fault text is populated with the abort reason. It is not currently possible to add additional information to a Soap fault.

An on error event can also be specified for an Integration Service that can be used to intercept all runtime errors. To populate a Soap Fault from an on error event, use the abort command.

Note that Soap fault document structures, schemas etc do not need to be added to an Integration Resource.

Web Service Specific System Variables

There are two Integration System Variables available to Integration Scripts:

− $WEB_SERVICE_OPERATION: This System Variable is set when an incoming request comes in for a specific Web Service call setting the operation name that has been invoked for that particular web service call.

When using an API language, the operation name is also available using form.webServiceOperationName.

− $INTEGRATION_CALL_SOURCE: This System Variable is set depending on how the Integration Service was called. There are four possible values :

o Web

o Designer

o Form

o Schedule (set from schedule task or ebasetrigger)