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

Creating File Layout Parameters

You can use file layout parameters to set conditions for the generation of electronic data files. These conditions can block the file generation or adjust the output under certain circumstances.

For example, you can limit file generation to accounts that have a specific NetSuite feature enabled, or skip part of a SuiteQL query.

To create a file layout parameter:

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

  2. Next to the file layout to which you want to add a parameter, click View.

  3. Click the Parameters subtab.

  4. Click New File Layout Parameter.

    A new record opens.

  5. In the Name field, enter a name for the parameter.

  6. In the Field Type field, select the type of the field you want to create for this file layout parameter.

  7. If this parameter is necessary to generate the file, check the Set as Required box.

  8. If you chose select or multiselect as the field type, in the Data Source field, do the following:

    1. If the list or record you want to use as a data source for the parameter appears in the field, select the list or record.

    2. If the list or record doesn't appear in the field, select -New - to create a data source for file layout parameter record.

      A popup window appears.

      1. In the Name field, enter the name of the record or list.

      2. In the Data Source ID field, enter the ID of the record or list you want to use as a data source.

        Tip:

        You can use the Records Catalog to find the IDs of records and lists. For more information, see Records Catalog Overview.

      3. In the ID of the Column to Store, enter the ID of the column whose value you want to store.

      4. In the ID of the Column to Display, enter the ID of the column you want to use to populate the select or multiselect field.

        For example, if your data source is the accounting books list, you can choose the Name column (ID "name") as the display column. Then, in fields that use this data source, the system lists the accounting book names as options.

      5. Click Save.

        NetSuite fills in the Data Source field with the record you created.

  9. (Optional) If you want the parameter to appear only in accounts with a specific NetSuite feature enabled, in the Required Feature field, do the following:

    1. If the feature you want to select appears in the field, select the feature.

    2. If the feature doesn't appear in the field, select -New - to create a feature for file layout parameter record.

      A popup window appears.

      1. In the Name field, enter the name of the feature.

        You should enter the name of the feature as it appears on the Enabling Features page. For more information about features, see Enabling Features.

      2. In the Field ID of the Feature, enter the field ID of the feature that you want to associate to the file layout parameter.

        Tip:

        To find a feature's field ID, on the Enable Features page, click the feature name. For example, the field ID for Full Multi-book Accounting is fullmultibook. For more information, see Show Internal IDs Preference.

      3. Click Save.

        NetSuite fills in the Required Feature field with the record you created.

    If the required feature isn't enabled in the account, the system ignores the parameter.

  10. In the Parameter Name for Queries field, enter the name you want to use to reference this file layout parameter in queries.

  11. If you want to run only part of the query under certain conditions, do the following:

    1. In the Delimiter for the Start of Comments field, enter the characters that mark the start of the comment section.

      In NetSuite, you can write queries that retrieve information from multiple columns of a dataset, but if a feature isn't enabled, some columns may be missing. If the query tries to read a column that doesn't exist, it throws an error.

      To avoid this problem, you can use delimiters to insert the part of the query that relies on specific NetSuite features in a comment. If the feature's enabled, NetSuite runs the whole query and ignores the delimiters. If it isn't, NetSuite treats that part as a comment and skips it.

    2. In the Delimiter for the End of Comments field, enter the characters that mark the end of the comment section of the query.

  12. In the String Key for Field Help field, enter the key for the string you want to display as field-level help for this parameter.

    You can use translation collections to add field-level help for this parameter in additional languages. Field-level help appears when users click the parameter label.

    Create a string for the help in a translation collection and, if you want, add the translations. After you create the string, enter the string key in this field to associate it with this parameter. For more information, see Working with Translation Collection Strings.

  13. Click Save.

Related Topics

General Notices