Programming with the wftk: enactment

Programmer's Guide to the wftk: working with the enactment history

[ wftk documentation home ] [ wftk programmer's guide home ]

The enactment history

Each action taken during the course of a process is recorded in the enactment history. You can get that enactment (an XML structure) or write to it; for ease of use, there's also wftk_log, which writes an arbitrary string to the enactment history.

Functions

XML  * wftk_enactment       (void * session, XML * datasheet);
int    wftk_enactment_write (void * session, XML * datasheet, XML * xml, const char * attribute, const char * value);
int    wftk_log             (void * session, XML * datasheet, char * log);

Details

wftk_enactment returns XML *

void * session,
XML * datasheet

Returns a pointer to the process's enactment structure.

wftk_enactment_write returns int

void * session,
XML * datasheet,
XML * xml,
const char * attribute,
const char * value

Creates an enactment entry for the process. The enactment structure is created if necessary. An arbitrary attribute may be attached using attribute and value; if not used, these should be NULL.

wftk_log returns int

void * session,
XML * datasheet,
const char * message

Logs a simple text message to the process's enactment history. Useful for marking points in time.