Hitachi

uCosminexus Service Platform Reference Guide


1.3.4 Component dialog

Use the Component dialog to specify a globally defined simple content element or complex content element for a component of a complex content element.

For details on operating procedure see "4.4.4 Defining Elements (for Non-CSV Format)" in "Service Platform Basic Development Guide".

The tabs displayed in the Component dialog differ depending on whether you specify a globally defined simple content element or a complex content element for a component.

Organization of this subsection

(1) Simple content element tab

The Simple content element tab is displayed only when you specify a simple content element for the component. The information of the simple content element to be specified for the component is displayed. You cannot modify these contents.

Figure 1‒50:  [Component] dialog (Simple content element tab)

[Figure]

The information displayed here are the values that were specified on the simple content element tab of the simple content element dialog when the globally defined simple content element, to be set for the component was specified.

For details about the simple content element tab of the [Simple content element] dialog, see "1.3.2(1) Simple content element tab".

(2) Complex content element tab

The Complex Content Element tab is displayed only when you specify a complex content element for the component. The information of the complex content element to be specified for the component is displayed. You cannot modify these contents.

Figure 1‒51:  [Component] dialog (Complex content element tab)

[Figure]

The information displayed here are the values that were specified in the Complex Content Element dialog when the complex content element, to be set for the component was specified.

For details about the complex content element dialog, see "1.3.3 Complex Content Element Dialog".

(3) Component tab (Simple content element)

Use this tab to specify component information. The Component tab is displayed regardless of whether the elements to be specified for the component are globally defined simple content elements or complex content elements. The following figure shows the component dialog which is displayed when the component is simple content element:

Figure 1‒52:  [Component] dialog (Component tab for Simple content element)

[Figure]

[Occurrence count]

Specify the occurrence count of component.

  • When the occurrence count is fixed

    Select the [Fixed] radio button and, specify an occurrence count between 1 and 2,147,483,647.

  • When a range is specified for the occurrence count

    Select the [Range] radio button and, specify the range of occurrence count in Minimum and Maximum. You can set a value in the range of 1 - 2,147,483,647.

  • When the element is considered to be until end of data

    Select the [Until end of data] radio button. Note that for a minimum one-time occurrence of data, select the Do not omit data checkbox.

    Reference note

    The following implies the end of data:

    • When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

    • When the entire data has been read

    • When data of the specified size has been read from the size node of the specified complex content element

  • When occurrence count is to be made dependent on another element

    Select the [Occurrence-count node] radio button and, click the [Select Node] button to select the node that will depend on another element. When handling the CSV format data as binary data, this radio button will be passive.

[Select node] button

Opens the [Select node] dialog. To make the component occurrence count dependent on another element, use this dialog.

The node selected in the [Select node] dialog is displayed as follows:

  • When the node is selected from Base path

    A relative path from the base node is displayed.

  • When the node is selected from Absolute path

    A path from the root element is displayed.

[Size]

Specify the size of the data that is used as a simple content element (which is a Component), when you select [Variable] under [Size] in the Simple content element tab. When CSV format data is handled as binary data, this area is deactivated.

  • When the data is considered an element until the end

    Select the [Until end of data] radio button. Active only in case of simple content element tab.

    Reference note

    The following implies the end of data:

    • When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

    • When the entire data has been read

    • When data of the specified size has been read from the size node of the specified complex content element

  • When the size is to be made dependent on an another element

    Select the [Size node] radio button and, by clicking the [Select node] button, select the node that will depend on another element.

[Select node] button

Opens the Select Node dialog. To make the size of a simple content element (which is a Component) dependent on another element, use this dialog when selecting a node that will depend on another element.

The node selected in the [Select node] dialog is displayed as follows:

  • When the node is selected from Base path

    A relative path from the base node is displayed.

  • When the node is selected from Absolute path

    A path from the root element is displayed.

[Size calculation method]

From the drop-down list, select one of the following values as the method of calculating the size of the size node. If you use a binary format definition of an earlier version that does not have the Size calculation method setting, System default value is assumed.

Specification value

Size node value

System default value

The extended size node function is enabled or disabled according to the value set in the csc.dt.sizeNode.includeSelfSize property of the user property file for the J2EE server (usrconf.properties) in the execution environment.

For details about the settings of the user property file for the J2EE server, see 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

Data length only

The extended size node function is disabled and the size of the setting source element of the size node is applied to the size node length.

Include the size node length

The extended size node function is enabled and the sum of the size of the setting source element of the size node and the size of the size node is applied to the size node length.

[Unit of size node values]

Select the unit of size node values from the following:

  • Number of bytes (default)

    The value of the size node is converted to bytes.

  • Number of digits

    The value of the size node is converted to the digits of data.

    If you select Number of digits, Size calculation method is deactivated.

This item is activated when all the following conditions are met:

- Numeric value in pack format is selected for Data type and the Variable radio button is selected for Size in the Simple Content Element tab.

- The Size node radio button is selected for Size in the Component tab.

(4) Component tab (Complex content element)

Use this tab to specify component information. The Component tab is displayed regardless of whether the elements to be specified for the component are globally defined simple content elements or complex content elements. The following figure shows the component dialog displayed when the component is complex content element:

Figure 1‒53:  [Component] dialog (Component tab for Complex content element)

[Figure]

[Occurrence count]
  • When the occurrence count is fixed

    When there is a header element in CSV format, select [Fixed] radio button and, specify occurrence count between 0~1.

    When there is a record element in CSV format or in case of a non-CSV format, select [Fixed] radio button and, set occurrence count between 1~2,147,483,647.

  • When a range is specified for the occurrence count

    When there is a record element in CSV format or in case of a non-CSV format, select the [Range] radio button and, specify the range of occurrence count in [Minimum] and [Maximum]. You can set a value in the range of 1 - 2,147,483,647.

    When there is a header element in CSV format, [Range] radio button is passive.

  • When the element is considered to be until end of data

    When there is a record element in CSV format or in case of a non-CSV format, Select the [Until end of data] radio button. Note that for a minimum one-time occurrence of data, select the Do not omit data checkbox.

    When there is a header element in CSV format, [Until end of data] radio button is passive.

    Reference note

    The following implies the end of data:

    • When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

    • When the entire data has been read

    • When data of the specified size has been read from the size node of the specified complex content element

  • When occurrence count is to be made dependent on another element

    In case of non-CSV format, select [Occurrence count node] radio button and click the [Select Node] button to select the nodes , which depend on another element.

    When there is a header element or record element in CSV format, [Occurrence count node] radio button is passive.

[Select node] button

Opens the [Select node] dialog. To make the component occurrence count dependent on another element, use this dialog.

The node selected in the [Select node] dialog is displayed as follows:

  • When the node is selected from Base path

    A relative path from the base node is displayed.

  • When the node is selected from Absolute path

    A path from the root element is displayed.

[Size]

Specify the size of the data that is used as a complex content element (which is a Component), when the occurrence count of Component tab is Fixed and is Once. This item will be passive if you treat data in CSV format as binary data.

[Select node] button

To make the size of a complex content element (which is a Component) dependent on another element, use this dialog to select a node that will depend on another element.

The node selected in the [Select node] dialog is displayed as follows:

  • When the node is selected from Base path

    A relative path from the base node is displayed

  • When the node is selected from Absolute path

    A path from the root element is displayed.

[Delete] button

Deletes the [Size node] value.

[Size calculation method]

From the drop-down list, select one of the following values as the method of calculating the size of the size node.

Specification value

Size node value

System default value

The extended size node function is enabled or disabled according to the value set for the csc.dt.sizeNode.includeSelfSize property of the user property file for the J2EE server (usrconf.properties) in the execution environment.

For details about the settings of the user property file for the J2EE server, see 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

Data length only

The extended size node function is disabled and the size of the setting source element of the size node is applied to the size node length.

Include the size node length

The extended size node function is enabled and the sum of the size of the setting source element of the size node and the size of the size node is applied to the size node length.

(5) Separator tab

The Separator tab is displayed only when you want to specify a complex content element in the component. The information about the separators of the complex content elements specified in Component is displayed. You cannot modify these contents.

Figure 1‒54:  [Component] dialog (Separator tab)

[Figure]

The information displayed here are the values specified in the Complex content element dialog, when separators are set in the complex content elements, to be set in the component.

For details about the Complex content element dialog, see "1.3.3 Complex Content Element Dialog".

(6) Contents common to both tabs

The following contents are common to both tabs:

[Information]

If there is a problem in the information that is entered in the Component dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Name]

Displays the name of the element to be specified in the component.

[OK] button

Commits the specified contents and closes the Component dialog.

[Cancel] button

Closes the Component dialog without committing the specified contents.