wfm.GetHistEntries

This job determines all performed actions for a historical activity or historical process. When calling the job, attention must be paid that only one of the two parameters is set.

1. Input Parameters

Name Type Required Description

[ProcessId]

STRING

No

Historical ID of the process

[RActivityId]

STRING

No

Historical instance ID of the activity

2. Output Parameters

Name Type Dependency Description

HistoryEntries

BASE64

—

The requested actions in XML format

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Example

Structure of HistoryEntries:

<HistoryEntries>
  <HistoryEntry HistId=".." EntryNr=".." ProcessId=".." RActivityId=".."
                HistType=".." Time=".." OrganisationId=".." UserId=".." UserName=".."
                ServerId=".." ServerName=".."/>
  <HistoryEntry HistId=".." EntryNr=".." ProcessId=".." RActivityId=".."
                HistType=".." Time=".." OrganisationId=".." UserId=".." UserName=".."
                ServerId=".." ServerName=".."/>
</HistoryEntries>
Table 1. Fields of <HistoryEntry>
Attribute Type Description

HistId

STRING

ID of the historical entry

EntryNr

INT

Entry number, reflects the temporal sequence

ProcessId

STRING

ID of the process

RActivityId

STRING

Instance ID of the activity (only set when calling via parameter RActivityId)

HistType

INT

Type of the historical entry:

* 1 = PREPAREPROCESS * 2 = STARTPROCESS * 3 = ENDPROCESS * 4 = PREPAREACTIVITY * 5 = STARTACTIVITY * 6 = ENDACTIVITY * 7 = COPYACTIVITYVARIABLES * 8 = HALTACTIVITY * 9 = REACTIVATEACTIVITY * 10 = STARTWORKITEM * 11 = PERSONALIZED * 12 = DEPERSONALIZED * 13 = SAVEWORKITEM * 14 = ENDWORKITEM * 15 = CREATETIMER * 16 = CANCELTIMER * 17 = REMIND * 18 = DELAYED * 19 = STARTSCRIPT * 20 = ENDSCRIPT * 21 = SYSSUSPEND * 22 = SETACTIVITYPERFORMER

Time

INT

Time of entry creation

OrganisationId

STRING

ID of the organization

UserId

STRING

ID of the user

UserName

STRING

Name of the user

ServerId

STRING

ID of the server

ServerName

STRING

Name of the server

5. See Also

wfm.GetHistActivitiesByProcess, wfm.GetHistProcessList, wfm.GetHistVariablesByHistEntry