Designer

Designer is a GUI tool to design and develop services.
In Designer, you can show/hide and move functions according to your purpose and preference.

Launch Designer

Click [Designer] in DataSpider Studio to launch.

Designer Screen Configuration

Number in the image	Name	Description	Remarks
(1)	Menu	Various menus and tools to perform basic operations in Designer are placed here.
(2)	Project explorer	Create projects, scripts and folders, and execute scripts here.
(3)	Property inspector	Configure various component icons on the script canvas here.
(4)	Script canvas	Place various component icons on the script canvas, and create flows by dragging and dropping them.
(5)	Tool palette	Component icons that are needed for creating flows on the script canvas are listed here.
(6)	Execution history	When a script is executed in debug mode, the processing time for the entire script and each component, and the processing ratio (%) for each component will be displayed here.
(7)	Execution log	An execution log will be displayed here when a script is executed in debug mode.	The log details will change depending on the Log Level.
	Debug information	Values of script variables will be displayed here when a script is executed in debug mode.
	Error log details	Error details will be displayed here when a script is executed in debug mode.

Item name		Description	Remarks
New	Project	Create a new project.
	Folder	Create a new folder.
	Script	Create a new script.
	Script variable	Create a new “script variable”.
Open project		Open an existing project.
Save project		Save the project.	There are notes on saving projects. Refer to “Notes” for details.
Rename project		Change the project name.
Close project		Close the project.
Team development	Commit	Commit the local project to the server project. Changes that collide will be detected as conflicts.	Displayed only when the team development function is enabled. Refer to “Team Development” for more details.
	Update	Update the local project with the server project. Changes that collide will be detected as conflicts.
	Overwrite project with latest server version	Discard the local project and overwrite with the latest server version.
	Resolve project conflicts	Menu related to resolving project conflicts will be displayed. [Check project conflict information]: Open the project conflict information dialog. [Overwrite project with latest server version]: Discard the local project and overwrite with the latest server version. [Prioritize local project]: Prioritize the local project and resolve the project conflicts. You will be able to commit to the server after this. [Overwrite custom logic with latest server version]: Overwrite the local project's custom logic with the latest server version and update the project. [Prioritize local custom logic]: Prioritize the local custom logic and update the project.
Register project as service		Register the project you created to the server. You can execute the projects registered to the server from triggers, ScriptRunner, or external systems.	For details on the restrictions of service names, refer to “Character restrictions on service names”.
Generate project specifications		Generate project specifications in HTML format in the client OS local file system.	The definition information of the global resource will not be output. For details on setting items, refer to “Generate Project Specifications”.
Close editor		Close the “Script canvas” or “Mapper editor”. When multiple editors are opened, only the active editor will be closed.
Close all editors		Close all the opened editors.
Properties		Open the property dialog.
Exit		Exit Designer.

Edit

Perform various edit operations on the selected script or icon.

Description of items

Item name	Description	Remarks
Undo	Cancel the last editing action and revert the script back to the previous status.	For details on the specification limits of Undo/Redo function, refer to here.
Redo	Re-execute the operation that was canceled with “Undo”.
Cut	Cut the selected script or icons.
Copy	Copy the selected script or icons.
Paste	Paste the copied script or icons.
Delete	Delete the selected script or icons.
Select all	Select all the scripts or icons.
Search	Open “Search component” dialog to search for components in the project currently opened.	If you press the Enter key in "Search component" dialog, it will close without searching. Press [Search] button to search.

View

Configure various display settings in Designer, e.g. show/hide frames or contents on the script canvas.

Description of items

Item name		Description	Remarks
Show process flow		Show/Hide process flow (black line) on the script canvas.
Show PSP data flow		Show/Hide PSP data flow (yellow thick line) on the script canvas.
Hide grid		Hide grid on the script canvas.
Show 32x32 grid		Display a 32x32 grid on the script canvas.
Show 16x16 grid		Display a 16x16 grid on the script canvas.
Show 8x8 grid		Display a 8x8 grid on the script canvas.
Show tool palette		Show/Hide “Tool palette”.
Show project explorer		Show/Hide “Project explorer”.
Show property inspector		Show/Hide "Property inspector".
Show execution history		Show/Hide “Execution history”.
Show build errors		Show/Hide “Build errors”.	It is not displayed by default.
Show execution log		Show/Hide “Execution log”.
Show error log details		Show/Hide “Error log details”.	It is not displayed by default.
Show debug information		Show/Hide “Debug information”.
Show test data view		Show/Hide “Test Data View”.	It is not displayed by default.
Show test result view		Show/Hide “Test Result View”.	It is not displayed by default.
Sort icon		Sort the icons that are directly under the selected project/folder in project explorer. They will not be sorted recursively, but the ones that are directly under the selected icon will be sorted.
	Name	Sort the icons by name.
	Date created	Sort the icons by time created.
	Date modified	Sort the icons by time modified.
Initialize layout		Reset the views/editors to its default state.
Maximize current view/editor		Enlarge the selected frame to the maximum display size in Designer.
Switch editor		Switch between the editors deployed on the script canvas.
Switch view		Switch between the frames displayed in Designer.

Align

Align icons on the script canvas.

Description of items

Item name	Description	Remarks
Align left	Align the selected icons to left. If you align left, the x-axis of the selected icons will be aligned to the leftmost icon.
Align right	Align the selected icons to right. If you align right, the x-axis of the selected icons will be aligned to the rightmost icon.
Align top	Align the selected icons to top. If you align top, the y-axis of the selected icons will be aligned to the topmost icon.
Align bottom	Align the selected icons to bottom. If you align bottom, the y-axis of the selected icons will be aligned to the bottommost icon.
Align horizontally	Align the selected icons horizontally at equal intervals.
Align vertically	Align the selected icons vertically at equal intervals.

Run

Operations related to script execution and breakpoints.

Description of items

Item name	Description	Remarks
Start/Restart debug	Execute the script in debug mode. The script will operate as follows. The operation will pause at an icon on which a breakpoint is set. Restart the operation when the script is paused at a breakpoint. The processing time for each icon will be displayed in execution history.	There are notes on script execution. Refer to “Notes” for details. Do not close Designer when the script is paused at a breakpoint. Restart the operation and end the script before closing Designer.
Run	Execute the script. The script will operate as follows. Even if breakpoints are set on icons in the script, the processing will operate until the END icon without pausing. The processing time for each icon will not be displayed in execution history.	There are notes on script execution. Refer to “Notes” for details.
Stop	Stop the script under execution.	It might take some time to stop the script.
Build	Compile the script. When validation on build is enabled, the script will be validated.
Set/Release breakpoint	Set/Release breakpoints on the icons selected in the script canvas.
Release all breakpoints	Release all the breakpoints set on icons in the script canvas.

Tools

Open tools related to Designer.

In Mapper editor, a dedicated tool menu will be displayed.

An option dialog box will appear. The following options can be configured here.

Description of items: Run

Category	Item name	Description	Remarks
Execution type	Specify type	Select whether or not to specify “Type” for script execution in Designer. [Checked]: Specify type. [Not checked]: (default) Do not specify type.
	Specify type for execution	Select or enter a type for script execution in Designer.	Default value is “For test”. Enabled when [Specify type] is [Checked]. User specified types will not appear in the drop-down list. Enter one of them directly in the input field. Refer to User Specified Types for more details. If you click [OK] without inputting anything, [Specify type] will automatically be unchecked.
	Use default type when specified type is not found	Select whether or not to use the default type when the specified type global resource is not found. [Checked]: Use default type. [Not checked]: (default) “PoolNotDefinedException” error will occur.	Enabled when [Specify type] is [Checked].
	Display confirmation dialog when executing with types other than default	Select whether or not to display the confirmation dialog before executing with types other than default. [Checked]: (default) Confirmation dialog will appear. [Not checked]: Confirmation dialog will not appear.
Log	XML log	Select whether or not to output “XML log” when executing a script from Designer. [Checked]: (default) Output XML log. [Not checked]: Do not output XML log.
Log	Log level	Select log level to output when a script is executed from Designer. [NOTICE]: [INFO]: (default) [FINFO]: [FINEST]: [DEBUG]:
Build options	Validation on build	Select whether or not to perform validation when building the script. [Checked]: Validation will be performed. [Not checked]: (default) Validation will not be performed.	If the validation fails when building a script in Designer, a build error will occur. If the validation fails when registering a project as service, the script will be displayed in red in the “Compare service details” screen. The following component will be validated. Call Script

Description of items: Edit

Category	Item name	Description	Remarks
General	Number of history stored for recently used projects	Specify the number of history stored for recently used projects you want to display when opening the project.	Default value is 10.
General	Clear history	Clear history of recently used projects.
Edit script	Display mapping creation dialog when creating data flow	Select whether or not to display the mapping creation dialog when creating a data flow. [Checked]: (default) Mapping creation dialog will appear. [Not checked]: Mapping creation dialog will not appear.
Register service	Display commit confirmation dialog when registering service	Select whether or not to display the commit confirmation dialog when registering a service. [Checked]: (default) Commit confirmation dialog will appear. [Not checked]: Commit confirmation dialog will not appear.	Displayed only when the team development function is enabled. Refer to “Team Development” for more details.
Smart Compiler	Use Smart Compiler when creating data flow	Select whether or not to use Smart Compiler when creating data flow. [Checked]: (default) Use Smart Compiler. [Not checked]: Do not use Smart Compiler.	Refer to “Smart Compiler” for more details.
Project auto-saving	Enable project auto-saving	Select whether or not to save projects automatically. [Checked]: (default) Projects will be auto-saved. [Not checked]: Projects will not be auto-saved.	Refer to ”Project Auto-saving Function” for more details.
Project auto-saving	Time until the start of auto-saving	Specify the time (min) until the start of project auto-saving.	Enabled when [Enable project auto-saving] is [Checked]. Default value is 15. You can specify the value within the range of 10 to 25.

Help

Help page and version information of DataSpiderServer.

Description of items

Item name	Description	Remarks
Help	Open the help page of Designer.
Version information	Version information of the DataSpiderServer you are currently using.

Project explorer

You can register projects, configure script properties, or register script variables, etc.

Project menu
Script menu
Folder menu
Create script variables
Script properties

Project menu

Right click on a project to open the project menu.

Description of items

Item name		Description	Remarks
New		Create a new folder or script in the project.
Paste		Paste the copied folder or script.
Delete		Delete the selected project.
Sort icon		Sort icons that are directly under the selected project in the specified order.
Close project		Close the selected project.
Team development	Commit	Commit the local project to the server project. Changes that collide will be detected as conflicts.	Displayed only when the team development function is enabled. Refer to “Team Development” for more details.
	Update	Update the local project with the server project. Changes that collide will be detected as conflicts.
	Overwrite project with latest server version	Discard the local project and overwrite with the latest server version.
	Resolve project conflicts	Menu related to resolving project conflicts will be displayed. [Check project conflict information]: Open the project conflict information dialog. [Overwrite project with latest server version]: Discard the local project and overwrite with the latest server version. [Prioritize local project]: Prioritize the local project and resolve the project conflicts. You will be able to commit to the server after this. [Overwrite custom logic with latest server version]: Overwrite the local project's custom logic with the latest server version and update the project. [Prioritize local custom logic]: Prioritize the local custom logic and update the project.
Register project as service		Register the selected project as service to the server.	Refer to “Register service” for details.
Restore project from server		The project will be restored by referring to the version name, the user, and time of modification from backup files.
PSP data flow operation	Enable at once	Alter the changeable data flows that are in the scripts of the selected project to PSP data flows.	Refer to “Smart Compiler” for more details.
PSP data flow operation	Disable at once	Change the PSP data flows in the scripts of the selected project to PSP data flows.	Refer to “Smart Compiler” for more details.
Generate project specifications		Generate project specifications in HTML format in the client OS local file system.	The definition information of the global resource will not be output. For details on setting items, refer to “Generate Project Specifications”.

Script menu

Right click on a script to open the script menu.

Description of items

Item name		Description	Remarks
New		Create a new script variable to use in the selected script.
Open		Open the selected script in the script canvas.
Cut		Cut the selected script.
Copy		Copy the selected script.
Paste		Paste the cut/copied script.
Delete		Delete the selected script.
Lock script		Lock the selected script for the currently logged in user.
Unlock script		Unlock the script.	Unlocking can be done by the following users. User with administrator rights Lock owner (user who locked the script) User with write permission for project
Find script usages		Find scripts which call the selected script. The following are searched. The project which contains the selected script Other projects Services	Names of other projects are displayed in the following formats. Normal project: <user name>@<project name> Shared project: <project name> (shared) When the team development function is enabled, projects committed to the server are searched for other projects. Projects saved in your local system are not searched.
Team development	Overwrite script with latest server version	Discard the local edits and overwrite them with the latest server version.	Displayed only when the team development function is enabled. Refer to “Team Development” for more details.
	Restore from local history	Restore the script from local history.
	Resolve script conflicts	Menu related to resolving script conflicts are displayed. [Check script conflict information]: Open “Script properties” that displays the script conflict information. Overwrite script with latest server version: Discard the local script and overwrite with the latest server version. [Prioritize local edits]: Prioritize the local script and resolve the script conflicts. You will be able to commit to the server after this.
Output XML for executing script		Output a ScriptRunner launch settings file to the client OS local file system.	The ssl element will not be output. Set it manually. The password element must be set again. Open the outputted launch settings file and replace the value for the password element with a plain text password. Additionally, specify [false] for the encrypt attribute of the password element or delete the attribute. To encrypt a password, refer to “Password encryption of launch settings file”.
Restore script from server		The script will be restored by referring to the version name, the user, and time of modification from backup files.
PSP data flow operation	Enable at once	Alter the changeable data flows in the selected script to PSP data flows.	Refer to “Smart Compiler” for more details.
PSP data flow operation	Disable at once	Change the PSP data flows in the selected script to data flows.	Refer to “Smart Compiler” for more details.
Output version comparison report		Compare two versions of scripts and output the difference report.	For more details on setting items, refer to “Output Version Comparison Report”.
Generate script specifications		Generate script specifications in HTML format in the client OS local file system.	The definition information of the global resource will not be output. For details on setting items, refer to “Generate Project Specifications”.
Properties		Open “Script properties”.

When creating project/script specifications, if a script includes the following components, they will be output in the following order.

Loop
Conditional Loop
Loop by Number of Data
Conditional Branch
Monitor Exception
Thread
Transaction

Example: When the script contents are as follows,

      start → Start Conditional Branch → End Conditional Branch → Wait(1) → end
                   └      Condition → Wait      ┘

The order of the component list in the specification will be as follows.

      start → Start Conditional Branch → End Conditional Branch → Wait(1) → end → Condition → Wait

Folder menu

Right click on a folder to open the folder menu.

Description of items

Item name		Description	Remarks
New		Create a new folder or script in the folder.
Cut		Cut the selected folder.
Copy		Copy the selected folder.
Paste		Paste the cut/copied folder or script.
Delete		Delete the selected folder.
Sort icon		Sort icons in the selected folder in the specified order.
PSP data flow operation	Enable at once	Alter the changeable data flows that are in the scripts of the selected folder to PSP data flows.	Refer to “Smart Compiler” for more details.
PSP data flow operation	Disable at once	Change the PSP data flows in the scripts of the selected folder to PSP data flows.	Refer to “Smart Compiler” for more details.

Create script variables

Create a script variable from [File]-[New]-[Script variable].

Required settings

Description of items

Item name	Description	Remarks
Variable name	Enter variable name.
Variable type	Select variable type. [String]: (default) [Integer]: [Decimal]: [Date/Time]: [Boolean]: [Binary]: [XML]:	For details on each variable type, refer to “Script Variables”. Variables defined in XML type cannot be changed to other types. Also, variables defined in types other than XML type cannot be changed to XML type.
Initial value	Enter the initial value of variable.
Use as script input variable	[Checked]: Set the script variable as an input variable. [Not checked]: (default) Do not set the script variable as an input variable.	You can also set this from [Input/Output] tab in script properties.
Required	[Checked]: Set the script input variable as required. [Not checked]: (default) Do not set the script input variable as required.	Enabled when [Use as script input variable] is checked.
Use as script output variable	[Checked]: Set the script variable as an output variable. This will allow scripts outside the script to refer to the variable. [Not checked]: (default) Do not set the script variable as an output variable.	You can also set this from [Input/Output] tab in script properties.

Comment

Description of items

Item name	Description	Remarks
Comment	You can write a description of the script variable.

Script properties

The following items can be set in script properties.

Basic settings

You can check the following script information here.

Item name	Description	Remarks
Conflict information	Conflict information of local and server scripts are displayed.	Displayed only when the team development function is enabled and when a script conflict has occurred. Refer to “Team Development” for more details.
Last modified date/time of server project	Last saved date/time of the server project.
User who last modified server project	User who last committed to the server project.
Comment	Comments on the latest version of the server project.
Last modified date/time of local project	Last saved date/time of the local project.
Lock status	Displays the lock status of the script. The status will appear as “Locked.” when the script is locked, and as “Not locked.” when the script is not locked.
Lock owner	Displays the user name of the lock owner.	Displayed when [Lock status] is “Locked”.
Lock owner's host	Displays the host name / IP address of the client of the lock owner.	Displayed when [Lock status] is “Locked”.
Time when lock was acquired	Displays the time when the lock was acquired.	Displayed when [Lock status] is “Locked”.

Input/Output

Set input/output settings of the script variables in “Edit input/output interface” screen.
Input/Output interface can also be specified when creating script variables and from properties, but in this function they can all be set at once with a dedicated GUI.

Refer to “Input/Output” for more details.

Transaction

Select the script transaction. Default setting is “SUPPORTS”.

Refer to “Transaction” for more details.

Mass data processing

Select whether or not to perform mass data processing on each script.

Refer to Mass Data Processing for more details.

Test execution

The values you input in [Values during test execution] will be assigned to the variables when the script is executed in debug mode.
Enabled when [Set argument value during test execution] is checked.

Comment

You can write a comment here.

Generate Project Specifications

Basic information

Description of items

Item name	Description	Remarks
Output destination	Enter the directory path on the client OS local file system to output the specifications. You can click [Browse] button to launch the directory chooser and find the directory.	Refer to “OS Local File System” for more details. In Studio for Web, the specifications will be compressed and downloaded as a ZIP file.
Open in browser	Select whether to open the specifications in browser after output.	Default browser of the client OS will be opened.
Display PSP data flow	Select whether or not to display PSP data flow. [Checked]: Output PSP data flow in a yellow thick line. [Not checked]: (default) Output PSP data flow in a yellow dotted line.
Expand nodes with no mapping links	Select whether or not to expand child nodes of “Input data”, “Input document”, and “Output data” with no mapping links in the mapping canvas. [Checked]: (default) Expand nodes with no mapping links. [Not checked]: Do not expand nodes with no mapping links.	As for “Input document” of Variable Mapper, even if this item is [Checked], only the schemas that include nodes with mapping links will be expanded. As for the child nodes of “Component variables” and “Script variables”, only nodes with mapping links will be expanded regardless of whether this item is checked or not.
Output metrics	Select whether or not to output metrics in the specifications. [Checked]: Output metrics in the specifications. [Not checked]: (default) Do not output metrics in the specifications.	When generating project specifications, metrics of the project and each script will be output. When generating script specifications, metrics of the script will be output. The following four types of metrics will be output for a project and each script. Component icons Mapper total Each Mapper Custom logics The number of “Mapping links” output in “Mapping items” of “Mapper total” and “Each Mapper” shows the sum total of solid and dotted mapping links.

Author information

Description of items

Item name	Description	Remarks
Company name	Enter company name optionally.	The entered information will be output in the specification.
Project name	Enter project name optionally.	The entered information will be output in the specification.
Name	Enter name optionally.	The entered information will be output in the specification.
Date modified	Enter date of modification optionally.

Output Version Comparison Report

The dialog will open by clicking [Output version comparison report] of “Script menu”.

Basic information

Description of items

Item name	Description	Remarks
Version list	Script versions are listed. Select the two versions to be compared with Ctrl+click.	The list is in time order. The latest version will be the top of the list. When opening dialog, the latest version and the next one are selected.
Output directory	Enter the directory path on the client OS local file system to output the comparison result. You can click [Browse] button to launch the directory chooser and find the directory.	Refer to “OS Local File System” for more details. In Studio for Web, the reports will be compressed and downloaded as a ZIP file.
Open in browser	Select whether to open the specifications in browser after output.	Default browser of the client OS will be opened.

Click [Finish] button to output the comparison report where the difference between two versions selected in [Version list].
Contents of a version comparison report are as follows.

Contents of version comparison report

In version comparison report, information of edited parts in script are output. Information of parts which have not been edited are not output.

Modification details are displayed in tables. Values or images of two versions are basically placed side-by-side horizontally in tables.
The left is the older version and the other is the newer one. In the right side, modified items are colored.
At “Script variables” and “Components” in “Basic Information” section, the tables are colored in the same way.

An example of the report of a script where components are added / updated / deleted is as follows.

You can grasp the modification details at a glance finding these items colored in green, yellow, and gray.
The meaning of each color is as follows.

Description of items

Color	Modification type	Example
Green	Add	Add a new script variable Place a new component icon on the script canvas Place a new Mapper logic on a mapping canvas
Yellow	Update	Edit the initial value of a script variable Edit some property item value of a component icon Edit some property item value of a Mapper logic
Gray	Delete / Hidden / Disabled	Delete a script variable Delete a component icon A property item of a component icon is hidden or disabled Delete a Mapper logic

Difference information are output in two sections: “Basic Information” and “Details”.
The contents output in the two sections are as follows.

Contents of “Basic Information” section

In “Basic Information” section, script settings information and summary of script editions are output.
With that information, you can grasp the big picture of script modification.
You can also check the modified component icons to confirm these is no unintended modification.

The contents of “Basic Information” are the following.

Each item will be output only when the item is modified.

Description of items

Item name	Contents output	Remarks
Script settings	When you edited the script settings, the following information will be output. Transaction attribute Mass data processing Comment Script variable list	The following setting changes are not detected as modification. Change in “Test execution” tab of script properties Change in grid settings
Script variables	Add / Update / Delete of script variable are output. You can see the detailed information of each script variable in “Details” section.	Script variables are compared based on internal IDs. Therefore, changing names is detected as “Update”.
Script picture	Script picture is output.
Components	Add / Update / Delete of component icons are output. You can see the detailed information of each component icon in “Details” section.	Component icons are compared based on internal IDs. Therefore, changing names is detected as “Update”. Although the following modifications on component icons may be detected as “Update”, the details will not be output. Set/Release breakpoint [Move up evaluation order] or [Move down evaluation order] of Conditional Branch operation's [Condition]. [Move up evaluation order] or [Move down evaluation order] of Monitor Exception operation's [Catch]. Association with components, minimize/maximize, changing size, [Set font color], or [Set background color] of Memo

Contents of “Details” section

In “Details” section, the detailed information of version difference, such as modifications of positions, flows, setting values of component icons and Mapper logics, are output.
With that information, you can check the details of script modifications.
You can also check the modified property items to confirm these is no unintended modification.

The contents of “Details” are the following.

Each item will be output only when the item is modified.

Description of items

Item name	Contents output	Remarks
Script variables	When you edited script variables, the following information will be output. Name Type Input Required Output Initial value Comment
Components	When you edited component icon settings, the following information will be output. Process flows PSP data flows Position Basic settings <Component specific item 1> <Component specific item 2> : Comment	Component specific items vary depending on component icons. When the contents of a table type property item are modified, the whole table will be colored in yellow.

When Mappers (Variable Mapper / Document Mapper / Merge Mapper) are included in [Components] section, the detailed Mapper settings such as input schemas and logic icons will also be output.
The detailed Mapper settings are the following.

Each item will be output only when the item is modified.

Description of items

Item name	Contents output	Remarks
Mapper	The information of modified Mapper are output in two manner: basic information and layers. The following information are output as basic information. Process flows PSP data flows Position Basic settings Comment Input/Output schema changes The following information are output as each layer information. Picture Logic icons Output data The following information are output for logic icons Input/Output Position <Logic icon specific item 1> <Logic icon specific item 2> : Comment	[Input/Output schema changes] is output only for Document Mapper and Merge Mapper. [Input/Output schema changes] and [Output data] will not be output when a Mapper is added / deleted. Logic icon specific items vary depending on logic icons. Name of a global custom logic to be output varies depending on existence of the global custom logic in the tool palette when comparing versions. Exists: the logic name is output. Does not exist: the logic name is not output. Name of a local custom logic to be output varies depending on modification details and existence of the local custom logic in the tool palette. When added Exists in the newer version: the logic name of the newer version is output. Does not exist in the newer version: the logic name is not output. When updated Exists in both versions: the logic name of the newer version is output. Exists only in the older version: the logic name of the older version is output. Does not exist in either version: the logic name is not output. When deleted Exists in the older version: the logic name of the older version is output. Does not exist in the older version: the logic name is not output.

Item name

Contents output

Remarks

Mapper

The information of modified Mapper are output in two manner: basic information and layers.

The following information are output as basic information.

Process flows
PSP data flows
Position
Basic settings
Comment
Input/Output schema changes

The following information are output as each layer information.

Picture
Logic icons
Output data

The following information are output for logic icons

Input/Output
Position
<Logic icon specific item 1>
<Logic icon specific item 2>

Comment

[Input/Output schema changes] is output only for Document Mapper and Merge Mapper.
[Input/Output schema changes] and [Output data] will not be output when a Mapper is added / deleted.
Logic icon specific items vary depending on logic icons.
Name of a global custom logic to be output varies depending on existence of the global custom logic in the tool palette when comparing versions.
- Exists: the logic name is output.
- Does not exist: the logic name is not output.
Name of a local custom logic to be output varies depending on modification details and existence of the local custom logic in the tool palette.
- When added
  - Exists in the newer version: the logic name of the newer version is output.
  - Does not exist in the newer version: the logic name is not output.
- When updated
  - Exists in both versions: the logic name of the newer version is output.
  - Exists only in the older version: the logic name of the older version is output.
  - Does not exist in either version: the logic name is not output.
- When deleted
  - Exists in the older version: the logic name of the older version is output.
  - Does not exist in the older version: the logic name is not output.

Script canvas

Place various component icons on the script canvas, and create flows by dragging and dropping them.

For more details, refer to “Place component icons” or “Draw flows”.

Component menu

Right click on a component icon to open the component menu.

Description of items

Item name		Description	Remarks
Set/Release breakpoint		Set/Release breakpoint on the selected icon.
Cut		Cut the selected icon.
Copy		Copy the selected icon.
Delete		Delete the selected icon.
Align	Align left	Align the selected icons to left. If you align left, the x-axis of the selected icons will be aligned to the leftmost icon.
	Align right	Align the selected icons to right. If you align right, the x-axis of the selected icons will be aligned to the rightmost icon.
	Align top	Align the selected icons to top. If you align top, the y-axis of the selected icons will be aligned to the topmost icon.
	Align bottom	Align the selected icons to bottom. If you align bottom, the y-axis of the selected icons will be aligned to the bottommost icon.
	Align horizontally	Align the selected icons horizontally at equal intervals.
	Align vertically	Align the selected icons vertically at equal intervals.
Global schema	Register input schema	Register the input schema of the selected icon as global schema.	For more details, refer to “How to register from script canvas”.
Global schema	Register output schema	Register the output schema of the selected icon as global schema.	For more details, refer to “How to register from script canvas”.
Properties		Open the properties screen of the selected icon.
Help		Open the help page of the selected icon.

Execution history

When the script is executed in debug mode, the processing time for the entire script and each component, and the processing ratio (%) for each component will be displayed here.

Show execution history

The processing time for the entire script and each component will be displayed.

The ratio for the execution time of script will always be displayed as 100.0%.

The sum total of each icon's ratio for execution time in the script may not equal to 100. This is because the ratio of each execution time is rounded down to the second decimal point.

When execution is successful

When an error occurs in execution
If an error occurs while executing the script, an X mark will appear on the icon that failed processing.

Filter execution log

View an icon's execution log by clicking it in execution history.

When selecting a script

When selecting an icon

Omission of icons

Icons will be omitted if the number of icons in the execution history increases due to repeating operations, etc. The limit for the number of icons displayed is 100 child nodes per icon.

When selecting a script

Undo/Redo function

For DataSpider Studio for Web, refer here.

“Undo” to cancel the last operation, and “Redo” to re-execute the operation you canceled with “Undo”. Refer to “Menu” as well.
The operation history is maintained by script, not by editor.
If you save a script, the operation history is cleared.
If you Undo/Redo an operation in an editor, the focus is not set to the editor.
You can Undo/Redo the following operations:
- Script variable: create new/modify/move/delete
- Operations in the script canvas (icon: align/move/delete/change settings/set flow, etc.)
- Operations in Mapper editor (icon: align/move/delete/edit schema/change settings/set mapping, etc.)
- Edit operations in HTML builder (input text, edit schema, etc.)
- Settings in property inspector (script variables, components, Mapper logics, etc.): change
- Editor: open/close
You cannot Undo/Redo the following operations:
- Project: create new/delete
- Project name: change
- Script: create new/delete/move
- Script settings (script name, data processing method, etc.)
- Folder: create new/delete/move
- Test data: configure
- Custom logic: create new/delete
- Custom logic: edit
- Global resource settings (selecting a global resource in an adapter can be undone/redone)
- Grid display in script canvas (grid display in Mapper canvas can be undone/redone)
- Screen layout: change
When a Mapper editor is open, if you Undo after creating a script variable in the project explorer, the [Save] button in the tool bar will be disabled, and you will not be able to save.
In this case, you can enable the [Save] button by clicking on the script in the script canvas or project explorer.

Microsecond data

Microsecond data is not supported in some adapters.

Adapters that are compatible with microseconds are the following.

Access Adapter
DB2 Adapter
Oracle Adapter
PostgreSQL Adapter
SQL Server Adapter

Specification Limits

Designer

You cannot use the same name for multiple script variables or component icons.

When a project is opened in Designer, you cannot change its settings (e.g. renaming / sharing) in My Projects.
Close the project in Designer to be able to do so.

Permissions changes will not be reflected in projects opened in Designer. They will be reflected by reopening the project.

When the project name has been changed, [Service name] in [Register project as service] will be the service name itself if the service exists, or will be the project name of when it was created if the service does not exist.

If you press the Enter key in the properties dialog or “Add mapping” dialog, the settings will finish and the dialog will close regardless of which button or input field is selected.

When you have double-clicked to open the property dialog of a component that takes time to connect, and if you double-click it again, multiple properties dialogs might be opened.
In that case, configure the settings in the frontmost properties dialog and close it by clicking [Finish], and then close the remaining dialogs by clicking [Cancel].

If you set a component variable of a component not connected in a process flow to the property items of a component connected in a process flow, the script will fail to be compiled.

In “Script execution error” dialog, which appears when the script execution fails, the vertical size of the error details area can only be expanded to a certain length even if you change the size of the dialog itself.

During debug execution, process flows to the end icons of flow operations (e.g. Loop, Conditional Branch) will not be highlighted.

If the following problems occur, perform [Initialize layout] from [View] menu.
- Designer was closed when the script canvas was maximized, and you open Designer again, all of the frames are not displayed
- The layout of Designer collapsed after you maximized the execution log or error log details and returned them to their original size

Project explorer

When a script is loading, you cannot open [Properties] from right-click menu.

Execution history

When Call Script is operated multiple times inside Thread operation, the tree structure in execution history will not be displayed properly.

During Call Script operation, if the callee script is not opened in Designer, the processing information of the callee script will not be displayed in execution history.

Execution log

When a value is assigned to a binary script variable, the variable type displayed in the execution log will be “String”, not “binary”.

When binary data is assigned to a binary script variable, it will be displayed in “/0101/0110/1” format in the execution log and “B@12498b5” format in the debug information.

Output version comparison report

Although any changes in placed local custom logics will be reflected to the script, they will not be detected as parts of the script difference.

When an older version which has later modified date and time than the selected version exists in [Version list], version comparison report cannot be output.

When you set a component with an editable schema to a Mapper's input source and edit the input schema in Mapper editor, the modification will be detected as “Update” of the input source component as well as of the Mapper. In that case, property item values of the input source component will be output in the “Details” section regardless of whether any difference exists or not.

Generate project/script specifications

“Name” of following component icons will appear as blank in the “Component list” in specifications.
start, end, End Loop, End Conditional Loop, End Loop by Number of Data, End Conditional Branch, Try, End Monitor Exception, End Thread, End Transaction, break, continue, Memo, End Group

Property items for which only normal-width space is set will be handled as not set in specifications.

In specifications generation, Mappers are once opened internally. Because of that, update icons will be put in Mappers in the following cases.
- When custom logic where the number of some input handler has changed. The modification will be reflected to the generated specifications.
- When a Mapper using some custom logic reference of which the actual logic does not exist. “Loading custom logic error” dialog will appear during generation and the output specifications will be in the state that the custom logic is removed in Mapper.
For details on the specification limits of custom logic, refer to Custom Logic.

Previewer

It can read up to 1 MB.
When a file with a size of more than 1 MB is specified, it reads up to 1 MB from the beginning.

Chooser

The directory you choose in the file chooser will be set in the input field of the file name.

Frame floating

When you set a frame (e.g. Project explorer, Execution log in Designer) to floating state in [Floating], it will always be displayed in the front.

Even if you minimize Designer window, the frames in floating state will not be minimized.

Global resource settings

Global resource names cannot be changed in Designer.

Component pool settings cannot be configured.
For details on configuring global resource, refer to “Global Resource Settings”.

Script component

In a script that includes a Call Script operation checked by Monitor Exception operation, if the operation is stopped during Call Script operation, the processing cannot be interrupted.

Adapter

In table properties such as [Column list/Column name] of CSV adapter, if the required input items are not set, the “x” icon will be displayed only when the field is in input state.

When operations are placed newly on the script canvas, the “x” icon, which indicates an unselected state, might not be displayed in the list properties of required inputs such as [Table name] of database adapters.

If you select a component icon, in which a global resource that cannot be connected due to reasons like incorrect settings is set, it might take some time until you get a response.

Major Exceptions

Exception name	Cause	Solution
InterruptedException	Output when a running script is forced termination.	None.
ScriptComparisonException	Output when selecting versions which cannot be compared in [Output version comparison report].	None.

Notes

Designer

If you execute a script while it is being saved, it might fail saving.
Do not execute the script while saving.

Every time you register a project to the server as service, the Metaspace area managed by Java will be consumed.
The Metaspace area is proportional to the number of scripts and components in the project registered to the server.
For more details on Metaspace area settings, refer to “Property Reference”.

If you click [Finish] button in a properties dialog when you have typed something in a input field, the inputs might not be reflected. Press the Enter key to complete the input and then click [Finish] button.

When a string with newlines is pasted in a single-line input field, the newlines will be converted to spaces.

Project explorer

If you delete scripts, folders, or script variables, the focus will be off and the project cannot be saved at the time.
In that case, select the project in the project explorer again to adjust the focus.

Property inspector

When you enter a value in a property item, make sure you press the Enter key to complete the input.

In Raise Exception operation or Memo operation, when the settings dialog is opened from the property inspector, the inputs will not be reflected even if you click [OK] button. Select a view or canvas other than the property inspector to complete the input.

Script component

In flow operations (e.g. Loop, Conditional Branch), the process flow between the end icon of the flow operation and the icon right before will be connected internally.
Similarly, the process flow between the start icon and the end icon will be connected internally. Therefore, even if no component is placed between the start icon and the end icon, the script will not be a compile error.

In Loop, Conditional Loop, and Loop by Number of Data operation, the addition of component variable “count” will be performed at the end of each loop.