Skip to main content

About ScriptLink

There are many calculations and validations in myAvatar that can be accomplished using modeling and form or event logic. To go beyond these capabilities, you may need to use ScriptLink.

ScriptLink is an extensibility framework for myAvatar

myAvatar allows you to use event logic to control the behavior of a form based on certain conditions.

ScriptLink allows you to go beyond event logic and write custom logic outside of myAvatar that uses information from a form that the user is interacting with.

ScriptLink is a custom web service that is called by forms in myAvatar

ScriptLink is deployed as a custom web service that you develop and deploy on a ScriptLink server.

A ScriptLink server is a web server that hosts the custom ScriptLink web service code that you develop.

ScriptLink can implement complex logic that is not possible with event logic

In some cases, you may need to put in place logic that is not possible to implement using form or event logic.

Complex rules for event logic that cannot be implemented via event logic may be possible using ScriptLink instead.

ScriptLink can be used in place of event logic, and ScriptLink logic and event logic can both interact with the same fields.

It is recommended to use either ScriptLink or form logic on a form, but not both, as troubleshooting issues can become complicated.

ScriptLink can perform complex calculations using information from a form

When a form is configured to call a ScriptLink-compatible webservice, all of the information from the form is sent and available to the ScriptLink code.

Your ScriptLink code can use any of the values from the form to perform calculations, implement scoring rules, or validate selections.

Integrate with third-party APIs using ScriptLink

ScriptLink code is custom code that you develop. Because of this, you can use your ScriptLink code to send information to or retrieve information from external sources.

  • If you have a secondary system that needs to be updated with information from a form when that form is submitted, and if that secondary system has a public API (Application Programming Interface), you can use ScriptLink to send information via that API.
  • If your form needs to pull information from a secondary system, and if that secondary system has a public API, you can use ScriptLink to get that information via that API.
  • If you can write the necessary code to connect to a remote API, you can use it with your ScriptLink code and myAvatar.

 

  • Was this article helpful?