Designer

Designer

Designer is GUI tool to design service and to develop service.
Screen Configuration of Designer can show/hide only the function matching the purpose of developer, therefore, you can operate on screen configuration which is easy to use due to the unique screen.

To launch Designer

You can click the [Designer] on the DataSpiderStudio.

Designer Screen Configuration



Number in the screen capture above Name Description Remarks
(1) Menu Various menus is are being set to perform the basic operations of the designer.  
(2) Project explorer You can create projects, scripts, and folders, and execute scripts.  
(3) Property inspector You can configure various component icons which are created on the script canvas.  
(4) Script canvas Drag and drop various component icon on the script canvas, you can create a flow by drag and drop icons.  
(5) Tool palette Necessary component icons for creating flow on script canvas will be registered.  
(6) Execution history When you run the script in debug mode, processing time of icon and processing time of entire script and percentage of process will be displayed in percentage.  
(7) Execution log When you run the script in debug mode, execution log display.
  • The log information depends on the log level.
Debug information When you run the script in debug mode, values of script variables inside script will display.  
Error log details When you run the script in debug mode,error details will display.  

Menu

In Designer menu, there are 7 types of menu: "File", "Edit", "View", "Align", "Run", "Tool" and "Help".
When you select each menu, items will be shown by pull-down menu.

File menu

For projects under creating, you can execute various processes.
Description of items
Item name Description Remarks
New Project Creates a new project.  
Folder Creates a new folder.  
Script Creates a new script.  
Script variable Creates a new "Script variable".  
Open project Opens an existing project.  
Save project Saves the project. There are notes on saving projects.
Refer to "Notes" for details.
Rename project Renames the name of the project  
Close project Closes the project.  
Team development Commit Commit the the local project to the server project.
If the changes crash, it will be detected as a conflict.
  • Enable when team development is enabled.
    Refer to "Team Development" for details.
Update Update the local project with the the server project.
If the changes crash, will be detected as a conflict.
Replace project with latest version Destroy the local project and overwrite with the latest server contents.
Resolve conflicts of projects Display the menu related to the project conflict solving.
  • [Confirm conflict information of the projects]:
    Display the project conflict information dialog.
  • [Replace project with latest version]:
    Destroy the local project and overwrite the project with the latest server contents.
  • [Continue local editing]:
    Override the local contents and solve the project conflict. Committing to the server is only possible afterwards.
  • [Overwrite custom logics with the latest version in server]:
  • Overwrites custom logics of local project with the latest version in server and updates the project.
  • [Prefer local custom logic]:
  • Prefers local custom logic, and updates the project.
Register project as service Register created project to server.
For projects registered to server, you can execute them from external system such as triggers or ScriptRunner.
Generate project specifications Generates project specifications in HTML form in client OS local file system.
Close editor Closes the selected editor.When two or more editors are selected, only the active editor will be closed.  
Close all editors Closes all editors opened.  
Properties Shows the property dialog.  
Exit Exits Designer.  

Edit menu

For icons and scripts being selected, each editing operation can be performed.
Description of items
Item name Description Remarks
Undo Cancel the last editing action, then back to the last script status.
  • About Undo/Redo function specification limits, refer to here.
Redo Execute again the edition operation which was canceled by "Undo".
Cut Cuts selected scripts and icons.  
Copy Copies selected scripts and icons.  
Paste Pastes copied scripts and icons.  
Delete Deletes selected scripts and icons  
Select all Select all the icons or scripts.  
Search Find the component from the project that are currently opened.
  • In the [Search component] screen, press enter to close the screen without searching.
    To execute the search process, press [Search].

View menu

you can display the various settings in the designer such as show/hide frame, or the showing content on script canvas.
Description of items
Item name Description Remarks
Show process flow Select to show/hide process flow on scripts canvas (black line).  
Show PSP data flow Select to show/hide PSP data flow on scripts canvas (yellow thick line).  
Hide grid Hide the grid on script canvas to hide the script.  
Show 32x32 grid Displays 32x32 grid on script canvas.  
Show 16x16 grid Displays 16x16 grid on script canvas.  
Show 8x8 grid Displays 8x8 grid on script canvas.  
Show tool palette Select to show/hide "Tool palette".  
Show project explorer Select to show/hide "Project explorer".  
Show property inspector Select to show/hide "Property inspector".  
Show execution history Select to show/hide "Execution history".  
Show execution log Select to show/hide "Execution log".  
Show error log details Select to show/hide "Error log details".
  • It does not appear by default .
Show debug information Select to show/hide "Debug information".  
Show test data view Select to show/hide "Test data view".
  • It does not appear by default .
Show test result view Select to show/hide "Test result view".
  • It does not appear by default .
Sort icon   Sort the icon directory under the project/folder selected in project explorer.
Sorting icon is not performed recursively, it is only for the icons right under the selected icon.
 
Name Sort icon by name.  
Date created Sort icon by date created.  
Date modified Sort icon by date modified.  
Initialize layout Return to the default state of the view/editor of all .  
Maximize current view Maximize the the selected frame on designer.  
Switch editor Switch editors being deployed on script canvas.  
Switch view Switch between each frame displayed in the designer.  

Alignment

You can place icons on script canvas.
Description of items
Item name Description Remarks
Align left The script is left-aligned.
When left aligning, coordinate X of all the icons selected in script canvas will be located same as the icon in the leftmost among selected icons.
 
Align right The script is right-aligned.
When right aligning, coordinate X of all the icons selected in script canvas will be located same as the icon in the rightmost among selected icons.
 
Align top The script is top-aligned.
When top aligning, coordinate X of all the icons selected in script canvas will be located same as the icon in the topmost among selected icons.
 
Align bottom The script is bottom-aligned.
When bottom aligning, coordinate X of all the icons selected in script canvas will be located same as the icon in the bottommost among selected icons.
 
Align horizontally Place the selected icon to the middle of the left and right.  
Align vertically Place the selected icon to the middle of the top and bottom.  

Execution test

You can set/release breakpoint or operation related to running script.
Description of items
Item name Description Remarks
Start/restart debug Execute the script in debug mode.When running debug, the script works as follows.
  • Suspends operation at the set breakpoints on the script icon.
  • If the script is stopped at breakpoint, restart the operation of the script.
  • In execution history, processing time is displayed for each icon.
  • There are notes on running scripts.
    Refer to "Notes" for details.
  • Do not close the Designer while the script is stopped at the breakpoint. Make sure to restart and end the script before closing the Designer.
Run Run the script.If running, the script works as follows.
  • Even set a breakpoint in the script icon, run the process of script until the END icon without stop.
  • In execution history, processing time is not displayed for each icon.
  • There are notes on running scripts.
    Refer to "Notes" for details.
Stop Stop the running script.
  • It could take minutes to stop some scripts.
Build Compile a script.  
Set/release breakpoint Set/release breakpoint for icons selected on script canvas.  
Release all breakpoints Release breakpoint for all icons on script canvas.  

Tool menu

Start each type of tool related to designer.
The dedicated tool menu is displayed in the Mapper Editor.

The dialog to set options for the designer.In the Options dialog you can set the following options.
Description of items: Execute
Category Item name Description Remarks
Execution type Specify type Select whether to specify "Type" when you run scripts on Designer.
  • [Checked]:
    Specify type.
  • [Not Checked]:(default)
    Do not specify type.
 
Specify type when executing Select or enter the type when you run scripts on Designer.
  • The default value is "For test".
  • Enable when [Specify type] is [Checked].
  • User-specified type does not appear in pull-down menuPlease enter directly into the input field.
    Refer to "User specified types" for details.
  • When the [OK] button clicked without type, the [Specify type when executing] is set to be unckecked.
Use default type when a specified type is not found Select whether to use default type when the specified type is not found.
  • [Checked]:
    Use default type.
  • [Not Checked]:(default)
    "PoolNotDefinedException" error occurs.
  • Enable when [Specify type] is [Checked].
Display confirmation dialog when you execute by types other than default Select whether to display confirmation dialog when you execute by types other than default
  • [Checked]:(default)
    Display confirm dialog.
  • [Not Checked]:
    Do not display confirm dialog.
 
Log XML Log Select whether to output log information to the "XML log".
  • [Checked]:(default)
    Output XML log.
  • [Not Checked]:
    Do not output XML log.
 
Log level Select a log level when you run scripts.
  • [NOTICE]:
  • [INFO]:(default)
  • [FINFO]:
  • [FINEST]:
  • [DEBUG]:
 
Description of items: Edit
Category Item name Description Remarks
General Number of histrory of recently used project Enter the number of history of recently used projects shown in the Recently used Projects list.
  • The default value is "10".
Clear history Clears history of recently used projects.  
Edit script Display mapping making dialog when you draw data flow Select whether to show mapping creation dialog when you create a data flow.
  • [Checked]:(default)
    Show mapping creation dialog.
  • [Not Checked]:
    Do not show mapping creation dialog.
 
Register project as service Show the commit project dialog when you register a project as a service. Select whether to show the commit project dialog when you register a project as a service.
  • [Checked]:(default)
    Show the commit project dialog.
  • [Not Checked]:
    Do not show the commit project dialog.
  • Enable when team development is enabled.
    Refer to "Team Development" for details.
Smart Compiler Use Smart Compiler upon data flow creation Select whether to use Smart Compiler upon data flow creation.
  • [Checked]:(default)
    Uses Smart Compiler.
  • [Not Checked]:
    Does not use Smart Compiler.
Automatically save project Enable automatically save project Select whether to save projects automatically.
  • [Checked]:(default)
    Save projects automatically.
  • [Not Checked]:
    Do not save projects automatically.
Time to start automatically save Specifies the time period in minutes to start saving the project automatically.
  • Enable when [Enable automatically save project] is [Checked].
  • The default value is "15".
  • Range of values is from "10" to "25".

Help menu

Shows help and the version of the DataSpiderServer.
Description of items
Item name Description Remarks
Help Shows the help window.  
Version info Shows the version of DataSpiderServer.  

Project explorer

You can deploy projects, configure properties of scripts, and create script variables.

Project menu

The right click menu when you select a project.
Description of items
Item name Description Remarks
New Creates a new folder or script to the project.  
Paste Pastes folders or scripts copied.  
Delete Deletes the selected project.  
Sort icon Arrange by the specified order the icon inside projects selected.  
Close project Closes the selected project.  
Team development Commit Commit the the local project to the server project.
If the changes crash, it will be detected as a conflict.
  • Enable when team development is enabled.
    Refer to "Team Development" for details.
Update Update the local project with the the server project.
If the changes crash, will be detected as a conflict.
Replace project with latest version Destroy the local project and overwrite the project with the latest server contents.
Resolve conflicts of projects Display the menu related to the project conflict solving.
Register project as service Register the selected project to server as a service.
Restore project from server Restores a project from a back up file by reference version name, update date time, update user.  
PSP data flow operation Enable at once Of all the scripts in the selected projects, changes the modifiable data flow into a PSP data flow.
Release at once Of all the scripts in the selected projects, changes the PSP data flow into a data flow.
Generate project specifications On client local file, generate HTML generates a form of project specifications.

Script menu

The menu shown by selecting script then right-clicking.
Description of items
Item name Description Remarks
New Creates a new "script variable" in the selected script.  
Open Opens the selected script to the script canvas.  
Cut Cuts the selected script.  
Copy Copies the selected script.  
Paste Pastes the copied or cut script.  
Delete Deletes the selected script.  
Lock script Locks the selected script by the current user.  
Unlock script Unlocks the script.
  • The following users can unlock scripts.
    • Administrator users.
    • Users who locked the script.
    • Users who can write the project the script is in.
Team development Replace script with latest version Destroy the local edition and overwrite the script with the latest server.
  • Enable when team development is enabled.
    Refer to "Team Development" for details.
Restore script from local history Recover the script from the local history.
Resolve conflicts of scripts Display the menu related to the script conflict solving.
Output XML for executing script On client local file system, output ScriptRunner startup configuration file.
  • The ssl element is not output.Set the ssl value manually.
Restore script from server Restores a script from a back up file by reference version name, update date time, update user.  
PSP data flow operation Enable at once Of the selected scripts, changes the modifiable data flow into a PSP data flow.
Release at once Of the selected scripts, changes the PSP data flow into a data flow.
Generate script specifications On client local file, generate HTML project specifications.
Properties Script properties will be displayed.  

In generating project/script specification, if you generate script specification including the folowing script component, component order will be output as below. Example: If the contents of the script is as below,
      start → Start Conditional Branch → End Conditional Branch → Wait(1) → end
                   └      Condition → Wait      ┘
Then order of the list of specification components is as below.
      start → Start Conditional Branch → End Conditional Branch → Wait(1) → end → Condition → Wait

Folder menu

The menu shown by selecting script then right-clicking.
Description of items
Item name Description Remarks
New Creats a new folder or a screpit in a folder.  
Cut Cuts the selected folder  
Copy Copies the selected folder  
Paste Pastes the copied or cut folder or script.  
Delete Deletes the selected folder.  
Sort icon Puts the icons in a selected folder in order with the specified order.  
PSP data flow operation Enable at once Of all the scripts in the selected projects, changes the modifiable data flow into a PSP data flow.
Releases at once Of all the scripts in the selected projects, changes the PSP data flow into a data flow.

Script variables

You can create a script variable on the [File]-[New]-[Script variable].

Required settings

Description of items
Item name Description Remarks
Variable name Enter the name of the variable.  
Variable type Select the type of the variable.
  • [String]:(default)
  • [Integer]:
  • [Decimal]:
  • [Date/time]:
  • [Boolean]:
  • [Binary]:
  • [XML]:
  • For more information about type, refer to "Script variable".
  • You cannot change XML type defined variables can be changed to any other typeAlso, You cannot change variables design by type which is not XML type to XML type.
Initial value Enter the initial values of variables.  
Use as script input variable
  • [Checked]:
    Set script variables as input variables.
  • [Not Checked]:(default)
    Do not set script variable as input variable.
  • You can also set from script properties [I/O].
Use as script output variable
  • [Checked]:
    Set script variables as output variables.
    Available to refer from out of script.
  • [Not Checked]:(default)
    Do not set script variable as output variable.

Comment

Description of items
Item name Description Remarks
Comment You can write comment.  

Script properties

Sets the following settings.

Basic information

Shows information about the script as follows.

Item name Description Remarks
Conflict information Shows conflict information of the local script and the server script.
  • Enable when team development is enabled and the script is conflicted.
    Refer to "Team Development" for details.
Last modified on server Shows the time when the most recent version of the server project was saved..  
Last modified user on server Shows the user who commit the most recent version of the server project .  
Comment Shows the comment of the most recent version of the server project .  
Last modified on local Shows the time when the the most recent version of the local project was saved.  
Lock information Shows the status of locked or not locked.
When the script is locked, the State is "Locked. " and when the script is not locked, the State is "Not locked."
 
Owner Shows the owner who locked the script.
  • Shows when the [State] is "Locked." .
Host which locks Shows the host name or IP address the user who locked the script is logging in.
  • Shows when the [State] is "Locked." .
Time when lock was acquired Shows the time when the lock was acquired.
  • Shows when the [State] is "Locked." .

I/O

Sets I/O settings for script variables on the "I/O" configuration dialog.
You can set I/O settings of all script variables in this "I/O" configuration dialog. You can also set I/O settings of each script variable on the script variable properties.
Refer to "I/O" for details.

Transaction

Select a transaction type of the script.The value defaults to "SUPPORTS".
Refer to "Transaction" for details.

Data processing method

Select a data processing method of the script.
Refer to "Mass data processing" for details.

Execution test

You can set values which are defined in the [Execution test] to script input variables, when the script is executed in debugging mode.
Enabled when the [Set argument value when test is executed] is checked.

Comment

You can write a short description.

Generate project specifications

Basic information

Description of items
Item name Description Remarks
Output target Enter the directory path of the client OS local file system to the output specifications.

Click [Browse] button to activate the file Selectr and Select the directory.
  • Refer to "OS Local File System" for client OS local file system.
  • In the Studio for Web, compress the specification and download it as a ZIP file.
Output viewing PSP data flow Select whether to output viewing PSP data flow.
  • [Checked]:
    Output the PSP data flow with orange thick lines.
  • [Not checked]:(default)
    Output the PSP data flow with orange dotted lines.
 
Expand nodes without mapping links Select whether to expand child nodes of "Input data", "Input document", and "Output data", without mapping links in screens of mapping canvas.
  • [Checked]:(default)
    Expand nodes without mapping links.
  • [Not checked]:
    Not expand nodes without mapping links.
  • For "Input document" of Variable mapper, even if [Checked], expands only schemas including nodes with mapping links.
  • For child nodes of "Component variable" and "Script variable", regardless of whether checked or not, expands only nodes with mapping links.

Author information

Description of items
Item name Description Remarks
Company name Enter an optional company name.
  • The information you enter is output to specifications.
Project name Enter an optional project name.
  • The information you enter is output to specifications.
Name Enter an optional name.
  • The information you enter is output to specifications.
Date modified Enter an optional modified date.  

Script Canvas

In script canvas, you can put component icons on a script canvas and drag & drop them to make flows.
For more details, refer to "Placing component icons" and "Drow a flow".

Component menu

This is the menu which is shown when you select and right-click a component icon.
Description of items
Item name Description Remarks
Set/Release breakpoint Set/Release breakpoint for the selected icon.  
Cut Cut the selected icon.  
Copy Copy the selected icon.  
Delete Delete the selected icon.  
Align Align Left Align left the selected icons.
When you execute Align Left, X-coordicates of all the selected icons on the script canvas becomes equal position to that which is at the most left.
 
Align Right Align right the selected icons.
When you execute Align Right, X-coordicates of all the selected icons on the script canvas becomes equal position to that which is at the most right.
 
Align Top Align top the selected icons.
When you execute Align Top, Y-coordicates of all the selected icons on the script canvas becomes equal position to that which is at the most top.
 
Align Bottom Align bottom the selected icons.
When you execute Align Bottom, Y-coordicates of all the selected icons on the script canvas becomes equal position to that which is at the most bottom.
 
Align Horizontal Justify the selected icons horizontal.  
Align Vertical Justify the selected icons vertical.  
Global Schema Register Input Schema Register input schema of the selected icon as global schema.
Register Output Schema Register output schema of the selected icon as global schema.
Properties Open the properties window of the selected icon.  
Help Open the help of the selected icon.  

Execution history

When you run the script in debug mode, processing time of icon and processing time of entire script and percentage of process will be displayed in percentage.

Execution History

The processing time of each icon and entire script are displayed.
The percentage of time to run script is always displayed as "100.0%"
Summing up the percentage of running time of each icon in the script may not get 100. This is due to the percentage of time of each execution is shown by cutting to two decimal places.

Narrow down execution log

When you select an icon that is displayed in the execution history, you can view the log output during the execution of the icon.
If you are using threading process, you cannot narrow down execution log of each icon when threading process. Log on threading process is associated with all thread icons.

Icon abbreviation

If number of icons that appear in the execution history become large by repeated process, icon will be shown by abbreviation. The maximum number of icons: 100 child node for each icon.

Undo/Redo function

About microsecond data

You cannot handle microsecond data for some adapters.

The adapters compatible with micro seconds are as follows.

Specification limit

Designer

Project explorer

Execution history

Execution log

Generate project/script specifications

Previewer

Selectr

Floating frame

Global resource settings

Script component

Adapter

Main exceptions

Exception name Cause Solution
InterruptedException Throws when a running script is forced to terminate. None.

Notes

Designer

Project explorer

Property inspector

Script component