This component is used for executing JavaScript. The JavaScript to be executed is specified using the Custom Property Sheet (CPS). This component executes the script on documents it receives as input and returns the result.
Points to Note
- Input message content and properties can be accessed using document object. For example, 'document.getText()' returns input message content. To access a message property named 'TestProperty, 'document.getRecord().getProperty('TestProperty')' returns the value of the property.
- Message properties can be set using 'setProperty' method.
- Message properties which are set on input message also appear on output message unless they are changed in the script. For example, if a property named 'TestProperty' is present on input message then output message also contains the property unless it is changed in script provided.
- Output message content can be set either by using 'setText(String value)' of document object.
Configuration and Testing
Interaction Configuration
Figure 1: Interaction Configurations panel in JavaScript CPS
Attributes
Read Script from file?
If enabled, Script file path property appears where you can provide the location where the script file is saved.
Script File Path
Provide the complete path of the Java Script file (file should have .js extension) which you want to execute.
Figure 2: Script file path property to provide the location where the script file is saved
JavaScript
If Read Script from file ? property is disabled, populate the JavaScript property with the Java Script.
Scheduler Configuration
Please refer the respective section in Common Configurations page.
Transport Configurations
Please refer the respective section in Common Configurations page.
Error Handling
Please refer the sections Request Processing Error and Invalid Request Error in the Error Handling section of Common Configurations page for details.
Sample Input and Output
The configuration can be tested by clicking the Test button in the interaction Configuration panel.
Below is a sample Java script.
Below are the sample input and the output respectively for the above script.
Figure 3: Sample Input Message
Figure 4: Response Generated
Functional Demonstration
Scenario
Execution of Java Script provided.
Configure the Java Script as described in Configuration and Testing section and use feeder and display component to send sample input and to check the response respectively. In the example given below, the script provided is:
Figure 5: Scenario demonstration with sample input and output
Useful Tips
The component uses the document object to get the content and properties of the message. The result after executing of the script should be set back onto the document object.