Classes
- Action
- ActionOptions
- ActionResult
- ActionResultValue
- AdditionalAttributes
- AdvancedActionOption
- AdvancedAutoArchiveOption
- AdvancedConfigurationOption
- AdvancedMeasureOption
- AdvancedPurgeOption
- AdvancedQueryOption
- Attribute
- AttributeDefinition
- AttributeDefinitions
- Audit
- AutoArchiveOptions
- AutoArchiveResult
- AutoArchiveStatus
- AverageMeasure
- BaseAuditInformation
- BaseChartOptions
- BaseChartQuery
- BaseChartResult
- BaseComment
- BaseEntryAttribute
- BaseQueryOptions
- BasicMeasure
- BasicMeasureId
- BasicMeasurePeriod
- BasicValueMeasure
- BigDecimalEntryAttribute
- BigIntegerEntryAttribute
- BooleanEntryAttribute
- Case
- CaseAudit
- CaseAuditEntry
- CaseAuditReportOptions
- CaseDetails
- CaseReferences
- ChartCategories
- ChartCategory
- ChartData
- ChartDataOptions
- ChartDataQuery
- ChartDataRequest
- ChartDataResult
- ChartDataSet
- ChartOptions
- ChartQuery
- ChartRequest
- ChartResult
- Comment
- CommentAudit
- CommentAuditEntry
- CommentedAudit
- CommentedReportOptions
- CommentReference
- CommentReportOptions
- CommonAuditEntry
- Component
- Components
- Configuration
- ConfigurationArea
- ConfigurationEntries
- ConfigurationEntry
- ConfigurationOptions
- ConfigurationUpdateDetails
- ConfigurationXML
- ConfigurationXMLDocument
- DateEntryAttribute
- DocumentRoot
- DoubleEntryAttribute
- Environment
- Event
- EventBatch
- FilterAttribute
- FilterAttributes
- GenericAttributes
- GenericResult
- GetAttributeOptions
- IntegerEntryAttribute
- IntMeasure
- LongEntryAttribute
- LongMeasure
- MapConfigurationEntry
- MapConfigurationEntryValues
- Measure
- MeasureDuration
- MeasureEntry
- MeasureId
- MeasureOptions
- MeasurePeriod
- Message
- PrimitiveConfigurationEntry
- ProcessDurationMeasure
- ProcessDurationMeasureEntry
- ProcessDurationMeasurePeriod
- ProcessDurationMeasures
- ProcessInstanceAudit
- ProcessInstanceAuditEntry
- ProcessInstanceAuditReportOptions
- ProcessInstanceReference
- ProcessTemplateId
- ProcessTemplateIdIdentifier
- ProcessTemplateIds
- ProcessTemplateMeasure
- ProcessTemplateMeasureEntry
- ProcessTemplateMeasurePeriod
- ProcessTemplateMeasures
- ProcessTemplateNameIdentifier
- ProcessTemplates
- PurgeOptions
- PurgeStatus
- Query
- QueryIdentifier
- QueryInfo
- QueryOptions
- QueryParameter
- QueryPayload
- RegisterAttributeOptions
- RegisterMessageOptions
- ReportOptions
- RequiredChartAttributes
- RequiredExtendedDataOptions
- ResourceId
- Result
- ResultEntry
- SortElement
- StringEntryAttribute
- WorkItemAudit
- WorkItemAuditEntry
- WorkItemAuditReportOptions
- WorkItemCommentReference
- WorkItemFullReference
- WorkItemMeasure
- WorkItemMeasureEntry
- WorkItemMeasurePeriod
- WorkItemMeasures
- WorkItemReference
Members
(static, readonly) AttributeGroup :string
A representation of the literals of the enumeration 'Attribute Group',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
PRIMARY |
string | |
GENERIC |
string | |
EXTENDED |
string |
(static, readonly) AttributeType :string
Enumerated value defining the AttributeTypes for specific AttributeDefinitions. One of: DATE, INT, STRING, BOOLEAN, LONG or DOUBLE.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
DATE |
string | |
INT |
string | |
STRING |
string | |
BOOLEAN |
string | |
LONG |
string | |
DOUBLE |
string | |
BIGDECIMAL |
string | |
BIGINTEGER |
string |
(static, readonly) AveragesMeasureType :string
Enumerated value defining the type of an AverageMeasure. One of the following:
- PROCESS_TOTAL: Total number of instances of this process template started during this ProcessDurationMeasurePeriod.
- PROCESS_TOTAL_TIME: Total time that instances of this process template were active during this ProcessDurationMeasurePeriod.
- PROCESS_AVERAGE_TIME: Average time that an instance of this process template was active during this ProcessDurationMeasurePeriod.
- WORKITEM_TOTAL: Total number of work items generated by this process template that were active during this ProcessDurationMeasurePeriod.
- WORKITEM_ACTIVE_AVERAGE_TIME: Average time that a work item generated by this process template was active during this ProcessDurationMeasurePeriod. A work item is defined as being active between the time of the event when it first entered the OFFERED state and the time of the event that it entered the COMPLETED state, disregarding any intermediate states.
- WORKITEM_ACTIVE_TOTAL_TIME: Total time that work items generated by this process template were active during this ProcessDurationMeasurePeriod. A work item is defined as being active between the time of the event when it first entered the OFFERED state and the time of the event that it entered the COMPLETED state, disregarding any intermediate states.
- WORKITEM_WAIT_TOTAL_TIME: Total time that work items generated by this process template were waiting during this ProcessDurationMeasurePeriod. A work item is defined as waiting between the time of the event when it first entered the OFFERED state and the time of the event when it first entered the OPENED state.
- WORKITEM_WAIT_AVERAGE_TIME: Average time that a work item generated by this process template was waiting during this ProcessDurationMeasurePeriod. A work item is defined as waiting between the time of the event when it first entered the OFFERED state and the time of the event when it first entered the OPENED state.
- WORKITEM_ACTION_TOTAL_TIME: Total time that work items generated by this process template were being actioned during this ProcessDurationMeasurePeriod. A work item is defined as being actioned between the time of the event when it first entered the OPENED state and the time of the event that it entered the COMPLETED state - that is, when the user submitted the form.
- WORKITEM_ACTION_AVERAGE_TIME: Average time that a work item generated by this process template during this ProcessDurationMeasurePeriod. A work item is defined as being actioned between the time of the event when it first entered the OPENED state and the time of the event that it entered the COMPLETED state - that is, when the user submitted the form.
- WORKITEM_WORKINGTIME_TOTAL_TIME: Total time that users spent processing work items generated by this process template during this ProcessDurationMeasurePeriod. A work item is defined as being worked on between the accumulated time between each event when it entered the OPENED state and the time of the paired event when it entered a PENDED, SUSPENDED, CANCELLED or COMPLETED state.
- WORKITEM_WORKINGTIME_AVERAGE_TIME: Average time that a work item generated by this process template was worked on by users during this ProcessDurationMeasurePeriod. A work item is defined as being worked on between the accumulated time between each event when it entered the OPENED state and the time of the paired event when it entered a PENDED, SUSPENDED, CANCELLED or COMPLETED state.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
PROCESSTOTAL |
string | Total number of processes started for this duration |
PROCESSTOTALTIME |
string | |
PROCESSAVERAGETIME |
string | |
WORKITEMTOTAL |
string | |
WORKITEMACTIVEAVERAGETIME |
string | User Task Instance Active Duration (Average) All AMX BPM tasks will emit a READY and COMPLETE event. The time interval between the emission of these events will determine the Task Instance Active duration. The Process Duration will be calculated when the task's COMPLETE audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st offer / allocate (firstOfferTime) and workItem completion (completionTime) disregarding any intermediate states. |
WORKITEMACTIVETOTALTIME |
string | User Task Instance Active Duration (Total) All AMX BPM tasks will emit a READY and COMPLETE event. The time interval between the emission of these events will determine the Task Instance Active duration. The Process Duration will be calculated when the task's COMPLETE audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st offer / allocate (firstOfferTime) and workItem completion (completionTime) disregarding any intermediate states. |
WORKITEMWAITTOTALTIME |
string | User Task Instance Wait Duration (Total) All AMX BPM tasks will emit a READY and OPEN event. The time interval between the emission of these events will determine the Task Instance Wait duration. The Process Duration will be calculated when the task's (first) OPEN audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st Offer / Allocate (firstOfferTime)and 1st Open (firstOpenTime) |
WORKITEMWAITAVERAGETIME |
string | User Task Instance Wait Duration (Average) All AMX BPM tasks will emit a READY and OPEN event. The time interval between the emission of these events will determine the Task Instance Wait duration. The Process Duration will be calculated when the task's (first) OPEN audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st Offer / Allocate (firstOfferTime)and 1st Open (firstOpenTime) |
WORKITEMACTIONTOTALTIME |
string | User Task Instance Action Duration (Total) All AMX BPM tasks will emit an OPEN and COMPLETE event. The time interval between the emission of (the first OPEN of) these events will determine the Task Instance Action duration. The Process Duration will be calculated when the task's COMPLETE audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st Open (firstOpenTime) and form submission (completionTime) |
WORKITEMACTIONAVERAGETIME |
string | User Task Instance Action Duration (Average) All AMX BPM tasks will emit an OPEN and COMPLETE event. The time interval between the emission of (the first OPEN of) these events will determine the Task Instance Action duration. The Process Duration will be calculated when the task's COMPLETE audit event is received and written to the Audit trail for the process instance. We interpret this as we need to calculate the time between 1st Open (firstOpenTime) and form submission (completionTime) |
WORKITEMWORKINGTIMETOTALTIME |
string | User Task Instance Working Time Duration (Total) All AMX BPM tasks will emit an OPEN and various user interaction end events, namely CLOSE, PEND, CANCEL and COMPLETE events. The User Task Instance Working Time Duration will be incremented by the time interval between each OPEN and work item end event pairing, each time one of these event pairings completes. Thus giving a total working time for a task instance, regardless of the number of times it is opened/closed and by how many different users. We interpret this as we need to calculate the cumulative time for between first and last (form submission) activities. |
WORKITEMWORKINGTIMEAVERAGETIME |
string | User Task Instance Working Time Duration (Average) All AMX BPM tasks will emit an OPEN and various user interaction end events, namely CLOSE, PEND, CANCEL and COMPLETE events. The User Task Instance Working Time Duration will be incremented by the time interval between each OPEN and work item end event pairing, each time one of these event pairings completes. Thus giving a total working time for a task instance, regardless of the number of times it is opened/closed and by how many different users. We interpret this as we need to calculate the cumulative time for between first and last (form submission) activities. |
(static, readonly) CaseAuditDetail :string
A representation of the literals of the enumeration 'Case Audit Detail',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
INSTIGATOR |
string |
(static, readonly) ChartArea :string
The areas which can be used for Charting
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
WORKITEMS |
string | Work Item area |
PROCESSTEMPLATES |
string | Process Templates area |
PROCESSINSTANCES |
string | Process Instances area |
AUDIT |
string | Audit area |
CASEOBJECTS |
string | Case Objects area |
(static, readonly) ChartCategoryType :string
The type of categorisation to do. This is the aggregation that will be done once the dataset is produced. Currently only COUNT is supported
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
COUNT |
string | Count the number of rows that match in each category set. This is similar to carrying out a count(*) in a SQL Statement |
(static, readonly) ConfigurationType :string
A representation of the literals of the enumeration 'Configuration Type',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
HIBERNATEMAPPING |
string | |
RULESCONFIGURATION |
string | |
PROPERTYCONFIGURATION |
string |
(static, readonly) ConsolidationType :string
Enumerated value defining the consolidation modes available for the measure request. One of: NO_CONSOLIDATION, CONSOLIDATE or BOTH.
See MeasureOptions.consolidation for more information.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
NOCONSOLIDATION |
string | |
CONSOLIDATE |
string | |
BOTH |
string |
(static, readonly) MeasureGranularity :string
Enumerated value defining the unit of time represented by a MeasurePeriod that is either required (in a request) or returned (in a response).
One of: HOUR, DAY, MONTH, YEAR or WEEK.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
HOUR |
string | Hourly granularity |
DAY |
string | Daily granularity |
MONTH |
string | Monthly granularity |
YEAR |
string | Yearly granularity |
WEEK |
string | Weekly granularity |
(static, readonly) MeasureType :string
Enumerated value defining the type of measure to return.
** PRIVATE API - Reserved for internal use **.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
PROCESSTEMPLATEMEASURE |
string | |
PROCESSDURATIONMEASURE |
string | |
WORKITEMFORRESOURCEMEASURE |
string | |
WORKITEMFORTEMPLATEMEASURE |
string |
(static, readonly) ProcessInstanceAuditDetail :string
A representation of the literals of the enumeration 'Process Instance Audit Detail',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
WORKITEM |
string | |
CASE |
string |
(static, readonly) ProcessTemplateStatusType :string
Enumerated value defining the state of a process instance. One of: STARTED, COMPLETED, SUSPENDED, HALTED, CANCELLED or FAILED.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
STARTED |
string | Process started status |
COMPLETED |
string | Process completed status |
SUSPENDED |
string | Process suspended status |
HALTED |
string | Process halted status |
CANCELLED |
string | Process cancelled status |
FAILED |
string | Process failed status |
(static, readonly) PurgeStatusType :string
An enumerated status indicator for the last purge operation
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
PURGEINPROGRESS |
string | A purge action is currently being executed |
PURGECOMPLETED |
string | The last purge operation completed successfully |
PURGESTOPPED |
string | The last purge operation was stopped manually |
PURGEFAILED |
string | The last purge operation failed. |
(static, readonly) QueryTarget :string
A representation of the literals of the enumeration 'Query Target',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
AUDIT |
string | |
PROCESSMETRICS |
string | |
PROCESSSTATS |
string | |
WORKITEMSTATS |
string | |
USERACTIVITY |
string | |
REGISTEREDQUERIES |
string | |
REGISTEREDENVIRONMENTS |
string | |
REGISTEREDCOMPONENTS |
string | |
REGISTEREDMESSAGES |
string | |
REGISTEREDATTRIBUTES |
string | |
PROCESSACTIVITY |
string |
(static, readonly) SortType :string
Enumerated value defining the type of sort which can be used for each element of a SortOrder.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
DESCENDING |
string | |
ASCENDING |
string |
(static, readonly) Target :string
Specifies the target table in the Event Collector database against which the query should be executed. One of:
- AUDIT: This is the default option if QueryTarget is not specified.
- PROCESS_METRICS:
- PROCESS_STATS:
- WORKITEM_STATS:
- REGISTERED_QUERIES:
- REGISTERED_COMPONENTS
- REGISTERED_ATTRIBUTES
- USER_ACTIVITY
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
AUDIT |
string |
(static, readonly) Version :string
Determine the version of the API to respond with. See individual entities for more information
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
_22 |
string | |
_30 |
string | 3.0 version of the API. Introduces the following: - All BaseEntryAttribute derived entities (such as IntegerEntryAttribute) can now return multiple "value" entities if the source Attribute is an array type - BaseEntryAttribute can return a label for an Attribute if one has been defined |
_41 |
string |
(static, readonly) WorkItemAuditDetail :string
A representation of the literals of the enumeration 'Work Item Audit Detail',
and utility methods for working with them.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
CASE |
string |
(static, readonly) WorkItemStatusType :string
Enumerated value defining the state of a work item. One of: OFFERED, ALLOCATED, PENDED, COMPLETED, SUSPENDED, CANCELLED or OPENED.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
OFFERED |
string | Work Item Offered State |
ALLOCATED |
string | Work Item Allocated State |
PENDED |
string | Work Item Pended State |
COMPLETED |
string | Work Item Completed State |
SUSPENDED |
string | Work Item Suspended State |
CANCELLED |
string | Work Item Cancelled State |
OPENED |
string | Work Item Opened State |