Call Script

Operation Name

Call Script

Function Overview

Call a script in a project or a script deployed in the server.

Properties

For details on use of variables, refer to “Variables”.
Basic settings
Item name Required/Optional Use of variables Description Remarks
Name Required Not available Enter the name to show on the script canvas.  
Required settings
Item name Required/Optional Use of variables Description Remarks
Script of same project - Required Not available Select when you call a script in the same project.  
Script Required Available Select or enter the script name to be called.
  • Enabled when [Script of same project] is selected.
Script of other project - Required Not available Select when you call a script in another project.
Shared project Optional Not available Select whether or not to display shared projects in [Project] list.
  • [Checked]:
    Display only the shared projects in [Project] list.
  • [Not checked]: (default)
    Display only the non-shared projects in [Project] list.
  • Enabled when [Script of other project] is selected.
Owner Required Not available Select an owner of projects to be displayed in [Project] list.
  • Displayed when the login user has administrator rights.
  • Enabled when [Script of other project] is selected.
  • Default value is login user.
Project Required Available Select or enter a project in which the script to be called is included.
  • Enabled when [Script of other project] is selected.
Script Required Available Select or enter a script name to be called.
  • Enabled when [Script of other project] is selected.
Script of deployed project in server - Required Not available Select when you call a script of deployed project in server.  
Service Required Available Select or enter a service in which the script to be called is included.
  • Enabled when [Script of deployed project in server] is selected.
Script Required Available Select or enter a script name to be called.
  • Enabled when [Script of deployed project in server] is selected.
Property actions
Item name Description Remarks
Open script Open the script to be called in Designer.
  • When [Script of same project] is selected, [Script] is opened from the same project.
  • When [Script of other project] is selected, [Script] is opened from another project.
  • When [Script of deployed project in server] is selected, [Script] is opened from the registered project of the [Service].
    • For more details on registered project, refer to “My Services”.
  • Disabled when variables are set in [Service] or [Script].
  • When script, service, or registered project does not exist due to deletion, renaming, and so on, the script cannot be opened.
  • This property action can also be executed from right-click menu of component icon.
Input/Output
Item name Required/Optional Use of variables Description Remarks
Edit list manually Optional Not available Select whether or not to configure [Input variable]/[Output variable] manually.
  • [Checked]:
    Configure the lists manually.
  • [Not checked]: (default)
    The lists are configured automatically.
 
Input variables Optional - Specify input variables of the script to be called. Also, enter the values to be passed to the input variables.

Each column can be operated with the following buttons.
  • [Add]:
    Add a variable.
  • [Delete]:
    Delete the variable.
  • When [Edit list manually] is checked, the buttons to operate each column are enabled.
Input variables/Variable name Required Not available Enter the variable name.
  • When [Edit list manually] is checked, variable name can be entered.
Input variables/Type Required Not available Select variable type.
  • [String]: (default)
  • [Integer]:
  • [Decimal]:
  • [Date/Time]:
  • [Boolean]:
  • [Binary]:
  • [XML]:
  • When [Edit list manually] is checked, variable type can be selected.
Input variables/Required Optional Not available Select whether or not to set [Input variables/Value] as required item.
  • [Checked]:
    Set [Input variables/Value] as required item.
  • [Not checked]: (default)
    Do not set [Input variable/Value] as required item.
  • When [Edit list manually] is checked, you can check / uncheck this.
Input variables/Value Optional Available Enter the value to be passed to the variable.
  • It is required when [Validation on build] in “Option settings” of Designer is enabled and [Input variables/Required] is checked.
Output variables Optional - Specify output variables to be received from the script to be called.

Each column can be operated with the following buttons.
  • [Add]:
    Add a variable.
  • [Delete]:
    Delete the variable.
  • When [Edit list manually] is checked, the buttons to operate each column are enabled.
Output variables/Variable name Required Not available Enter the variable name.
  • When [Edit list manually] is checked, variable name can be entered.
Output variables/Type Required Not available Select variable type.
  • [String]: (default)
  • [Integer]:
  • [Decimal]:
  • [Date/Time]:
  • [Boolean]:
  • [Binary]:
  • [XML]:
  • When [Edit list manually] is checked, variable type can be selected.
Property actions
Item name Description Remarks
Reload Reload the lists of [Input variables]/[Output variables] of the script to be called.
  • Enabled when no variable is set in [Service] and [Script].
  • The input and output variables set manually will be overwritten by the input and output variables of the script to be called.
Comment
Item name Required/Optional Use of variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.
 

Right-click Menu

Item name Description Remarks
Update input/output variables of script Reload the lists of [Input variables]/[Output variables] of the script to be called.
Open script Open the script to be called in Designer.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
exitStatus The return value of the script to be called is stored.
  • Default value is null.
message_category When an error occurs, the corresponding message code's category is stored.
  • Default value is null.
message_code When an error occurs, the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, the corresponding message code's severity is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type will be in the following format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, the error's trace information is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.
[<output variable name>] Value of a variable set in [Output variables] is stored.
  • Default value is null.
  • XML type output variables will not be output as component variable. It is output as result data.

Input/Output Variables

By setting script input/output variables to the script to be called, you can pass data between scripts.
Refer to “Input/Output Variables” for more details.

Specification Limits

Major Exceptions

Exception name Cause Solution
InvalidPropertyConfigurationException
<property name> is not specified.
[<property name>] is not specified. Specify [<property name>].
ProjectNotFoundException The service specified in [Service] is not deployed in the server. Check whether the service specified in [Service] is deployed in the server or not.
ScriptCallFailedException The called script failed. Check the contents of the called script.
ScriptNotFoundException Script specified in [Script] is not found. Check whether the script specified in [Script] exists or not.
ScriptCallViolationException The same project is specified in [Project] of [Script of other project]. Specify another project in [Project].
ScriptLoadFailedException In [Script of other project], the project specified in [Project] or the script specified in [Script] is not found. Check the following.
  • Whether the project specified in [Project] exists
  • Whether you have read permission for the project specified in [Project]
  • Whether the script specified in [Script] exists.
  • Whether there is a build error for the script specified in [Script].