Skip to main content

ScriptLink Settings screen

  1. Last updated
  2. Save as PDF

ScriptLink

ScriptLink is a web service interface that enables you to connect custom programming logic from your facility to the fields on myAvatar screens. This provides you with the ability to update a form based on facility data external to myAvatar , or even trigger facility tasks based on the form data.

These web services can be written in the scripting language of your choice

ScriptLink sends the myAvatar form data through a SOAP message to an external script, that you can use to interface with the desired facility operations. This script is then returned to myAvatar with the necessary data.

ScriptLink

  1. In the 'Available Scripts' fields, select the script for the event trigger:
  • Form Load - ScriptLink is triggered when the form is opened.
  • Pre-File - ScriptLink is triggered when data is entered or selected in a field, and the field loses focus.
  • Post-File - ScriptLink is triggered when the form is filed.
  1. In the 'Script Parameter' fields, enter scripting parameters.
    The parameter is passed to the script as the second parameter of the 'RunScript' method.
  2. If appropriate, in the 'Disable' fields:
  • Select Disable to inactivate an individual script.
  • Select Disable All Scripts for Form to inactivate all ScriptLink scripts for the form.
  • Select Disable All Scripts on Error to inactivate ScriptLink scripts when they trigger an error. The scripts will be disabled only when a "hard" error occurs (for example, the server hosting the script is down, or a SOAP error).
  1. In the Scripting Logging Level field, select how ScriptLink behavior is logged:
    Logging is performed per form.
  • None - no logging is performed.
  • Brief - displays information for each step in the process.
  • Verbose - displays all field information passed, and field information passed back.

On production environments, logging should be set to None during normal use. Logging should only be used for debugging purposes or on test environments, as it can decrease performance and cause the database size to increase rapidly.

Review ScriptLink Logs

In the Review ScriptLink Logs field, view script activity:

  1. In the From Date & Time field, enter the starting date and time.
  2. In the To Date & Time field, enter the ending date and time.
  3. Select the script.
  4. Click Launch Log.

Import WSDL for ScriptLink

In the Import WSDL for ScriptLink field, import a web service to define a script:

  • Enter the WSDL URL, click Import.
    Importing a WSDL for ScriptLink makes the script available for any form that can be opened through Form Designer, in any system code contained in the namespace.

ScriptLink Reports

In the ScriptLink Reports field:

  1. Click Print Scripts for this Form to view ScriptLink scripts for the form.
  2. Click Print Scripts for all Forms to view ScriptLink scripts for all forms.

ScriptLink reports will include the following information:

  • Namespace Name
  • Parent Namespace
  • Server Name
  • Session Token

 

When finished, click Return to Designer.

► Registry Settings