Enum Class AuditHistoryRowConstants
java.lang.Object
java.lang.Enum<AuditHistoryRowConstants>
com.appiancorp.suiteapi.process.history.AuditHistoryRowConstants
- All Implemented Interfaces:
Serializable
,Comparable<AuditHistoryRowConstants>
,Constable
AuditHistoryRowConstants
The domain!key recorded for an AuditHistoryRow represents the data item being modified in the recorded
audit history event, available from AuditHistoryRow.getDomKey().
PROCESS_PROPERTY_* are the domain and key recorded in a process context, and will not have a task id.
TASK_PROPERTY_* are the domain and key recorded in a task context, and will typically have a task id.
Which process properties and task properties are recorded may change over time, given that such history
may span years of data, so processing audit history should emphasize code resilience, checking assumptions.
It's inherently a different form of persisted data than most developers would assume given past
experience working with live data.
Additional, process variables in the "pv" domain are recorded, where those names depend on the
process variables declared and used in the given process model. For example, process variable
abc is recorded as pv!abc. Process variables will not have a task id.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionAdded attachment ids to the processAdded note ids to the processAdded a variable with given name to the process dynamically The process variable row being added is ALSO associated with this, but this cannot be expressed with a constant here.Archived the process (generated archive.l file) to the given archive folder idProcess is canceled BOOLEAN currently, earlier could be TIMESTAMP (treat TIMESTAMP as BOOLEAN true)Process was completed at given timestampProcess history was migrated to Kafka at the given timestamp (only present for migrated history)Process is now named the given nameProcess was paused at the given timestampPriority of the process being set direction STRING newPriority STRINGName of the priority that process was set to, in com.appiancorp.suiteapi.common.LocaleString form which contains the name in various localesThis process is a subprocess belonging to the given chain of process ids, listed from parent through child id.Is the process recording to audit process history?Removed the given attachment ids from the processRemoved the given note ids from the processResumed the process at the given timestampIs the process currently running?This process has been secured to the given map, only written when process is deleted.This process started a subprocess at given process idThe process was started at the given timestampThis process was started as a subprocess by the given process idTimestamp at which the process was terminated.Process has been upgraded via in flight modification.Process has UUID (unique identifier)Version string for updated processAdded attachment ids to the taskAdded note ids to the taskSet for either initial ASSIGNED or REASSIGNEDSet for the initial assignmentSet if the task is reassignedTask is canceledTask was completed at given timestampSet when the task is escalatedEscalated notificationTask is now named the given nameTask was paused at the given timestampPriority of the task being set direction STRING newPriority STRINGName of the priority that task was set to, in com.appiancorp.suiteapi.common.LocaleString form which contains the name in various localesRemoved the given attachment ids from the taskRemoved the given note ids from the taskResumed the task at the given timestampIs the task currently running?Timer task scheduled at given timestampDeprecated.see tp!Task started in the given task model template (tp!Timestamp at which the task was terminated. -
Method Summary
Modifier and TypeMethodDescriptionAssociated domain!dom!getDom()
getKey()
int
static AuditHistoryRowConstants
Returns the enum constant of this class with the specified name.static AuditHistoryRowConstants[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PROCESS_PROPERTY_ADDED_ATTACHMENTS
Added attachment ids to the process -
PROCESS_PROPERTY_ADDED_NOTES
Added note ids to the process -
PROCESS_PROPERTY_ADDED_VARIABLE
Added a variable with given name to the process dynamically The process variable row being added is ALSO associated with this, but this cannot be expressed with a constant here. -
PROCESS_PROPERTY_CANCELED
Process is canceled BOOLEAN currently, earlier could be TIMESTAMP (treat TIMESTAMP as BOOLEAN true) -
PROCESS_PROPERTY_COMPLETED_AT
Process was completed at given timestamp -
PROCESS_PROPERTY_NAME
Process is now named the given name -
PROCESS_PROPERTY_PAUSED_AT
Process was paused at the given timestamp -
PROCESS_PROPERTY_PRIORITY
Priority of the process being set direction STRING newPriority STRING -
PROCESS_PROPERTY_PRIORITY_NAME
Name of the priority that process was set to, in com.appiancorp.suiteapi.common.LocaleString form which contains the name in various locales -
PROCESS_PROPERTY_REMOVED_ATTACHMENTS
Removed the given attachment ids from the process -
PROCESS_PROPERTY_REMOVED_NOTES
Removed the given note ids from the process -
PROCESS_PROPERTY_RESUMED_AT
Resumed the process at the given timestamp -
PROCESS_PROPERTY_ARCHIVED_TO_FOLDER
Archived the process (generated archive.l file) to the given archive folder id -
PROCESS_PROPERTY_UUID
Process has UUID (unique identifier) -
PROCESS_PROPERTY_MIGRATED_PROCESS_HISTORY_TO_KAFKA_AT
Process history was migrated to Kafka at the given timestamp (only present for migrated history) -
PROCESS_PROPERTY_START_SUB_PROCESS_ID
This process started a subprocess at given process id -
PROCESS_PROPERTY_STARTED_BY_PARENT_PROCESS_ID
This process was started as a subprocess by the given process id -
PROCESS_PROPERTY_PROCESS_ID_CHAIN
This process is a subprocess belonging to the given chain of process ids, listed from parent through child id. -
PROCESS_PROPERTY_RUNNING
Is the process currently running? -
PROCESS_PROPERTY_STARTED_AT
The process was started at the given timestamp -
PROCESS_PROPERTY_SECURED_TO
This process has been secured to the given map, only written when process is deleted. Prior to that, all security is provided by the live process instance. u_ROLENAME=LIST_OF_USERNAMES (e.g., u_ADMIN_OWNER, u_VIEWER, u_INITIATOR) g_ROLENAME=LIST_OF_GROUP (e.g., g_ADMIN_OWNER, g_VIEWER, g_INITIATOR) -
PROCESS_PROPERTY_RECORDING
Is the process recording to audit process history? If recording is disabled for any reason, one last recording set to false is recorded so this is not done invisibly. -
PROCESS_PROPERTY_TERMINATED_AT
Timestamp at which the process was terminated. -
PROCESS_PROPERTY_VERSION
Version string for updated process -
PROCESS_PROPERTY_UPGRADE_PROCESS
Process has been upgraded via in flight modification. sourceModelId INTEGER sourceModelVersion STRING sourceModelName STRING sourceModelUuid STRING targetModelId INTEGER targetModelVersion STRING targetModelName STRING targetModelUuid STRING -
TASK_PROPERTY_ADDED_ATTACHMENTS
Added attachment ids to the task -
TASK_PROPERTY_ADDED_NOTES
Added note ids to the task -
TASK_PROPERTY_ASSIGNEE
Set for either initial ASSIGNED or REASSIGNED -
TASK_PROPERTY_ASSIGNEE_ASSIGNED
Set for the initial assignment -
TASK_PROPERTY_ASSIGNEE_REASSIGNED
Set if the task is reassigned -
TASK_PROPERTY_CANCELED
Task is canceled -
TASK_PROPERTY_COMPLETED_AT
Task was completed at given timestamp -
TASK_PROPERTY_ESCALATED
Set when the task is escalated -
TASK_PROPERTY_ESCALATED_NOTIFICATION
Escalated notification -
TASK_PROPERTY_NAME
Task is now named the given name -
TASK_PROPERTY_PAUSED_AT
Task was paused at the given timestamp -
TASK_PROPERTY_PRIORITY
Priority of the task being set direction STRING newPriority STRING -
TASK_PROPERTY_PRIORITY_NAME
Name of the priority that task was set to, in com.appiancorp.suiteapi.common.LocaleString form which contains the name in various locales -
TASK_PROPERTY_REMOVED_ATTACHMENTS
Removed the given attachment ids from the task -
TASK_PROPERTY_REMOVED_NOTES
Removed the given note ids from the task -
TASK_PROPERTY_RESUMED_AT
Resumed the task at the given timestamp -
TASK_PROPERTY_RUNNING
Is the task currently running? -
TASK_PROPERTY_SCHEDULED_AT
Timer task scheduled at given timestamp -
TASK_PROPERTY_STARTED_AT
Deprecated.see tp!startedIn for newer dataTask started at given timstamp (tp!startedIn will not be present for same task) -
TASK_PROPERTY_STARTED_IN
Task started in the given task model template (tp!startedAt will not be present for same task) -
TASK_PROPERTY_TERMINATED_AT
Timestamp at which the task was terminated.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getDomKey
- Returns:
- domain!key entirely in lowercase, e.g., pp!startedat
-
getTypeId
- Returns:
- type id
-
getDom
- Returns:
- domain in lowercase
-
getKey
- Returns:
- key in lowercase
-
getDisplayString
dom!key used for display purposes (e.g., in a toString()), including friendly capitalization, but not for logic. -
getLegacyHistoryObjectType
public int getLegacyHistoryObjectType()- Returns:
- object type used by HistoryRecord during migration, e.g., HistoryRecord.OBJECT_TYPE_TASK or HistoryRecord.OBJECT_TYPE_PROCESS
-
getLegacyHistoryType
- Returns:
- type used by HistoryRecord during migration; if present, this row is used in generating legacy HistoryRecord
-
getAssociatedDomKeys
Associated domain!keys are those expected to be written at the same time, associated with rows having this domain!key, if the getLegacyHistoryType() is present. These are only possible defined where getLegacyHistoryType() is present, and not all such rows have any other associated domain!keys. As an example, if tp!pausedAt=timestamp is set, indicating that the task has paused, then tp!running is set to false, so it's associated -- but tp!running is ALSO set to false if tp!canceled is set to true. This allows one to check if tp!running is currently true or false to know if it's running, and check the other row for WHY it's running or not.- Returns:
-