ProcessExecutionLog

Log entry of a single process execution of the process history.

Methods

getCompletionDate

getCompletionDate(): number

Returns the timestamp in milliseconds at which the process execution was terminated.

Returns

number

the end timestamp of the process execution.

---

getDuration

getDuration(): number

The time it took the process to finish in milliseconds. If the process is still executing, the duration will be calculated from start to the current date time.

Returns

number

Duration in milliseconds

---

getExecutionDate

getExecutionDate(): number

Returns the timestamp in milliseconds at which the process execution was started.

Returns

number

the start timestamp of the process execution.

---

getExecutionUid

getExecutionUid(): string

Returns

string

The unique UID of this process history entry.

---

getLongMessage

getLongMessage(): string

Returns the complete error message as a string, including the full stacktrace, if the execution of the process failed.

Returns

string

the full error message, or null if no error occurred.

---

getProcessId

getProcessId(): string

Returns the identifier of the process execution to which this entry belongs.

Returns

string

the identifier of the process execution.

---

getProcessName

getProcessName(): string

Returns the name of the executed process.

Returns

string

the name of the process.

---

getProcessTitle

getProcessTitle(): string

Returns the title of the executed process.

Returns

string

the title of the process.

---

getProcessUser

getProcessUser(): string

Returns the title of the user whose context was used to execute the process.

Returns

string

the title of the process user.

---

getServerId()

getServerId(): string

Returns

string

The ID of the system on which the process was executed.

Deprecated

Deprecated since 2023.1.0. Replaced by getSystemId to reduce the risk of confusion with getServerUID.

---

getServerUID

getServerUID(): string

Returns

string

The unique UID of the server that executed the process.

---

getShortMessage

getShortMessage(): string

Returns a short error message if the execution of the process failed.

Returns

string

a short error message, or null if no error occurred.

---

getStartedBy

getStartedBy(): string

Returns the title of the user who started the execution of the process.

Returns

string

the title of the user who started the execution, or null if it was started by the server.

---

getStartType

getStartType(): string

Returns the start type by which the process was originally started. Possible values are INTERNAL, MANUAL and TIMER. If no start type is provided, NULL is returned.

Returns

string

The start type by which the process was originally started.

---

getStatusCode

getStatusCode(): number

Returns the status code of the process execution.

Returns

number

the status code.

---

getSystemId

getSystemId(): string

Returns the ID of the system, e.g. 'default', to which the server that executed the process belongs.

Returns

string

The ID of the system on which the process was executed.