Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This feature helps you to manually create a layout through a data file directly through an interactive UI. You can choose a sample or an exact source file to define the layout by custom selection.

By default, this feature remains disabled in the product. You need to enable this feature before you start working on this. 

You can create the following layouts with Layout Builder.

Layout Builder Interface

The Text Layout screen is divided into following sections:

Anchor
Toolbar
Toolbar
Toolbar

Options of the Tool bar are explained in the table below.

Button

Name

Function

Save layoutTo save the text layout.

File View

To view the uploaded Text file.

Data View

To view, edit, and delete the Table Data and Control Total of text Layout.

XSD ViewTo view and download the XSD format of text Layout.

Test LayoutTo test the similar layout as per the structure defined and generates the output and error files.

HelpTo check the help documentation for text Layout.

DetailsDisplays the control total and table data.

You can also get this tool bar in Data View area:

Button

Name

Function

Zoom Out

To zoom out the text file in File View area.

Zoom In

To zoom in the text file in File View area.

Reset ViewTo reset the text layout.

SheetTo select the sheet.


Anchor
Definition Panel
Definition Panel
Definition Panel

This panel contains the list of properties that are used to define the Text layout.

Property

Description

Layout NameName of the Text layout. Only alphanumeric and underscore are allowed and you must start the layout name with an alphabet or underscore.

Layout Description

Description of the Text layout. Only alphanumeric and few special characters(_ - . : , @ $ ? \\ and space) are allowed and you must start the description with an Alphabet/Underscore/Number.

Layout Type

By default, Layout Type field reflects the same layout type which you are creating.

Data Header PresentCheck this if you want to add the titles of the fields in your text file.
Record SeparatorProvide the record separator, for example, \n for newline or " " for space, in the Record Separator. The record separator is used to separate the records.
Field SeparatorProvide the field separator, for example, \t for Tab or " " for space, in the Field Separator. Field Separator is used to separate fields.
Upload Data FileTo upload the text file which displays the uploaded text file in File View area.
Reference Layout TypeSpecify the reference layout type for the current layout.
Reference LayoutDisplays the defined reference schema in the drop-down list.
ProjectSpecify the project for text layout. This option is visible only when GAC is enabled.
Row Start PositionRow Start Position specifies which row of the text Sheet is counted as first row.
Bottom Row Skip CountTo skip certain bottom row from the text file then define the row count from Bottom Row Skip Count field.
Character Set EncodingDefine the Character-set encoding for your text layout from the drop-down list of Character Set Encoding field. The available options are UTF-8, UTF-16, and ISO-8859-1.
Handle Enclosing CharacterType the enclosing characters to remove from the data file while parsing in the Handle Enclosing Character.
Dynamic Header SupportSelect this option to insert the data of input file under the same header name as defined in the layout.
Quotes Handling OnSelect Quotes Handling check box to enable quotes handling.
Enclosed Target Field Values In Double QuotesSelect the  to enclose the target field values in double quotes.
Allow Less FieldsCheck this if you want to generate empty fields when record data length is less than defined in schema.
Remove Last New Line Record SeparatorSelect Remove Last New Line Record Separator check box if you want to remove the new line record separator from the target file.
Filter Invalid XML CharacterSelect this option if you want to replace xml invalid character.

 

Anchor
File View Area
File View Area
File View Area

File View area is the area where the text file is displayed. You can select the row and column to define the table data and control total of the text layout. The file view area can also be resized using zoom in/zoom out icon from toolbar.

Anchor
Detail Panel
Detail Panel
Detail Panel

Detail Panel displays the defined table data and control total of the text layout.

Anchor
Enabling Layout Builder
Enabling Layout Builder
Enabling Layout Builder

By default, this feature remains disabled in the product. Follow the steps below to enable it.

Only Admin User can enable the property of layout builder.

Follow the steps below to enable the Layout Builder:

  1. Click Account > Settings.

  2. Expand the Server Nodes Settings in the left panel.
  3. Select the server node.
  4. Click Edit.
  5. Click to expand Adeptia Connect.

  6. Update the values for the following properties:
    1. Set the value for the abpm.services.advschema.enabled property to true.

      Info
      The default value of the abpm.services.advschema.enabled property is false.


  7. Click Save.
  8. Reload the configuration.
  9. Refresh the Adeptia Connect GUI.

If required, you can change the following properties under the categories Adeptia Connect and Shared Path.

Expand
titleAdeptia Connect
  • Set the value for the abpm.services.advschema.file.max_size property to define the max size of uploaded file for layout creation (in KB).
  • Set the value for the abpm.services.advschema.file.max_rows property to define the max rows of uploaded file for layout creation.
  • Set the value for the abpm.services.advschema.file.max_columns property to define the max columns of uploaded file for layout creation.
  • Set the value for the abpm.services.advschema.file.max_sheets property to define the max sheets of uploaded file for layout creation.

Expand
titleShared Path

Set the value for the abpm.advschema.path property to configure the location where layout files should be created

.
  • Click Save.
  • Reload the configuration.
  • Refresh the Adeptia Connect GUI

    .