About ScriptLink and myAvatar

Publish a compatible webservice

A ScriptLink-compatible webservice needs to meet these requirements:

• SOAP-based
• GetVersion method
• RunScript method

myAvatar uses XML-based SOAP communication to talk to a ScriptLink-compatible webservice. ScriptLink does not use REST APIs or JSON-formatted payloads.

• A ScriptLink-compatible webservice must implement a GetVersion method that has no parameters and returns a string.
• A ScriptLink-compatible webservice must implement a RunScript method that has two parameters:
  • OptionObject – an OptionObject object
  • ScriptParameter – a string
• The RunScript method must return an OptionObject object.

Make your ScriptLink webservice available in myAvatar

To use your ScriptLink webservice in myAvatar, you must import the WSDL for your webservice into myAvatar.

• You must import the WSDL address in each namespace (PM, CWS, and so on) where you want to use the webservice.
• You cannot have multiple ScriptLink webservices with the same name in use at the same time in a myAvatar instance.
• If you try to import a WSDL with the same name as a WSDL that has already been imported, it will replace the existing WSDL.

Configure fields and forms

After your ScriptLink webservice is in place and the WSDL is imported, you are ready to configure forms or fields to call your webservice.

On each form event (Form Load, Pre-File, Post File), select the ScriptLink webservice you want to use and supply a script parameter to tell the webservice how to process the information received from the form.

On each field on the form, you also can select a ScriptLink webservice and supply a script parameter.