AddHistory Method

Adds a history entry to the Process. Use the history to notate import events in the process lifecycle that users or admins might need for troubleshooting or audit history.

CODE

public void AddHistory(string message);

Classes: Process

Parameters

string message

Message to add to the process history.

Example

The following example demonstrates adding a message to the history of a process within the database.

CODE

var process = Database.GetProcessById(1);
process.AddHistory("New history message");
Database.UpdateProcess(process);

Remarks

This method alters the process object in memory, and is primarily intended to be used on processes returned from the Database class or spawned from the CreateProcess method. The messages added by this method will not reflect back to interfaces such as the Batch Manager until it is saved back to the database.

If you are intending to provide live updates to an executing process, use the LogHistory method instead.