Configure the Record Management policy

Incorrectly editing Vera policy files can cause the system to become unresponsive or to fail. If you are unsure or need guidance, please reach out to Tricentis Support before making changes to the policy files.

To add additional record data fields or to change the existing record types in Vera, you must edit the Record Management policy file on the Vera server.

Add a record data field to Vera

To add a record data field to Vera, follow these steps:

1. Access the Record Management Policy.json file in the Policies directory of the VERA Server Installation Directory.

2. Edit the file and find the record type to be modified.

3. Within the record type object, locate the Fields array.

4. Add new field objects with "Name" and "Is Data" keys.

   Copy

   "Fields": [
       {
           "Name": "Category",
           "Is Data": "Yes"
       },
       {
           "Name": "Compliance Domain",
           "Is Data": "Yes"
       },
       {
           "Name": "Action Plan",
           "Is Data": "Yes"
       }
   ]

   Make sure to enclose each key and value in plain double quotes and use a comma to separate each field object from the others in the list. 

Update a record data type in Vera

To update a record data type in Vera, follow these steps:

1. Access the Record Management Policy.json file in the Policies directory of the VERA Server Installation Directory.

2. Edit the file and find the record type to be modified.

3. Within the record type object, locate the Definitions array.

4. Update the "Item Types", "Singular Name", and "Plural Name" keys.

   Copy

   "Definitions": [
       {
           "Systems": ["JIRA"],
           "Aliases": [
               {
                   "Policy Field": "ID",
                   "System Field": "Req ID"
               }
           ],
           "Item Types": ["Bug"],
           "Singular Name": "Bug",
           "Plural Name": "Bugs",
           "Ownership Description": "created",
           "Content Originator": "Author"
       }
   ],

Order data fields for a record type

To define a specific order for data fields for a record type, follow these steps:

1. Download the records management policy that you want to update.

2. Open the Record Management Policy.json file in the Policies directory of the VERA Server Installation Directory.

3. Find the record type to modify.

4. Within the record type object, locate the Fields array.

5. Add an Order property to every field. If you skip fields, those automatically come last. If you skip multiple fields, Vera sorts them randomly.

   For example, this code snippet defines the order of fields in the Jira Details as follows: Summary, Description, Issue Type, and Components.

   Copy

               {
                   "Name": "Jira Issue",
                   "Definitions": [
                       {
                           "Systems": [
                               "JIRA"
                           ],
                           "Item Types": [],
                           "Constraints": [],
                           "Aliases": [
                               {
                                   "Policy Field": "ID",
                                   "System Field": "Req ID"
                               }
                           ],
                           "Singular Name": "Issue",
                           "Plural Name": "Issues",
                           "Ownership Description": "created",
                           "Content Originator": "Author",
                           "Hard Lock Rules": [],
                           "Details": []
                       }
                   ],
                   "Fields": [
                       {
                           "Order": 2147483647,
                           "Name": "Components",
                           "Is Data": true,
                           "Format": ""
                       },
                       {
                           "Order": 2,
                           "Name": "Description",
                           "Is Data": true,
                           "Format": "Jira Wiki"
                       },
                       {
                           "Order": 1,
                           "Name": "Summary",
                           "Is Data": true,
                           "Format": ""
                       },
                       {
                           "Order": 3,
                           "Name": "Issue Type",
                           "Is Data": true,
                           "Format": ""
                       }
                   ],
                   "Default Route Template": null,
                   "Allow Verify Signatures": true,
                   "Author": null
               },

Deploy Record Management policy

For information on how to deploy Record Management Policy, see Manage policy files.