1. Country-Specific Features
  2. Region-Specific SuiteApps
  3. LATAM File Builder
  4. Electronic Data Files Structure
  5. Creating File Layouts

Creating File Layouts

Note:

To access the LATAM File Builder SuiteApp documentation in Brazilian Portuguese (Português do Brasil), see LATAM File Builder.

The file layout is the main record in the file building structure. It aggregates all the other records required to generate or import electronic data files.

File layouts include settings such as type of layout, decimal separator, and column and line delimiters. The record is also where you set the plug-in implementation that generates or imports the electronic data file.

If you want to create a custom plug-in implementation, see File Processing Implementation.

When you import or generate a file, a map/reduce script uses the information you set up on the file layout and associated child records to process the file.

After you save the file layout, create layout sections, section sources, and source fields to complete your file building structure. Additionally, you can create parameters to restrict or adapt the generation of the file under certain conditions.

To create a file layout:

  1. Go to Setup > Latam File Builder > File Layout > New.

  2. In the Name field, enter a name for the file layout.

  3. In the Plug-in Implementation ID field, enter the ID of the plug-in implementation you want to associate with this layout.

    To find a plug-in implementation's ID:

    1. Go to Customization > Plug-ins > Plug-in Implementations.

    2. Next to the plug-in implementation you want to associate with the file layout, click View.

    3. Verify the plug-in implementation's ID in the ID column.

      Take note of the ID so you can enter it in the Plug-in Implementation ID field.

  4. In the Type field, select the type of layout you want to use to build files.

    • If you want to use fixed numbers of characters to define the width for each field, select Fixed-width.

    • If you want to use special characters as delimiters to separate the fields, select Delimited.

  5. If you chose Delimited as the type of layout, select the line and column delimiters.

    1. In the Line Delimiter field, select the character you want to use as a line separator for files generated with this layout.

      Line delimiters appear at the start and end of each line.

    2. In the Column Delimiter field, select the character you want to use as a column separator for files generated with this layout.

      Column delimiters appear between the columns in a line.

  6. In the Default Value for Unused Positions field, select the value you want to include in the positions that the source fields don't fill.

  7. In the Decimal Separator field, select the character you want to set as the default decimal separator for the fields in this layout.

  8. In the Character Encoding field, select the type of character encoding you want to apply to files generated with this layout.

  9. In the App ID field, enter the ID of the SuiteApp associated with this file layout.

    NetSuite uses this information to define for which SuiteApp the file layout will be available.

  10. In the Generated File Folder ID field, enter the internal ID of the File Cabinet folder where you want to save the files generated with this layout.

    To find a File Cabinet folder's internal ID:

    1. Set the Show Internal IDs preference.

      For more information, see Setting the Show Internal IDs Preference.

    2. Go to Documents > Files > File Cabinet.

    3. Find the folder where you want to save the files.

    4. Verify the folder's internal ID on the Internal ID column.

      Take note of the ID so you can enter it in the Generated File Folder ID field.

      When you enter an internal ID in this field, the Generated File Folder field displays the name of the folder that matches the ID.

    If you don't select a folder, NetSuite saves files in the User Documents folder (ID -20).

  11. In the Line Break field, select the characters that indicate where a line ends and a new one starts in your files.

  12. In the Version of the File Generation API field, select the version of the LATAM File Builder's API with which you want to generate the files.

    • If you generate or import files with up to a thousand rows, select Version 1.

    • If you generate or import files with larger amounts of data and millions of rows, select Version 2.

    If you don't select an API version, NetSuite uses version 1 by default.

  13. Click Save.

    NetSuite saves the file layout and displays it in view mode.

  14. (Optional) If you want to make the file generation dependent on a requirement or adapt the output under certain conditions, you can create parameters for the file layout.

    For more information, see Creating File Layout Parameters.

Related Topics

General Notices