Documents

Every domain can have a set of related documents containing various kinds of information such as analyses, saved reports, and so on.

All documentation relating to a specific domain can be found under its Works folder. Clicking on a document name will display its detail page where you will be able to edit or download the file.

Document detail page

Adding a new document

To add a new document, follow these steps:

  1. Navigate to Workspace > All Domains > domainName > Works.
  2. In the right working area, click Add > Add document.
  3. Fill in the form that appears.
  4. When done, click Save.

Adding a new document to the Works folder

In the form, set the following parameters:

  • Name: The name of the document.
  • File: Upload the document file.

    Note

    • Ensure that you do not upload file names beginning with '.' or '/' as they can result in path traversal
    • BMC recommends you to use antivirus to check for the upload of malicious files
  • Version: Choose a version number (from 1 to 10).
  • Options: Set the status of the document, choosing from the available options (see Document status for details):
    • Editable document for this domain, draft version
    • Editable document for this domain, final version
    • Read-Only document for this domain
    • Template document (available for all domain)
  • Access mode: Choose one of the available options:
    • Public document: Every user that can access the container domain can view and modify it.
    • Public read only document: Every user that can access the container domain can view it, but only the owner can modify it.
    • Private document: Only the owner (creator) of the document can access and modify it
  • Folder: choose the folder where the document will be stored from the drop-down list; available choices depend on the selected Access mode, because some folders might be private.

Document status

The different actions a user can perform on a given document are limited by its status, as detailed in the following table.

Status

Description

draft

The document can be downloaded in read-only or editing mode; the former doesn't allow the user to alter the document, while the latter lets him modify it thus becoming its owner and changing its status to open.

open

Upon downloading a document in editing mode, the user becomes the owner of the document and earns the right to modify it, while other users can download it in read-only mode. The owner of a document is the only one who can upload a modified copy, making it available to other users.

read-only

Users can download and view the document, but cannot modify it.

final

The document can be downloaded in read-only or editing mode; the former doesn't allow the user to alter the document, while the latter lets him modify it thus becoming its owner and changing its status to open. The only difference between the final and draft statuses is that draft documents should be revised carefully, while final ones do not require further revisions.

template

The document is available to all applications and groups, albeit in read-only mode.

Was this page helpful? Yes No Submitting... Thank you

Comments