Custom Logic

Custom logic is a function that allows you to put multiple Mapper logics together into a single logic and share it in Document Mapper and Variable Mapper.
Changes in the custom logic will be reflected in all the placed custom logics. Therefore, common conversion processings can be put together at one point, and this will improve development efficiency and prevent correction omissions compared to creating the same process at multiple points.

There are two types of custom logics, "Global custom logic" and “Local custom logic”.

Global custom logic can be used in all projects/scripts. You can use the same global custom logic in multiple projects, and this improves productivity especially in large-scale script development.
Since global custom logic is managed apart from the project, it can be migrated to another DataSpiderServer by exporting from server migration and you can use it as a common library.
The impact is large when you change or delete a global custom logic because it can be used in all projects/scripts. In such cases, you can easily check the range of impact and deployment destination by using "Find referrers".

Local custom logic can be used only within a single project. Use local custom logic when the custom logic is to be shared only within the project or to be managed together with the project.

Local custom logic cannot be migrated to global custom logic, and vice versa.

How to create

Open Mapper editor, and in the tool palette, right-click on "Global custom" palette and select [Add] - [Custom logic].
Custom logic can also be classified by using group.
Description of items

Item name Description Remarks

Add Custom logic Add a new global custom logic.

Group Add a new group.

Set the global custom logic name.
Description of items

Item name Description Remarks

Custom logic name Enter the global custom logic name.

Comment Enter a comment.

A new global custom logic will be created and displayed in the tool palette.

Item name	Description	Remarks
Add	Custom logic	Add a new global custom logic.
Group	Add a new group.

Item name	Description	Remarks
Custom logic name	Enter the global custom logic name.
Comment	Enter a comment.

How to edit

Double-click the global custom logic in the "Global custom" palette of the tool palette and open the global custom logic editor.
You can also open it by double-clicking the global custom logic icon on the mapping canvas.

Select [Create new handler] from the right-click menu of the input source root element (input handler).
Description of items

Item name Description Remarks

Create new handler Add an input handler.

Set the input handler name.
Description of items

Item name Description Remarks

Handler name Enter the input handler name.

Comment Enter a comment.

Place a Mapper logic onto the canvas from the tool palette and create the mapping of global custom logic.

Item name	Description	Remarks
Create new handler	Add an input handler.

Item name	Description	Remarks
Handler name	Enter the input handler name.
Comment	Enter a comment.

The handler name and comment can be edited from [Edit] in the right-click menu of the created input handler.

The handler can be deleted from [Delete] in the right-click menu of the created input handler.

The output handler is handled same as normal logics, so the output will be of one type. Therefore it cannot be edited.

Notes

When you a edit a global custom logic, scripts and services referring to that logic will be influenced.
To prevent from editing it unintentionally, check the impact range by "Find referrers" before editing, and if the user who created the logic is another user, consult the user on the edition.
Change (increase/decrease) of input handlers will be reflected to placed global custom logics. Also, when an input handler is removed, the mapping link to the input handler of placed global custom logics will be removed.
So make sure to check the range of impact in "Find referrers" before changing input handlers.
Change (increase/decrease) of input handlers will be reflected immediately to placed global custom logics for the project where the change was made. For other projects, you will have to re-open the projects, open the Mappers, and reflect the changes manually.
Search the deployment destination in "Find referrers” and reflect the changes.
An execution error will occur when the number of input handlers of the global custom logic itself is different from the number of input handlers of a placed global custom logic.

Place on mapping canvas

Drag and drop a global custom logic onto the mapping canvas from the "Global custom" palette in the tool palette.

All input/output types are string type.

How to move/copy

Move

Click [Cut] from the right-click menu of global custom logic in the "Global custom" palette of the tool palette.
Click [Paste] from the right-click menu in the destination (a group or an empty space in the "Global custom" palette).
It cannot be moved to the same hierarchy.
If a global custom logic of the same name exists in the destination, an underscore and number will automatically be appended at the end of the global custom logic name.

Copy

Click [Copy] from the right-click menu of global custom logic in "Global custom” palette of the tool palette.
Click [Paste] from the right-click menu of a group or in an empty space in the "Global custom" palette.
If a global custom logic of the same name exists in the destination, an underscore and number will automatically be appended at the end of the global custom logic name.

Find referrers

Find referrers is a function to find the Mappers using the global custom logic.

Click [Find referrers...] in the right-click menu of global custom logic in the "Global custom” palette of the tool palette.

"Find referrers" dialog will open.
Information of Mappers which refers to the global custom logic (from which the right-click menu was opened) is displayed.

Projects and services which you don't have permission to read are not be displayed.

Description of items

Item name		Description
Project	Project	Project name in which the logic is used.
	Script	Script name in which the logic is used.
	Mapper	Component icon name of the Mapper in which the logic is used.
	Layer	Layer name of the Mapper in which the logic is used.
	Comment	Comment of the logic.
Service	Service	Service name in which the logic is used.
	Script	Script name in which the logic is used.
	Mapper	Component icon name of the Mapper in which the logic is used.
	Layer	Layer name of the Mapper in which the logic is used.
	Comment	Comment of the logic.

Select a row in [Mapper list] and click [Open Mapper] to open the Mapper editor in which the logic is used. At that time, the logic will be selected.
When the same global custom logic with the same comment is multiply placed in a layer, all the logics will be selected.

How to delete

Click [Delete] from the right-click menu of global custom logic in the “Global custom” palette of the tool palette.

When you delete a global custom logic, scripts and services referring to that logic will be inexecutable. Be sure to check the range of impact in “Find referrers” before deleting.

When deleting a global custom logic, placed global custom logics referring to the logic may not be removed immediately. In that case, re-open the project.

Specification limits

The access control cannot be set. Therefore, be cautious not to edit or delete carelessly. It is recommended that you perform exporting from server migration and create a backup periodically.

When there is no mapping for an input handler of global custom logic placed on mapping canvas, the input value of the handler will be null.

Addition/Deletion/Renaming of a global custom logic or a group will be reflected immediately only for the project where the change was made. For other projects, it will be reflected when you re-open the projects.

If the entity of a global custom logic does not exist, “Loading custom logic error” dialog will appear and the placed global custom logic will be removed when you open a project and open the Mapper which refers to the logic.

When you change [Custom logic name], it will not be reflected in the tool tips of the global custom logics placed on the mapping canvas.
In such a case, reopen the Mapper editor.

Other custom logics cannot be used in a global custom logic.

Local Custom Logic

How to create
How to edit
Place on mapping canvas
How to delete
Specification limits

How to create

Open Mapper editor, and in the tool palette, right-click on "Local custom" and select [Add] - [Custom logic].
Custom logic can also be classified by using group.
Description of items

Item name Description Remarks

Add Custom logic Add a new local custom logic.

Group Add a new group.

Set the custom logic name.
Description of items

Item name Description Remarks

Custom logic name Enter the local custom logic name.

Comment Enter a comment.

A new local custom logic will be created and displayed in the tool palette.

Item name	Description	Remarks
Add	Custom logic	Add a new local custom logic.
Group	Add a new group.

Item name	Description	Remarks
Custom logic name	Enter the local custom logic name.
Comment	Enter a comment.

How to edit

Double-click the local custom logic in the "Local custom" palette of the tool palette and open the Mapper editor.
You can also open it by double-clicking the local custom logic icon on the mapping canvas.

Select [Create new handler] from the right-click menu of the input source root element (input handler).
Description of items

Item name Description Remarks

Create new handler Add an input handler.

Set the input handler name.
Description of items

Item name Description Remarks

Handler name Enter the input handler name.

Comment Enter a comment.

Place a Mapper logic onto the canvas from the tool palette and create the mapping of local custom logic.

Item name	Description	Remarks
Create new handler	Add an input handler.

Item name	Description	Remarks
Handler name	Enter the input handler name.
Comment	Enter a comment.

Increase/Decrease of input handlers will be reflected also in local custom logic icons placed on the mapping canvas. When an input handler is removed, the link attached will also be removed at the same time.

The output handler is handled same as normal logics, so the output will be of one type. Therefore it cannot be edited.

The handler name and comment can be edited from [Edit] in the right-click menu of the created input handler.

The handler can be deleted from [Delete] in the right-click menu of the created input handler.

When the contents of local custom logic are changed, the changes will be reflected in all the local custom logics placed in scripts of the project where the changes are made. Therefore, saving the project may take some time if there are many scripts.

If the entity of a local custom logic does not exist, “Loading custom logic error” dialog will appear when you open a project and open the Mapper which refers to the logic, and the placed local custom logic will be removed.

When you change [Custom logic name], it will not be reflected in the tool tips of the local custom logics placed on the mapping canvas.
In such a case, reopen the Mapper editor.

You cannot copy a Mapper that includes a local custom logic to another project's script. Similarly, you cannot copy a script that includes that Mapper to another project.
Use local custom logic only within the created project.

Other custom logics cannot be used in a local custom logic.

When the same local custom logic is mapped to an input handler of the local custom logic placed on the mapping canvas, you might get an unexpected processing result if an unmapped input handler exists.
Perform mapping for all input handlers.