Script

Executes user-defined code. User can write custom workflow logic in Java, JavaScript, Python, R or Ruby programming languages.

Categories: helpers, developer-tools

Type: script/v1

---

Actions

JavaScript

Name: javascript

Executes custom JavaScript code.

Properties

Name	Label	Type	Description	Required
input	Input	OBJECT Properties {}	Initialize parameter values used in the custom code.	null
script	JavaScript Code	STRING	Add your JavaScript custom logic here.	true

Example JSON Structure

{
  "label" : "JavaScript",
  "name" : "javascript",
  "parameters" : {
    "input" : { },
    "script" : ""
  },
  "type" : "script/v1/javascript"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Python

Name: python

Executes custom Python code.

Properties

Name	Label	Type	Description	Required
input	Input	OBJECT Properties {}	Initialize parameter values used in the custom code.	null
script	Python Code	STRING	Add your Python custom logic here.	true

Example JSON Structure

{
  "label" : "Python",
  "name" : "python",
  "parameters" : {
    "input" : { },
    "script" : ""
  },
  "type" : "script/v1/python"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Ruby

Name: ruby

Executes custom Ruby code.

Properties

Name	Label	Type	Description	Required
input	Input	OBJECT Properties {}	Initialize parameter values used in the custom code.	null
script	Ruby Code	STRING	Add your Ruby custom logic here.	true

Example JSON Structure

{
  "label" : "Ruby",
  "name" : "ruby",
  "parameters" : {
    "input" : { },
    "script" : ""
  },
  "type" : "script/v1/ruby"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

---

Additional instructions

---

Calling a component inside a script

To call a component inside a script, you need to use the context.component object which gives you references to components and their actions.

For example, to call logger component and its info action in javascript you can use the following code:

function perform(input, context) {
    context.component.logger.info({'text': 'Hello World!!!'})

  return null;
}

If you want to call an action of a component which requires a connection you can define its connection inside the Script editor:

You can also define multiple connections of the same component and then reference a particular connection when calling the action: