Enter Basic Document Details

Enter the basic details of the document in the tab provided.

Main Tab

Basic document details are entered in the upper half of the Main tab:

1. Enter the number of the document in the Document Number field. The filename and path of the document is displayed in the Document Publishing File field once the document is saved.

   Note: The file name will be the same as the document name.

2. Select the file type from the Format list: PDF, Excel, or Zip. The Zip format is a collection of Excel files, one for each document sheet, in a .ZIP file. The PDF and Excel formats are single, multi-page files that include all the document sheets.

3. To select the datasheet that will be used as the front page for the document, click the Select button next to the Front Sheet field. The DataSheet Catalog window is displayed.

   

4. The Datasheet Catalog window lists all those datasheets from the Catalog of the Front Sheet type. To create a new front sheet datasheet, click New. The Catalog Information window is then displayed, in which details of the new datasheet can be entered. For further details, refer to Add a New Datasheet Definition.

5. To select a datasheet, either double-click on it, or highlight it and click Select. Once a front sheet datasheet is selected, it is displayed in the Front Sheet field. Click the adjacent Clear button to de-select it and clear the field.

6. To generate an index sheet for the document, click Create next to the Index Sheet field. A standard index sheet is then automatically generated for the document and is displayed in the Index Sheet field. The Create button is then replaced by a View button. Click View to open the index sheet in the Custom Report window from which it can be edited if required. For further details, refer to Reports. Click the adjacent Clear button to delete the index sheet.

7. To select the datasheet that will be used as the summary page for the document, click the Select button next to the Summary Sheet field to display the Datasheet Catalog window. To create a new Summary Sheet datasheet, click New. The Catalog Information window is then displayed, in which details of the new datasheet can be entered. For further details, refer to Add a New Datasheet Definition. Follow the same procedure as for front sheets, as described above.

8. To select a datasheet, either double-click on it, or highlight it and click Select. Once a summary sheet datasheet is selected, it is displayed in the Summary Sheet field. Click the adjacent Clear button to de-select it and clear the field.

Revisions Tab

Document revisions are added, edited and deleted using the Revisions tab.

Note: Revisions can also be added, edited and deleted from the Document List window.

To add a new revision:

9. Click Add to display the Revision Entry window.

   

10. Complete the fields as required.

    Note: The text field descriptions displayed are dependant on the settings made in the Preferences window. For further information, refer to Instrument Engineer Options and Setup.

    • When creating a new revision, leaving the Revision No field blank will cause AVEVA Instrumentation to use the next revision number. for example, if the current revision is "A", then the next is "B" or if current revision is "2", then the next is "3" etc.

    • The Date field defaults to the current date, but a different date may be selected if required.

    • The Description field contains a list of all previously created revision descriptions. Add a new description by entering any required description. Any new descriptions will be available for future revision entries.

11. Once a revision is created, it is listed in the Revisions tab.

12. To edit a revision, select it and click Edit to display the Revision Entry window. Change the revision details as required, and click Save.

13. To delete a revision, select it and click Delete. The revision is then deleted.

    Note: New revisions, changes to revisions and deletions of revisions are not saved to the Project Database until the Save button is clicked.

Title Tab

Enter the document title text in the fields in the Title tab.

User Fields Tab

Enter any User/Project specific text in the fields in the User Fields tab.

Notes Tab

Enter any notes or remarks in the fields in the Notes tab.