Create a Document

To add a new document in the catalog of 4P, click the Load a document button from the documents list page (see figure below).

../_images/create-document-button.png

This opens the following dialog where the document information can be filled:

../_images/create-document-popup.png

  • Name: Give the document a clear, consize and readable name. Its length is limited to 50 characters.

  • Description: Describe the purpose of the document and give any useful information users might need.

  • Version label: Optionally give a version label to quickly indicate what this version is about (it can be a date, a campaign, an experiment, etc.). This label will help users make a decision on which version of the document to use. By default the version label will be v1.

  • Compatible vectors: Select the vector(s) this document should be compatible with. Only vector compatible documents will be proposed for selection.

  • Visibility: Select the visibility of the document between the following choices:

    • Internal to my organization: Only the users of the same organization as me will be able to see this document

    • Common to Phenome organizations: Users of all Phenome organizations (with a PHIS account) will be able to see this document

    • Extended to organizations outside Phenome: All 4P users will be able to see this document

  • Access right: If the visibility is extended then choose the access right among the following choices:

    • Restricted: Users outside of Phenome will only be able to visualize this document (no download nor preview will be available)

    • Complete: Users outside of Phenome will be able to visualize and download this document

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

Finally select a File from your local computer and click Validate.

If all the fields are correct and after the file has been fully uploaded, the new document is created and the details page opens.

Important

Make sure not to create hastily a new document in the catalog and consider the following alternatives:

  • Does the document already exist and is up to date? In this case no document needs to be created, simply use the existing one.

  • Does the document already exist but is not up to date? If so just create a new version of this document.

Note

To create a new version of an existing document refer to the section Create a new version of a document