Skip to content

Class: metadata

Within the Process Monitor, Process Views show the time it takes for object records or documents to complete a specific process.

AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
descriptionType: String
Max length: 255
A description of this Process View, displayed in the Process Monitor UI.
processType: String
Required
Max length: 1500
An active object or document lifecycle.
subprocessType: String
Max length: 1500
Multi-value
An object type that uses the selected object lifecycle, or a document type, subtype, or classification that uses the selected document lifecycle.
editorsType: String
Max length: 1500
Multi-value
The user(s) and group(s) in the Editor role for the Process View. For example, Group.business_administrators__v.
viewersType: String
Max length: 1500
Multi-value
The user(s) and group(s) in the Viewer role for the Process View. For example, User.vern@myvault.com.
ownersType: String
Max length: 1500
Multi-value
The user(s) and group(s) in the Owner role for the Process View. For example, Group.business_administrators__v, User.vern@myvault.com.
settingsType: XMLString
Max length: 32000
An XML String describing the Process View.
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
typeType: String
Max length: 1500
The type of chart, for example, line or column.
metricsType: String
Max length: 1500
The Processmetrics to visualize in the chart. For example, Processmetric.cycle_time_average__sys.
grouping_fieldType: String
Max length: 1500
The field value by which to group data in the chart. For example, pm_entered_start_date__sys.
second_groupingType: String
Max length: 1500
This attribute supports future functionality and cannot be used at this time.
sortType: String
Max length: 1500
How to order data in the chart, either asc for ascending or desc for descending.
sort_fieldType: String
Max length: 1500
The field value used to sort data in the chart. For example metric.volume_records_created__sys.
orderType: NumberThe order in which the chart appears in the Process Monitor UI. For example, 3.
OperationSupport
Create
Recreate
Alter
Drop
Rename
Describe
Generate Recreate
Queryable