User-defined export, import, and bulk editing > Format Specification files

Create a format specification file

The format specification file defines the object to export and import, including the order of the data fields. The specification also defines the comment character, separator character, and the use of blank lines and columns. When you export data the output .txt files follow the field order specified in the .fmt files.

Note

Format specification files from a previous release, both those provided with the software and those that you have created, should be reviewed before using them in this release of DeltaV software. The fields available for bulk editing configuration objects may change between releases. The content of sample format files may also change.

To create or modify a format specification file, follow these steps:

  1. From DeltaV Explorer, select FileFormat Specification. Then, select New or Edit.

    If you selected Edit, select a format file to edit from the Open Format Specification dialog, then click Open.

    The Format specification - General dialog opens. 

  2. Select or verify the filename of the format specification file you are editing. Then, set the other options on the dialog as desired. 
  3. Click Next.
    The Format specification - Select fields dialog opens. 
  4. Set or verify the Object type.

    For the following object types a Subtype field appears:

    • Card object - Browse to an instance in the database of the card type you want to bulk edit.

    • Channel object - Subtypes are channel types: 100 mv input, discrete input, discrete output, and so on. The channel type must be valid for the card type you are bulk editing.

    • Formula object - Subtypes are formulas in Procedures, Unit Processes, or Operations.

    • HART Device object - Subtypes are Non-SIS HART device (Wired), Non-SIS HART Device (Wireless), SIS HART Device (Wired).

    • Module object - Subtypes are either module templates or modules based on module templates.

    Module objects require that you enter a subtype so that information on the blocks within the module are exported and imported. If you do not correctly specify the module subtype, importing creates empty modules. 

    For other object types specify a subtype if you need to export information specific to the subtype. 

    The fields that appear in the Field names area depend on the object type and subtype selected.

    Note that for each of the object types, there are required fields (that is, fields the import file must contain to be successfully imported). 

    The tables in the sections that explain how to bulk edit various configuration objects define the valid syntax and field values for the transferable objects. Each table has three columns:

    • Field -- The field name as it appears in the Format Specification wizard and exported data files

    • Valid Values -- The syntax of valid field values or a list of valid values

    • Required for Import -- Indicates whether a field must be included in the format specification file and contain a value in the bulk edit spreadsheet for the data to be successfully imported

    Note

    When you are editing the text files do not enclose field values in quotes.

    Note

    You can include fields that are not required for import in your format files. However, for some objects some fields are interdependent. That is, if a field exists in the format and text import files, other related fields must also be included and must contain valid values in the import file or the import fails.

  5. Choose the fields to include in the format file.
    Note

    Because Excel limits the number of columns in a spreadsheet, you cannot select more than 255 fields. If your module is large or complex, select only the fields you must be able to bulk edit. 

    You must at least include the fields that are required for import. You can include other fields you need. Note that some objects have object-level parameters and alarms that you can include in the format specification file if you need to.

  6. Click Next.
    The Format specification - Field order dialog appears. 
  7. Order the fields if you desire.

    If you are creating the format specification to import an existing data file, order the fields and insert skip columns as required to match the existing data. Use skip columns as placeholders if your import file contains data that you do not want or need to import. 

    The number and order of fields in the format file must match the import data file exactly. If they do not match, importing the data results in errors.

  8. Click Next.

    The Format specification - Must exist dialog appears. Depending on the object for which you are creating a specification file, there may be one or more fields listed in this dialog.

    Select a field to allow imports only when data in the selected fields already exist in the configuration database.  

  9. Click Finish.
    The software saves the format file.