Starting FileIO

This chapter describes how to create FileIO and relevant details and functions.

This guide assumes that FileIO is created in Studio.

1. Overview

This chapter describes the following for FileIO creation.

  1. Adding FileIO basic information

    The first step of creating FileIO. For detailed information, refer to Adding FileIO Basic Information.

  2. Using the FileIO editor

    FileIO editor’s screen layout and details. For detailed information, refer to Using FileIO Editor.

  3. Creating FileIO

    How to create FileIO. For detailed information, refer to Creating FileIO.

  4. Compilation and Dlupdate

    How to compile created FileIO and execute Dlupdate. For detailed information, refer to Compilation and Dlupdate.

2. Adding FileIO Basic Information

The following are the steps for adding basic information.

  1. Select [New] > [FileIO] from the context menu of Workspace Navigator.

  2. The following New FileIO Wizard opens. In this wizard, basic information required to create FileIO can be added.

    figure3 1
    New FileIO Wizard

    The following describes each item.

    Item Description

    Resource Group

    Resource group registered in WebAdmin. (Required)

    If a desired resource group does not exist, add the resource group in WebAdmin. To add a resource group, log in to WebAdmin and select [META SYSTEM] from the main screen and then select [META SYSTEM] > [ResourceGroupMgmt]. In the ResourceGroupMgmt screen, check currently set resource groups and then register the resource group to add.

    logical name

    Logical name of FileIO to register.

    physical name

    Physical name of FileIO to register.

    Import from excel file

    Imports an Excel file that includes structure fields to the structure editor for structure creation.

    If selected, Resource Group, logical name, physical name, and resource description items are disabled when adding basic information about a structure.

    Check and register properties

    Option to check and add metadata if a structure field defined in the Excel file does not exist in the server.

    Update the structure which has a same physical name in Server.

    Option to update the structure if its physical name is already in use in the server when importing the structure as an Excel file.

    Browse…​

    Select an Excel file to import.

  3. Set each item and click [Finish] to go to the screen where you can edit FileIO. For information about the FileIO editor, refer to Using FileIO Editor.

3. Using FileIO Editor

FileIO editor consists of the following 3 sections.

figure3 2
FileIO Editor Screen Layout

① File data format

② column search add

③ column edit

File data format

Set the unit data format for reading and writing data to a file. Since FileIO accesses a file by using a structured format, set an accessible file format.

figure3 3
FileIO Editor – File data format

The following describes each item.

Item Description

FixedLength

Separates fields based on field length.

Delimiter

Separates fields based on delimiter. If selected, Define Delimiter is enabled.
column search add

Search for checked-in structures. If there are no structures to search for, create structures by using ProMapper, check in them, and search for them in this section.

figure3 4
FileIO Editor – column search add

  • Search conditions

    Item Description

    Search

    Structure name to search for.

    Select scope

    Either All or User.

    Select search name

    Either logical name or physical name.

    Select search sequence

    Starts for keyword starting with.

  • Buttons

    Button Description

    Refresh

    Refreshes the search results.

  • Search results

    Item Description

    logical name

    Logical name of the resource.

    physical name

    Physical name of the resource.

    Resource Group

    Resource group that includes the resource.

    Owner

    Resource owner.

    Revision

    Cumulative number of changes to the resource.
column edit

Add columns by searching for them from the column search add section or by using Property Pool.

figure3 5
FileIO Editor – column edit

The following describes each item.

Item Description

logical name

Logical name of the field.

physical name

Physical name of the field.

Type

Field type.

length

Field length.

array size

Array size when using a field as an array.

Decimal

Number of digits after the decimal point.

Comments

Description about the field.

[▲]

Moves up the field.

[▼]

Moves down the field.

The method of adding a column varies depending on the column search add section and Property Pool.

  • column search add

    The following adds a structure by searching it from the column search add section.

    figure3 6
    FileIO Editor – Structure Search

    To add a found structure to Data Column Set, double-click or drag and drop it.

    The following describes each icon in the logical name column of Data Column Set.

    Item Description

    image

    Metadata is not registered, or a structure field’s required input value is omitted. Hovering over displays a tooltip for troubleshooting.

    image

    Metadata registered in the server does not match structure field data. This issue occurs usually because their data type, length, or logical name does not match. To use matched data, check the data and modify the field data or metadata.

    You can easily add and delete structures and columns by using the context menu of the column edit section.

    figure3 7
    FileIO Editor – Column Edition Menu
    Menu Description

    Delete(Delete)

    Deletes a selected structure or column.

    Copy(Ctrl+C)

    Copies a selected structure or column.

    Paste(Ctrl+V)

    Pastes a copied structure or column.

  • Property Pool

    The following adds a found structure by using Property Pool.

    figure3 8
    FileIO Editor – Property Pool

    To add a found structure to Data Column Set, drag and drop it. Edit the columns of the added structure, which means the FileIO structure creation, and then save the FileIO.

4. Creating FileIO

The following are the steps for creating a FileIO module.

  1. Select [New] > [FileIO] from the context menu of Workspace Navigator. The following New FileIO Wizard opens.

    figure3 9
    New FileIO Wizard

    Enter basic FileIO information and then click [Finish].

    Item Value

    Resource Group

    DBIO_C

    logical name

    FileIO_Test_Logical

    physical name

    FileIO_Test_Physical

  2. The FileIO editor is displayed.

    figure3 10
    FileIO Editor Screen

  3. Select the Delimiter check box and enter a comma (,) to use it as a delimiter.

    figure3 11
    FileIO Editor Screen – File data format

  4. Search for structures whose name starts with 'test' from the column search add section. Select a structure of the results and add it to the column edit section.

    figure3 12
    FileIO Editor Screen – column search add

  5. Search for structures whose name starts with 'test' from Property Pool. Select a column of the results and add it to the column edit section.

    figure3 13
    FileIO Editor Screen – Column Search

  6. Edit properties of the added structure and column and then save the FileIO module.

    figure3 14
    FileIO Editor Screen – column edit

5. Compilation and Dlupdate

FileIO modules are compiled in the following 2 steps.

  1. Compilation

    Compiles structures used in FileIO.

  2. Dlupdate

    Deploys compiled structures in shared memory.

Compiling FileIO does not create a module. Inserting a FileIO module to an EMB module creates source. Therefore, compiling the FileIO module is not necessary. It is necessary to compile ProMapper’s structures used for conversion in FileIO.

The following are the steps for compiling the FileIO module created in Creating FileIO.

  1. Select a FileIO module to create from Workspace Navigator and right-click it to view its context menu. Select the Compile Resource menu.

    figure3 15
    Compile Resource Menu

    You can also select the FileIO module and press <Alt> + C or click the compilation icon.

  2. The following Compile Resource window that shows the compilation progress is displayed.

    figure3 16
    Compile Resource Window

  3. If the compilation is successfully complete, compilation log is displayed in the console.

  4. Select and right-click the FileIO module to view its context menu. Select the Dlupdate menu.

    figure3 17
    Dlupdate Menu

    You can also select the FileIO module and press <Alt> + D or click the Dlupdate icon.