Documents

Function

The documents module in Proplanner allows the user to add different documents to all component, process, plant and resource nodes. The documents can be added as a Global, Local, and Version document.

A Global document is added to a node and is available for every occurrence of that node.

A Local document is added to the link between a node and its parent, so it’s available for every occurrence of that node under that parent.

A Version document is added to the version of a node, so it’s available for every occurrence of that version of the node.

The following table shows the type of documents that can be added to the different nodes.

Attachment types for documents

Open

Select the document that has to be viewed and click the ‘Open’ button (or right click on the document & select ‘Open’)

The document will be opened in the Windows default application and is in read-only mode

Figure 1:  Documents Tool Bar

1: Check Out

Purpose: to make changes in the document.

Select a node in the tree and click on the ‘Check Out’ button (or right click the node and select ‘Check Out’)

Make changes on the document (it is opened in rewritable type).

Click ‘Save’ button to save the changes

2: Check In

Purpose: to update the latest version of the document into a new version.

Select a node in the tree and click on the ‘Check In’ button ( or right click the node and select ‘Check In’)

3: Undo Check Out

Purpose: to undo check-out and revert to the latest version before changes.

Select a node in the tree and click on the ‘Undo Check Out’ (or right click the node and select ‘Undo Check Out’)

4: Importing Document

Select a node in the tree and click on the ‘Import’ button (or right click in a blank area in the documents list section and select ‘Import’).

Note: The user has an option to set the type of document being added. This can be done by setting the preference “Show Attachment Type Dialog” from the Edit -> Preferences menu. The user would see the Import document screen and choose the type of document to be added, global, local or version. By default the documents are added as Global documents.

The user would select a type and browse for the particular document.

5: Exporting Document

Select the document that has to be exported from the list and click the ‘Export’ button (or right click on the document & select ‘Export’)

A dialog showing the directory structure is displayed. Select the directory where you want to save & click ‘Save’

You can only export one document at a time

6: Delete

Right click on the document that has to be deleted and select ‘Delete’. Hit ‘OK’

Properties

Right click on the document to view its properties and select ‘Properties’

There are four different status of a document: Checked-Out, Checked-In, Locked and Unknown.

Checked-Out Status

It is the status of a document that has just been checked-out

Any user can make changes on the document in this status

Checked-In Status

It is the status of a document that has just been checked-in or after a user does undo check out

User can open the copy of the document but can not make any changes on the document

Locked Status

A document becomes locked if there has been other user that tried to make changes (‘Check Out’) on it

User can open the copy of the document but can not make any changes on the document

Unknown Status

In case of document error, the server is not able to load the document file of a node

You need to refresh the node by clicking ‘Refresh’ button