Output Document Format Rules: Version 101

The output document is created by scripting within the CIMPLICITY environment.

The order is: Version Number; NULL Character; Header; NULL Character; Carriage Return and Line Feed; Content

Document format rules

  1. Unique Output Document Name

    Each output document must have a unique name in the directory in which it is created. Each output document is created in a specific directory. As a result, there will be instances where another file already exists in the directory. Giving each output document a unique name will prevent the overwriting of output documents.

  2. Version Number (in header)

    The first characters in the output document must be an ASCII representation of the version number.

    • The version number is currently 101.
      Note: If a change is made the version number will be incremented.
    • The version number will be followed by a NULL character.
  3. Header

    The header:

    • Must immediately follow the version number and NULL character.
    • Will be an XML data structure that contains the destination filename and extra commands that may be required for:
      • HTTP or network delivery.
      • FTP delivery.
    • The destination will be NULL terminated, followed by a carriage return and line feed.
  4. Content
    All content to deliver to the remote is located after the:
    • Version number
    • Destination file name (included in header)
    • Separating carriage return
    • Line feed
    Note: The version number and destination file name will be removed from the document before it is sent to the remote location.
Document Delivery Rule Description
1
2
3 Header
4 Content