Permissions and license

Your ability to access and use Document features depends on the permissions assigned to your user account, which may be tied to the user role(s) assigned to you by the system or project administrator. The license you are currently using may also affect your ability to use some Document-related features. This section provides some specifics that may help if you find you cannot access or use some feature or perform some operation.

Word Import and Round-trip

Word Import:

  • The Import action is only available if you have permission to create Documents and Work Items and you are using either a Polarion ALM or Polarion Requirements License.

  • Even if you have user permissions as above, you can only save import rules if you have write permission for the relevant repository location, i.e. .polarion/tracker/import_configurations/word/.

Word Round-trip:

  • You can invoke Word Round-trip > Export when you have read-only permission for a Document provided you are using a Polarion Requirements or Polarion ALM license.

  • To import changes in a modified exported Word document, you need to be using a Polarion Requirements or Polarion ALM license, and you need to have write permission for the Subversion repository, and also Polarion permission to modify the Document.

Document features and operations

Polarion provides project managers the ability to exert control over who can do what with a Document. This is accomplished by configuring Document permissions in global and/or project administration. This section describes the Document permissions that can be assigned and what they allow users who have the respective permissions.

Note:

The MODIFY permission for Documents implemented in Polarion versions prior to version 2014 SR2 is replaced by the MANAGE, MODIFY FIELDS, MODIFY CONTENT permissions. If MODIFY was granted, the 3 new permissions will be granted after updating. Likewise, if MODIFY was denied, the new permissions will also be denied. The net outcome is that users should not experience any difference in what they are able to do with Documents.

See also: Dynamic Roles for Documents.

Document access and content:

READ

Allows user to read Document content and view Document information is Document sidebar panels.

CREATE NEW

Allows user to create new Documents, provided that user is also granted MANAGE, MODIFY FIELDS, and MODIFY CONTENT permissions.

MODIFY FIELDS

Allows user to modify Document fields (Status, for example) and custom fields shown in the Document Properties sidebar panel.

Granting of the MANAGE and/or MODIFY CONTENT permission for Documents does not grant the permission to MODIFY FIELDS.

MODIFY CONTENT

  • Add/remove/move Work Items, including Headings and referenced Work Items, to/from/within the Document structure using the Document Editor.

  • Move Work Items, including Headings and referenced Work Items, to/from the Document Structure via the Move Work Item dialog.

  • Fields that appear in the Content column of the Configure Work Item Presentation dialog (i.e. Title, Description, and Test Steps).

  • Add, modify, or remove Document attachments.

  • Add, modify, or remove attachments to Work Items of all types contained in the Document (including Headings), provided user also has permission to modify Work Items in the project.

  • Add, edit, or delete plain text in the Document. That is, text which is not contained in Work Items.

Additional notes on this permission:

  • Users who are denied this permission, but who are granted the COMMENT and/or RESOLVE COMMENT permission, can insert comments into the Document and/or resolve comments in the Document (in text and Work Items).

    Warning:

    If MODIFY CONTENT is granted, do not also explicitly grant COMMENT or RESOLVE COMMENT permissions. The granted user will automatically be granted them.

  • This permission does not apply to referenced Work Items in the Document.

  • Granting this of permission does not grant permission to MODIFY FIELDS.

  • Granting of the MANAGE permission for Documents does not grant permission to MODIFY CONTENT.

"Manage" allows user to:

  • Configure default Work Item type(s) and Work Item presentation for the Document.

  • Change the Document type (if the Document types feature is enabled).

  • Rename or move the Document.

  • Upload a round-trip template.

  • Configure Document outline numbering.

  • Enable/disable Auto-suspect for Document Work Items.

  • Delete comments from a Document.

User must also have the MODIFY and MODIFY-FIELDS permissions for Documents.

DELETE

Allows the user to delete Documents.

Document Comments:

COMMENT

Allows:

  • Create new Document comments,

  • Reply to Document comments.

RESOLVE COMMENTS

Allows user to resolve Document comments.

Permissions for Document actions

The following table lists the permissions required for different Document-related actions, and the capabilities/features available when a user has the listed permissions.

Action: View Document objects in user interface

Required Permissions:

  • READ Document,

  • READ Work Item.

Note:

  • Documents appear in Navigation Documents and Pages topic.

  • Documents are listed in space Index pages and overviews.

  • Documents can be opened (e.g. from links).

Action: Read a Document

Required Permissions:

  • READ Document

  • READ Work Item

Note:

  • Documents are read-only.

  • Round-trip and PDF exports will work.

Action: Create a new Document

Required Permissions:

  • READ Document

  • MODIFY Document

  • CREATE Document

  • READ Work Item

  • MODIFY Work Item

  • CREATE Work Item

Note:

  • Option to create new Document appears in space Index pages and space Overview.

  • Import for Microsoft Word is available.

Action: Modify a Document

Required Permissions:

  • READ Document

  • MODIFY Document

  • CREATE Work Item

  • READ Work Item

  • MODIFY Work Item

Note:

  • Modify Document body text.

  • Modify Work Item description and fields.

  • Mark/paste OR unmark/cut/or recycle bin Work Items.

  • Mark/paste OR unmark/cut/delete Headings.

    If you want to control the deletion of headings via the DELETE permission, then set the headingsObeyDeletePermission property to true.

    (Otherwise it's enough to have the "MODIFY CONTENT" permission.)

  • Round-trip import is available.

Action: Delete a Document

Required Permissions: Same as for Modify a Document, plus DELETE Document

Notes:

Note:

  • Option to delete Documents appears on space index pages.

Action: Re-import changes in exported round-trip (Word) document

Required Permissions: Same as those for Modify a Document

Notes:

Note:

  • Changes are imported if there are no errors or invalid data.