Configuring an input/output schema

Adapter schemas

There are two types of adapters: adapters that automatically generate schemas of input/output data used for mapping definitions, and adapters for which schemas need to be configured manually.

Adapters that automatically generate schemas

The adapter automatically generates an appropriate schema according to the adapter property settings.

Even when you change the properties, the adapter automatically adjusts the schema, and you do not need to make manual changes.

Therefore, schemas can usually not be edited.

Adapters for which schemas must be configured manually

You must configure a schema on the Mapper editor screen before mapping nodes.

To edit a schema, open the right-click menu of the schema and select Load schema, Add root element, or Load in Global schema.

After loading a schema or adding a root element, edit the schema as necessary.

Schema types

The input/output schema type depends on the input/output component type.

Loading a schema

To load a schema, right-click the component icon name shown directly under Input data or Output data, and from the menu, click Load schema.

You can select a schema from a component, XML file, or schema file.

Selecting a schema loading method

Selecting from component

Configure the output schema of a selected component.

= Remarks =

  • You can only select components that contain an output schema.

    (Example: Read CSV File, Read XML File)

  • When you select a component that contains an input schema and an output schema, the output schema is loaded.

    (Example: Mapper)

Loading from a JSON file

Configure a schema based on a specified JSON file. You can select a file from the file chooser that opens by clicking [Browse].

Note

The following restrictions apply for key names defined in a JSON schema:

  • The first letter of the key name can be specified in alphabetic characters only.

  • The letters after the first letter of the key name can be specified with alphanumeric characters and symbols "_(underscore)" only.

Adding a root element

To add a root element, right-click the component icon name shown directly under Input data or Output data, and from the menu, click Add root element.

= Remarks =

Add root element is available only if no root element exists in the schema.

Search items

When you select Contains for the search conditions from Search I/O item in the tools menu, items whose element name and comment partially match the character string that you input for Keyword are searched for.

When you select Matches for the search conditions, items whose element name and comment exactly match the character string that you input for Keyword are searched for.

When you do not select the check box for Display only item name, the complete tree path that starts with the Input data of the Input source or the Output data of the Output source is displayed in the search results.

When you select the check box, only the element name is displayed in the search results.

Global schema

You can load, unlink, and register a global schema by right-clicking the component icon name shown directly under Input data or Output data and clicking Global schema from the menu.

Description of item

Load

This item loads the specified global schema.

Unlink

This item unlinks references to the global schema.

= Remarks =

This item is available only when the global schema is referred to.

Register

This item registers a schema as a global schema.

Note

To prevent a project from being accidentally overwritten, do not open multiple Designers during registration.

= Remarks =

  • Before registering a schema, you must either save all the projects opened in Designer, or close the other projects.

  • After registration is complete, the schema refers to the registered global schema.

Other editing

You can perform the following operations from the right-click menu of each element.

The content of the displayed menu differs depending on the root element and other elements.

 

Table 2.1 Description of menu items

Item Name

Display Source Element (Root Element/Element Other Than Root)

Description

Edit

Common

This item edits an element name or comment.

Add

Child element

Root element

This item adds a child element.

Cut

Element other than root

This item cuts the schema.

Copy

Element other than root

This item copies the schema.

Paste

Common

This item pastes the cut or copied schema.

Delete

Element other than root

This item deletes the schema.