Layout Builder
- Akash Kumar Jaiswal (Unlicensed)
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.
For now, this is supported for the following two layouts under the Beta version.
Layout Builder Interface
The Text Layout screen is divided into following sections:
Options of the Tool bar are explained in the table below.
Button | Name | Function |
|---|---|---|
 | Save layout | To 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 View | To view and download the XSD format of text Layout. |
 | Test Layout | To test the similar layout as per the structure defined and generates the output and error files. |
 | Help | To check the help documentation for text Layout. |
 | Details | Displays 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 View | To reset the text layout. |
 | Sheet | To select the sheet. |
This panel contains the list of properties that are used to define the Text layout.
Property | Description |
|---|---|
Layout Name | Name 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 Present | Check this if you want to add the titles of the fields in your text file. |
Record Separator | Provide 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 Separator | Provide the field separator, for example, \t for Tab or " " for space, in the Field Separator. Field Separator is used to separate fields. |
Upload Data File | To upload the text file which displays the uploaded text file in File View area. |
Reference Layout Type | Specify the reference layout type for the current layout. |
Reference Layout | Displays the defined reference schema in the drop-down list. |
Project | Specify the project for text layout. This option is visible only when GAC is enabled. |
Row Start Position | Row Start Position specifies which row of the text Sheet is counted as first row. |
Bottom Row Skip Count | To skip certain bottom row from the text file then define the row count from Bottom Row Skip Count field. |
Character Set Encoding | Define 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 Character | Type the enclosing characters to remove from the data file while parsing in the Handle Enclosing Character. |
Dynamic Header Support | Select this option to insert the data of input file under the same header name as defined in the layout. |
Quotes Handling On | Select Quotes Handling check box to enable quotes handling. |
Enclosed Target Field Values In Double Quotes | Select the Enclose Target Field Values in Double Quotes checkbox to enclose the target field values in double quotes. |
Allow Less Fields | Check this if you want to generate empty fields when record data length is less than defined in schema. |
Remove Last New Line Record Separator | Select 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 Character | Select this option if you want to replace xml invalid character. |
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.
Detail Panel displays the defined table data and control total of the text layout.
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:
Click Configure > Developer Studio.
Click Proceed and you will be redirected to Adeptia Suite home page.
On the Adeptia Suite home page, click Administer tab.
Go to Setup menu and select the Application Settings option.
Click the Update System Properties option.
Expand the Adeptia Connect node. This action will display the properties to be set for Excel/Text Layout.
The default value of the abpm.services.advschema.enabled property is false.Set the value of these property:
The default value of the abpm.services.advschema.enabled property is false. Set the value of the abpm.services.advschema.enabled property to true.
Set the value of the abpm.services.advschema.file.max_size property to define the max size of uploaded file for layout creation (in KB).
Set the value of the abpm.services.advschema.file.max_rows property to define the max rows of uploaded file for layout creation.
Set the value of the abpm.services.advschema.file.max_columns property to define the max columns of uploaded file for layout creation.
Set the value of the abpm.services.advschema.file.max_sheets property to define the max sheets of uploaded file for layout creation.
Set the value of the abpm.advschema.path property to configure the location where layout files should be created.
Click the Save button to save the new values.
Reload the configuration.
Refresh the Adeptia Connect GUI.