Documents

About Documents

Document definitions can only be added or edited by importing a CSV file.  Document definitions can however be deleted directly from the Documents form.

Generally the process to update the Document definitions would be:

• Export the existing definitions to a CSV file
• Modify the definitions by importing the CSV file into a spreadsheet
• Export the definitions from the spreadsheet back to a CSV file
• Import the CSV file from the Documents form.

Exporting Documents

The exported file has the following fields:

• LineName
  This is a compulsory field.  An entry is required for each Line for which the Document is required.  There is no “ALL” option for LineName.
• ProductCode
  This is the primary field for associating a Document with a Product.  If the ProductCode field is empty then the ProductName field will be used to associate the document with a Product.  This field can contain “ALL”.  If the field contains “ALL” then the Document will be displayed for all Products.
• ProductName
  This field is only used if the ProductCode field is blank.  The behaviour is the same as the ProductCode field.
• Activity
  This is a compulsory field.  This field can contain the name of an Activity or “ALL”.  If an Activity name is entered then the Document will only be available when that Activity is selected.  If “ALL” is entered then the Document will be displayed regardless of which Activity is selected.
• DocumentURL
  This is a compulsory field.  This is the URL for the Document.  The document is expected to be a PDF file.  The URL must be a valid file path, including the name of the Document.
• DisplayName
  This is a compulsory field.  This is the name used to reference the document in the Factory Client application.
• Description
  This is an optional field.
• DocumentID
  This is an optional field that is not used by esCollate.  This field is solely for use by the customer.