View Documents

All documents used in 4P are stored in the catalog. These documents can be used as process inputs, macro inputs, L0 data metadata or macro / module documentation.

To access the list of documents click on the Catalog item of the 4P main menu.

List of documents

The documents are listed in a table ordered by ID. The table shows the following columns (see the figure below):

• Name: this is the name of the document

• Format: this is the format of the document (TXT, CSV, JSON, PDF, etc.)

• Size: this is the size of the document in bytes

• Category: this is the category of the document which can be Calibration, Deep learning model, Documentation, Measure and Setting

• Vector: this is the vector(s) this document is compatible with (only vector compatible documents will be proposed to the selection)

• Organization: this is the organization (or PHIS installation) which is the owner of this document

• Status: this is the status of the document, either published or archived

Note

Documents are filterable by Name, Format, Category, Vector, Organization and Status.

Details of a document

Click a row of the table to open the details page of the corresponding document.

This page shows additional information about the document, such as its description, visibility and access right ; but also its author, creation date and modification date.

The Preview box displays the content of the document if it is readable (TXT, CSV, JSON and PDF formats are readable) and if access right allows it.

Finally the Use box indicates where and how the current document is being used in 4P.

Select a version: If the current document exists in several versions, the latest version is displayed by default. However it is possible to visualize the details of a specific version by using the versions selector.

If the access right allows it, the current document can be downloaded on the user’s local computer using the Download button.

If the access right allows it, the current document can be deleted using the Delete button. Notice that only documents that are used nowhere can be deleted. If you wish to delete a document that is used somewhere in 4P, use the Archive button.

If the access right allows it, the current document can be archived using the Archive button. An archived document is still accessible but is not proposed anymore for selection and is hidden by default from the list of documents.

Edit a document

Use the Edit button from the Description box to edit the general information of the current document, namely its Name, Description, Version label, Vector(s), Category, Visibility and Access right. All the versions of the documents wil be altered.

Note

Each version of the document has its own description and version label, so the edit action will alter only the description and label of the current version.

Create a new version of a document

Whenever the document is updated it is recommended to add a new version of it in 4P. To do so, click the New version button. This opens the following dialog:

Fill up the information (version label and description), upload the corresponding file and click Validate. After the file is fully uploaded, the new version is created.

Hint

To learn more about the version label, visibility and access right properties, please refer to the next section Create a document.