Use a Document

Documents present in the Catalog of 4P can be used as:

  • Process input metadata;

  • Macro input metadata;

  • L0 data metadata;

  • Macro documentation;

  • And module documentation.

Note

The current section shows how to use a document as a Process input metadata, but the global behavior is similar for the other use cases.

Select an existing document

The document selector appears when a document from the catalog can be selected (see the figure below in the case of process input parameters):

../_images/use-document-selector.png ../_images/use-document-select-button.png

Click the Select button to select an existing document from the catalog. This opens the following dialog showing the compatible documents:

../_images/use-document-select-popup.png ../_images/use-document-select-version.png

Click the Select button at the end of the row of the corresponding document then choose the desired version.

Hint

The version label of each version of the document is displayed in the selector. The author of a document will ensure that the label is explicit.

This will display the selected document name in the field and a link to the details page of the document is proposed (see figure below).

../_images/use-document-selected.png

Create and select a document

../_images/use-document-add-button.png

Click the Add button to create a new document in the catalog and use it directly in the field. This opens the dialog for document creation:

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

Hint

Refer to the Create a document section to learn more about how to create a new document.

Clear a document selector

../_images/use-document-delete-button.png

When a document is selected, click the Erase button to clear the selection field.