WAPI ( Workflow Application Programming Interface) maintains a database of Maps, and Work along with providing functions to query the Work database in order to retrieve specified lists.

Maps define the Tasks and Links between the tasks. When a Map is Initiated Work is created. Map definitions may either be saved in the database or Initiated directly from the definition.

The Work database represents the current status of all Work in progress. The Work database refers to the Map database for all execution information.

The followings are types of WAPI object handles used with the WAPI functions:

- WAPIMAP
- WAPIMAPTASK
- WAPIWORK
- WAPISUBWORK

Class Attributes Index

o AUDIT_SUBWORKDONE
An audit trail constant specifying that a sub-workflow finished.
o AUDIT_SUBWORKSTARTED
An audit trail constant specifying that a sub-workflow started.
o AUDIT_SUBWORKUPDATED
An audit trail constant specifying that a sub-workflow map definition was modified.
o AUDIT_TASKACCEPTED
An audit trail constant specifying that a task assigned to a group was accepted by a member of the group.
o AUDIT_TASKBKGNSENDON
An audit trail constant specifying that the task's send on \ processing has been completed in the background using the Workflow Agent.
o AUDIT_TASKBKGNSTARTED
An audit trail constant specifying that work on a task (in the base system, this includes any automatically processed step or Item Handler step) has been started in the background using the Workflow Agent.
o AUDIT_TASKCANCELLED
An audit trail constant specifying that a task has been cancelled.
o AUDIT_TASKDONE
An audit trail constant specifying that work on a task had been completed and the task has been marked as done.
o AUDIT_TASKEXECUTING
An audit trail constant that specifies that the task was executing.
o AUDIT_TASKFINISHED
An audit trail constant specifying that work on a task had been finished for the current work period, but the task has not marked as done.
o AUDIT_TASKKILLED
An audit trail constant specifying that a task was marked as killed.
o AUDIT_TASKREADY
An audit trail constant specifying that a task has become ready.
o AUDIT_TASKREASSIGNED
An audit trail constant specifying that a task was reassigned to a different user.
o AUDIT_TASKRESUMED
An audit trail constant specifying that a suspended task was resumed.
o AUDIT_TASKRESURRECTED
An audit trail constant specifying that a task was resurrected.
o AUDIT_TASKSTARTED
An audit trail constant specifying that work on a task was started.
o AUDIT_TASKSUSPENDED
An audit trail constant specifying that a task was suspended.
o AUDIT_USERDATA
An audit trail constant specifying that a custom event was added to the audit trail.
o AUDIT_WORKARCHIVED
An audit trail constant specifying that the workflow was Archived.
o AUDIT_WORKDONE
An audit trail constant specifying that the workflow was completed.
o AUDIT_WORKRESUMED
An audit trail constant specifying that the suspended workflow was resumed.
o AUDIT_WORKSTARTED
An audit trail constant specifying that the workflow was started.
o AUDIT_WORKSTOPPED
An audit trail constant specifying that the workflow was stopped.
o AUDIT_WORKSUSPENDED
An audit trail constant specifying that the workflow was suspended.
o FALSE
A constant to specify that the False links should be taken.
o LIST_IFINITIATED
A constant specifying that only entries where the current user was the initiator should be returned.
o LIST_IFMANAGED
A constant specifying that only entries where the current user is the manager should be returned.
o LIST_IFPERFORMER
A constant specifying that only entries where the current user is the task performer should be returned.
o LOOP
A constant specifying that the Loop links should be taken.
o MAP_FLAG_ARCHIVEONCOMPLETE
A constant specifying that the workflow should automatically be Archived upon completion.
o MAP_FLAG_DELETEONCOMPLETE
A constant specifying that the workflow should automatically be Deleted upon completion.
o MAP_FLAG_EMAILATTACHMENTASFILE
A constant specifying that the e-mail sent by the workflow will contain their attachments as files included with the e-mail.
o MAP_FLAG_EMAILATTACHMENTASLINK
A constant specifying that the e-mail sent by the workflow will contain their attachments as HTML links back into Livelink.
o MAP_FLAG_RESUMEONRETURN
A constant specifying that when this Map is used for a sub-workflow and the sub-workflow completes, the task that started the sub-workflow should be marked as done and the workflow route continued.
o MAP_FLAG_SKIPWEEKENDS
A constant specifying that the workflow should skip weekends when calculating due date.
o MAP_FLAG_TEMPMAP
A constant specifying that the Map should automatically be Deleted when the workflow is deleted.
o MAPTASK_FALSELINKS
A constant specifying that the False branches from a task should be taken.
o MAPTASK_FLAG_AUTODONE
A constant specifying that the task should automatically become Done as soon as it becomes ready.
o MAPTASK_FLAG_BKGNSENDON
A constant specifying that the task's send on processing should occur in the background (by the Workflow Agent as a separate process).
o MAPTASK_FLAG_EMAILENABLED
A constant specifying that the task's has been e-mail enabled.
o MAPTASK_FLAG_MILESTONE
A constant specifying that the task should be marked as a Milestone task and Milestone dates calculated and stored.
o MAPTASK_FLAG_RECALCULATE
A constant specifying that the task should invoke the recalculate due date processing when the task has been sent on.
o MAPTASK_LOOPLINKS
A constant specifying that the Loopback branch from a task should be taken.
o MAPTASK_TRUELINKS
A constant specifying that the True branches from a task should be taken.
o STARTTASK_FLAG_NOAUDIT
A constant specifying that the WAPI.StartTask() call should not add an event to the audit trail.
o STARTTASK_FLAG_REEXECUTE
A constant specifying that the WAPI.StartTask() call should mark the task as started even if it was already marked as started.
o SUBWORKTASK_CUSTOMDATA
A constant specifying the CustomData for a workflow task in an update call.
o SUBWORKTASK_FLAGS
A constant specifying the Flags for a workflow task in an update call.
o SUBWORKTASK_FLAG_AUTODONE
A constant specifying that the task should automatically complete when it becomes ready.
o SUBWORKTASK_FLAG_BACKGROUND
A constant specifying that the task should be performed in the background (by the Workflow Agent). The Item Handler step is the only step that supports this capability.
o SUBWORKTASK_FLAG_BKGNSENDON
A constant specifying that the task's send on processing should occur in the background (by the Workflow Agent as a separate process). This is used to gain efficiencies and performance improvements especially if the steps proceeding this step are auto-done steps ( for example, Evaluate, Process, Subworkflow, Milestone, etc.).
o SUBWORKTASK_FLAG_MILESTONE
A constant specifying that the task should be a Milestone task and store a Milestone due date.
o SUBWORKTASK_FLAG_RECALCULATE
A constant specifying that the task should invoke the recalculate due date processing when the task has been sent on.
o SUBWORKTASK_PERFORMERID
A constant specifying the PerformerID for a task in a workflow for an update call.
o SUBWORKTASK_STATUS_DELETED
A status constant specifying that the task was deleted.
o SUBWORKTASK_STATUS_DONE
A status constant specifying that the task is done.
o SUBWORKTASK_STATUS_EXECUTING
A status constant specifying that the task is executing.
o SUBWORKTASK_STATUS_FINISHED
A status constant specifying that the task is finished.
o SUBWORKTASK_STATUS_KILLED
A status constant specifying that the task was killed.
o SUBWORKTASK_STATUS_READY
A status constant specifying that the task is ready.
o SUBWORKTASK_STATUS_READY_BG
A status constant specifying that the task is ready in the background (only supported with the Item Handler step).
o SUBWORKTASK_STATUS_SENDINGON
A status constant specifying that the task's send on processing is being performed in the background by the Workflow Agent.
o SUBWORKTASK_STATUS_STARTED
A status constant specifying that the task is started.
o SUBWORKTASK_STATUS_SUSPENDED
A status constant specifying that the task is suspended.
o SUBWORKTASK_STATUS_WAITING
A status constant specifying that the task is waiting to become ready.
o SUBWORKTASK_TITLE
A constant specifying the Title for a task in a workflow for an update call.
o SUBWORKTASK_TYPE_MILESTONE
A constant specifying that the task is a Milestone task.
o SUBWORKTASK_TYPE_NORMAL
A constant specifying that the task is a Normal task and not a Milestone task.
o SUBWORKTASK_USERCOMMENT
A constant specifying the UserComment for a task in a workflow for an update call.
o SUBWORKTASK_USERDATA
A constant specifying the UserData for a task in a workflow for an update call.
o SUBWORKTASK_USERSTATUS
A constant specifying the UserStatus for a task in a workflow for an update call.
o SUBWORK_CUSTOMDATA
A constant specifying the CustomData for a subWork in an update call.
o SUBWORK_FLAGS
A constant specifying the Flags for a subWorkflow in an update call.
o SUBWORK_FLAG_ARCHIVEONCOMPLETE
A constant specifying that the workflow should automatically be Archived upon completion.
o SUBWORK_FLAG_DELETEONCOMPLETE
A constant specifying that the workflow should automatically be Deleted upon completion.
o SUBWORK_FLAG_RESUMEONRETURN
A constant specifying that when this workflow is used for a sub-workflow and the sub-workflow completes, the task that started the sub-workflow should be marked as done and the workflow route continued.
o SUBWORK_FLAG_SKIPWEEKENDS
A constant specifying that the workflow should skip weekends when calculating due dates.
o SUBWORK_FLAG_TEMPMAP
A constant specifying that the Map definition that is used by this workflow should be Deleted when the workflow is deleted.
o SUBWORK_PROJECT
A constant specifying the Project for a subWorkflow in an update call.
o SUBWORK_STATUS_DONE
A status constant specifying that the subwork has completed.
o SUBWORK_STATUS_EXECUTING
A status constant specifying that the subwork has not yet completed.
o SUBWORK_TITLE
A constant specifying the Title for a subWorkflow in an update call.
o SUBWORK_USERDATA
A constant specifying the UserData for a subWorkflow in an update call.
o TRUE
A constant specifying that the True links should be taken.
o WORK_CUSTOMDATA
A constant specifying the CustomData for a workflow in an update call.
o WORK_FLAGS
A constant specifying the Flags for a workflow in an update call.
o WORK_MANAGERID
A constant specifying the ManagerID for a workflow in an update call.
o WORK_OWNERID
A constant specifying the OwnerID for a workflow in an update call.
o WORK_PROJECT
A constant specifying the Project for a workflow in an update call.
o WORK_STATUS_ARCHIVED
A status constant specifying that the workflow has been Archived.
o WORK_STATUS_DONE
A status constant specifying that the workflow has been Completed.
o WORK_STATUS_EXECUTING
A status constant specifying that the workflow is still executing.
o WORK_STATUS_STOPPED
A status constant specifying that the workflow has been Stopped.
o WORK_STATUS_SUSPENDED
A status constant specifying that the workflow has been Suspended.
o WORK_TITLE
A constant specifying the Title for a workflow in an update call.
o WORK_USERDATA
A constant specifying the UserData for a workflow in an update call.

Class Methods Index

o AcceptTask( WAPIWORK work, Integer workID, Integer subworkID, Integer subworktaskID )
Assigns a step, that was previously assigned to a group, to the currently logged in user.
o AccessWork( WAPIWORK work, Integer workID, [Integer subworkID] )
Sets up a WAPIWORK object handle to provide access to the data package of a workflow.
o AddTaskLink( WAPIMAPTASK fromTask, Integer linkType, WAPIMAPTASK toTask )
Adds a link of the specified type between the specified tasks.
o AddWorkData( WAPIWORK work, Integer type, Integer subtype, [String description], Dynamic value )
Creates and sets data stored in a data package.
o AllocMap( WAPISESSION session )
Allocates a WAPIMAP object handle.
o AllocMapTask( WAPIMAP map )
Allocates a WAPIMAPTASK object handle.
o AllocNthMapTask( WAPIMAP map, Integer taskID )
Allocate a WAPIMAPTASK object handle for a particular task in a workflow map definition.
o AllocSession( CAPILOGIN login )
Allocates a WAPISESSION object for a login user.
o AllocSubWork( WAPIWORK work )
Allocates a WAPISUBWORK object for the specified WAPIWORK object.
o AllocWork( WAPISESSION session )
Allocates a WAPIWORK object.
o ArchiveWork( WAPIWORK work, Integer workID )
Sets the status of a Stopped or Completed workflow to Archived.
o CallSubWork( WAPIWORK work )
Initiates a Sub-Workflow using the information supplied in a previous call to WAPI.PrepareSubMap() or WAPI.PrepareSubWork().
o ColumnStringToValue( WAPISESSION session, RecArray array, String columnName )
Converts the values returned by a call to WAPI.WorkList() from Strings to their true values.
o DeleteMapByID( WAPISESSION session, Integer mapID )
Deletes the Map from the Map database with the specified mapID.
o DeleteMapTask( WAPIMAPTASK task )
Deletes the task from the map definition.
o DeleteTaskLink( WAPIMAPTASK fromTask, Integer linkType, WAPIMAPTASK toTask)
Deletes the link from the specified tasks.
o DeleteWork( WAPIWORK work, Integer workID )
Deletes the specified Stopped or Completed workflow.
o DeleteWorkData( WAPIWORK work, Integer type, Integer subtype )
Deletes data from the Data Package specified by type and subtype.
o FreeMap( WAPIMAP map )
Frees the memory held by the WAPIMAP object.
o FreeMapTask( WAPIMAPTASK task )
Frees the memory held by the WAPIMAPTASK object.
o FreeSession( WAPISESSION session )
Logs out the given WAPISESSION object and frees the associated memory.
o FreeSubWork( WAPISUBWORK subWork )
Frees the memory held by the WAPISUBWORK object.
o FreeWork( WAPIWORK work )
Frees the memory held by the WAPIWORK object.
o GetTaskLinks( WAPIMAPTASK task, Integer linkType )
Gets a List of the task ids for all links of the specified type for the specified task.
o GetWorkData( WAPIWORK work, Integer type, Integer subtype )
Gets the data specified by the given type and subtype stored in the data package.
o LLMapToWMap( WAPIMAP map, RecArray mapInfo, RecArray tasks, RecArray links )
Takes a map definition from Livelink OScript and converts it to a WAPIMAP definition.
o ListWorkData ( WAPIWORK work, [Boolean allWork )
Returns the data that was stored for the specified work.
o LoadMapByID( WAPIMAP map, Integer mapID )
Loads the map information from the Map database for the map with the specified ID.
o LoadTaskStatus( WAPISESSION session, Integer workID, [Integer subWorkID], [Integer taskID] )
Loads the task information for the specified workID, subWorkID, and taskID.
o LoadWorkAudit( WAPISESSION session, Integer workID, [Integer subWorkID], [Integer taskID] )
Loads the audit trail for the specified workID, subWorkID, and taskID.
o LoadWorkStatus( WAPISESSION session, Integer workID, [Integer subWorkID], [Integer taskID] )
Loads the information about a workflow.
o PrepareMap( WAPIWORK work, WAPIMAP map, [Integer flags] )
Saves the map definition to the map database and sets up the work object for workflow initiation.
o PrepareSubMap( WAPIWORK work, WAPIMAP map, [Integer flags] )
Saves the map definition to the map database and sets up the work object to initiate the map as a sub-workflow.
o PrepareSubWork( WAPIWORK work, Integer mapID, [Integer flags] )
Sets up the work object to initiate the specified map as a subworkflow.
o PrepareWork( WAPIWORK work, Integer mapID, [Integer flags] )
Sets up the work object to initiate the specified map as a workflow.
o ReassignTask( WAPIWORK work, Integer workID, Integer subWorkID, Integer taskID, Integer userID)
Reassigns the task specified by the workID, subWorkID, and taskID to the given userID.
o ReplaceMap( WAPIMAP map )
Saves the modified map definition to the map database replacing the original.
o ResumeWork( WAPIWORK work, Integer workID )
Sets the status of a suspended workflow to Executing.
o SaveMap( WAPIMAP map )
Saves a WAPIMAP map definition to the map database.
o SetCallback( WAPISESSION session, Dynamic feature, [Dynamic object] )
Specifies the WAPI callback routine and context argument that is passed to the callback.
o SetWorkData( WAPIWORK work, Integer type, Integer subtype, [String description], Dynamic value )
Sets data stored in a data package.
o StartTask( WAPIWORK work, Integer workID, Integer subWorkID, Integer taskID, Integer flags )
Marks the specified task as started and sets up the given WAPIWORK object handle to be able to access the work package.
o StartWork( WAPIWORK work, [String title] )
Initiates a workflow that was prepared with a call to WAPI.PrepareWork() and readies any initial tasks.
o StopWork( WAPIWORK work, Integer workID )
Sets the status of an Executing or Suspended workflow to Stopped.
o SuspendWork( WAPIWORK work, Integer workID )
Sets the status of an Executing workflow to Suspended.
o TaskAuditUserData( WAPIWORK work, Integer workID, Integer subWorkID, Integer taskID, Dynamic data, [Integer iterNum] )
Adds a row to the audit trail and stores the specified data.
o TaskCancel( WAPIWORK work )
Notifies the workflow engine that work on this task is completed for the time being but skip marking the task as Done and send the workflow on to the next step.
o TaskDone( WAPIWORK work, [Dynamic linkType] )
Marks the task as Done and takes the paths from the task that are of the specified link type.
o UpdateSubWorkAttribute( WAPIWORK work, Integer workID, Integer subWorkID, Integer attribute, Dynamic value)
Updates the value of a subWork attribute for a workflow.
o UpdateSubWorkPrepare( WAPIWORK work, WAPIMAP map, Integer workID, Integer subWorkID )
Prepares the map and work object for a workflow already in process for update.
o UpdateSubWorkStart( WAPIWORK work )
Updates the in-process workflow specified by work.
o UpdateTaskAttribute( WAPIWORK work, Integer workID, Integer subWorkID, Integer taskID, Integer attribute, Dynamic value )
Updates the value of a task attribute for a workflow.
o UpdateWorkAttribute( WAPIWORK work, Integer workID, Integer attribute, Dynamic value )
Updates the value of a work attribute.
o WorkList( WAPISESSION session, String viewName, Dynamic whereClause, Integer flags )
Returns workflow information using the specified view, where clause, and flags.
o WorkList2( WAPISESSION session, String viewName, Dynamic whereClause, Dynamic orderby, Integer flags )
Returns workflow information using the specified view, where clause, orderby clause, and flags.

Class Attributes

o AUDIT_SUBWORKDONE 
 Integer AUDIT_SUBWORKDONE

An audit trail constant specifying that a sub-workflow finished.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_SUBWORKSTARTED 
 Integer AUDIT_SUBWORKSTARTED

An audit trail constant specifying that a sub-workflow started.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_SUBWORKUPDATED 
 Integer AUDIT_SUBWORKUPDATED

An audit trail constant specifying that a sub-workflow map definition was modified.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKACCEPTED 
 Integer AUDIT_TASKACCEPTED

An audit trail constant specifying that a task assigned to a group was accepted by a member of the group.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKBKGNSENDON 
 Integer AUDIT_TASKBKGNSENDON

An audit trail constant specifying that the task's send on processing has been done in the background using the Workflow Agent.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKBKGNSTARTED 
 Integer AUDIT_TASKBKGNSTARTED

An audit trail constant specifying that work on a task (in the base system this includes any auto done step or Item Handler step) has been started in the background using the Workflow Agent.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKCANCELLED 
 Integer AUDIT_TASKCANCELLED

An audit trail constant specifying that a task as been cancelled.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKDONE 
 Integer AUDIT_TASKDONE

An audit trail constant specifying that work on a task had been completed and the task marked as done.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKEXECUTING 
 Integer AUDIT_TASKEXECUTING

An audit trail constant specifying that the task was executing.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKFINISHED 
 Integer AUDIT_TASKFINISHED

An audit trail constant specifying that work on a task had been finished for the current work period, but the task was not marked as done.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKKILLED 
 Integer AUDIT_TASKKILLED

An audit trail constant specifying that a task was marked as killed.

This indicates that the path containing the task was not taken as the result of an evaluation. The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKREADY 
 Integer AUDIT_TASKREADY

An audit trail constant specifying that a task became ready.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKREASSIGNED 
 Integer AUDIT_TASKREASSIGNED

An audit trail constant specifying that a task was reassigned to a different user.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKRESUMED 
 Integer AUDIT_TASKRESUMED

An audit trail constant specifying that a suspended task was resumed.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKRESURRECTED 
 Integer AUDIT_TASKRESURRECTED

An audit trail constant specifying that a task was resurrected.

This indicates that a loopback occurred and the path containing the task is once again available. The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKSTARTED 
 Integer AUDIT_TASKSTARTED

An audit trail constant specifying that work on a task was started.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_TASKSUSPENDED 
 Integer AUDIT_TASKSUSPENDED

An audit trail constant specifying that a task was suspended.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_USERDATA 
 Integer AUDIT_USERDATA

An audit trail constant specifying that a custom event was added to the audit trail.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKARCHIVED 
 Integer AUDIT_WORKARCHIVED

An audit trail constant specifying that the workflow was archived.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKDONE 
 Integer AUDIT_WORKDONE

An audit trail constant specifying that the workflow was completed.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKRESUMED 
 Integer AUDIT_WORKRESUMED

An audit trail constant specifying that the suspended workflow was resumed.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKSTARTED 
 Integer AUDIT_WORKSTARTED

An audit trail constant specifying that the workflow was started.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKSTOPPED 
 Integer AUDIT_WORKSTOPPED

An audit trail constant specifying that the workflow was stopped.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o AUDIT_WORKSUSPENDED 
 Integer AUDIT_WORKSUSPENDED

An audit trail constant specifying that the workflow was suspended.

The constant is returned in the WorkAudit_Status column of the RecArray returned by a call to WAPI.LoadWorkAudit().

o FALSE 
 Integer FALSE

A constant specifying that the False links should be taken.

This constant is used by the WAPI.TaskDone() function as the flag indicating which link types should be taken coming from the task.

o LIST_IFINITIATED 

 Integer LIST_IFINITIATED

A constant specifying that only entries where the current user was the initiator should be returned.

This constant is used as a bit-mask flag for the call WAPI.WorkList().

o LIST_IFMANAGED 
 Integer LIST_IFMANAGED

A constant specifying that only entries where the current user is the manager should be returned.

This constant is used as a bit-mask flag for the call WAPI.WorkList().

o LIST_IFPERFORMER 
 Integer LIST_IFPERFORMER

A constant specifying that only entries where the current user is the task performer should be returned.

This constant is used as a bit-mask flag for the call WAPI.WorkList(). This flag is used to determine the ToDo list for a user.

o LOOP 
 Integer LOOP

A constant specifying that the Loop links should be taken.

This constant is used by the WAPI.TaskDone() function as the flag indicating which link types should be taken coming from the task.

o MAP_FLAG_ARCHIVEONCOMPLETE 
 Integer MAP_FLAG_ARCHIVEONCOMPLETE

A constant specifying that the workflow should automatically be Archived upon completion.

This constant can be combined with the other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_DELETEONCOMPLETE 
 Integer MAP_FLAG_DELETEONCOMPLETE

A constant specifying that the workflow should automatically be Deleted upon completion.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_EMAILATTACHMENTASFILE 
 Integer MAP_FLAG_EMAILATTACHMENTASFILE

A constant specifying that the e-mail sent by the workflow will contain their attachments as files included with the e-mail.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_EMAILATTACHMENTASLINK 
 Integer MAP_FLAG_EMAILATTACHMENTASLINK

A constant specifying that the e-mail sent by the workflow will contain their attachments as HTML links back into Livelink.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_RESUMEONRETURN 
 Integer MAP_FLAG_RESUMEONRETURN

A constant specifying that when this Map is used for a sub-workflow and the sub-workflow completes, the task that started the sub-workflow should be marked as done and the workflow route continued.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_SKIPWEEKENDS 
 Integer MAP_FLAG_SKIPWEEKENDS

A constant specifying that the workflow should skip weekends when calculating due date.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAP_FLAG_TEMPMAP 
 Integer MAP_FLAG_TEMPMAP

A constant specifying that the Map should automatically be Deleted when the workflow is deleted.

This constant can be combined with other Map_Flag constants by Bitwise OR and used to set the Flag field for a Map to control workflow actions.

o MAPTASK_FALSELINKS 
 Integer MAPTASK_FALSELINKS

A constant specifying that the False branches from a task should be taken. This constant should be used as the linkType for a call to WAPI.TaskDone().

o MAPTASK_FLAG_AUTODONE 
 Integer MAPTASK_FLAG_AUTODONE

A constant specifying that the task should automatically become Done as soon as it becomes ready.

o MAPTASK_FLAG_BKGNSENDON 
 Integer MAPTASK_FLAG_BKGNSENDON

A constant specifying that the task's send on processing should occur in the background (by the Workflow Agent as a separate process). This is used to gain efficiencies and performance improvements especially if the steps proceeding this step are autodone steps ( for example, Evaluate, Process, Subworkflow, Milestone, etc.).

o MAPTASK_FLAG_EMAILENABLED 
 Integer MAPTASK_FLAG_EMAILENABLED

A constant specifying that the task has been e-mail enabled. When this task becomes ready, an e-mail will be sent to the Assignee(s) allowing the task to be completed through e-mail.

o MAPTASK_FLAG_MILESTONE 
 Integer MAPTASK_FLAG_MILESTONE

A constant specifying that the task should be marked as a Milestone task and Milestone dates should be calculated and stored.

o MAPTASK_FLAG_RECALCULATE 
 Integer MAPTASK_FLAG_RECALCULATE

A constant specifying that the task should invoke the recalculate due date processing when the task has been sent on.

o MAPTASK_LOOPLINKS 
 Integer MAPTASK_LOOPLINKS

A constant specifying that the Loopback branch from a task should be taken. This constant should be used as the linkType for a call to WAPI.TaskDone().

o MAPTASK_TRUELINKS 
 Integer MAPTASK_TRUELINKS

A constant specifying that the True branches from a task should be taken. This constant should be used as the linkType for a call to WAPI.TaskDone().

o STARTTASK_FLAG_NOAUDIT 
 Integer STARTTASK_FLAG_NOAUDIT

A constant specifying that the WAPI.StartTask() call should not add an event to the audit trail.

o STARTTASK_FLAG_REEXECUTE 
 Integer STARTTASK_FLAG_REEXECUTE

A constant specifying that the WAPI.StartTask() call should mark the task as started even if it was already marked as started.

o SUBWORKTASK_CUSTOMDATA 
 Integer SUBWORKTASK_CUSTOMDATA

A constant specifying the CustomData for a workflow task in an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_FLAGS 
 Integer SUBWORKTASK_FLAGS

A constant specifying the Flags for a workflow task in an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_FLAG_AUTODONE 
 Integer SUBWORKTASK_FLAG_AUTODONE

A constant specifying that the task should automatically complete when it becomes ready.

Use this constant with the call WAPI.UpdateTaskAttribute() when setting the task Flags with the WAPI.SUBWORKTASK_FLAGS constant.

o SUBWORKTASK_FLAG_BACKGROUND 
 Integer SUBWORKTASK_FLAG_BACKGROUND

A constant specifying that the task should be performed in the background (by the Workflow Agent). The Item Handler step is the only step that supports this capability.

Use this constant with the call WAPI.UpdateTaskAttribute() when setting the task Flags with the WAPI.SUBWORKTASK_FLAGS constant.

o SUBWORKTASK_FLAG_BKGNSENDON 
 Integer SUBWORKTASK_FLAG_BKGNSENDON

A constant specifying that the task's send on processing should occur in the background (by the Workflow Agent as a separate process). This is used to gain efficiencies and performance improvements especially if the steps proceeding this step are autodone steps ( for example, Evaluate, Process, Subworkflow, Milestone, etc.).

Use this constant with the call WAPI.UpdateTaskAttribute() when setting the task Flags with the WAPI.SUBWORKTASK_FLAGS constant.

o SUBWORKTASK_FLAG_MILESTONE 
 Integer SUBWORKTASK_FLAG_MILESTONE

A constant specifying that the task should be a Milestone task and store a Milestone due date.

Use this constant with the call WAPI.UpdateTaskAttribute() when setting the task Flags with the WAPI.SUBWORKTASK_FLAGS constant.

o SUBWORKTASK_FLAG_RECALCULATE 
 Integer SUBWORKTASK_FLAG_RECALCULATE

A constant specifying that the task should invoke the recalculate due date processing when the task has been sent on.

Use this constant with the call WAPI.UpdateTaskAttribute() when setting the task Flags with the WAPI.SUBWORKTASK_FLAGS constant.

o SUBWORKTASK_PERFORMERID 
 Integer SUBWORKTASK_PERFORMERID

A constant specifying the PerformerID for a task in a workflow for an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_STATUS_DELETED 
 Integer SUBWORKTASK_STATUS_DELETED

A status constant specifying that the task was deleted.

o SUBWORKTASK_STATUS_DONE 
 Integer SUBWORKTASK_STATUS_DONE

A status constant specifying that the task is done.

o SUBWORKTASK_STATUS_EXECUTING 
 Integer SUBWORKTASK_STATUS_EXECUTING

A status constant specifying that the task is executing.

o SUBWORKTASK_STATUS_FINISHED 
 Integer SUBWORKTASK_STATUS_FINISHED

A status constant specifying that the task is finished.

o SUBWORKTASK_STATUS_KILLED 
 Integer SUBWORKTASK_STATUS_KILLED

A status constant specifying that the task was killed.

o SUBWORKTASK_STATUS_READY 
 Integer SUBWORKTASK_STATUS_READY

A status constant specifying that the task is ready.

o SUBWORKTASK_STATUS_READY_BG 
 Integer SUBWORKTASK_STATUS_READY_BG

A status constant specifying that the task is ready in the background (currently this is only supported with the Item Handler step).

o SUBWORKTASK_STATUS_SENDINGON 
 Integer SUBWORKTASK_STATUS_SENDINGON

A status constant specifying that the task's send on processing is being performed in the background by the Workflow Agent.

o SUBWORKTASK_STATUS_STARTED 
 Integer SUBWORKTASK_STATUS_STARTED

A status constant specifying that the task is started.

o SUBWORKTASK_STATUS_SUSPENDED 
 Integer SUBWORKTASK_STATUS_SUSPENDED

A status constant specifying that the task is suspended.

o SUBWORKTASK_STATUS_WAITING 
 Integer SUBWORKTASK_STATUS_WAITING

A status constant specifying that the task is waiting to become ready.

o SUBWORKTASK_TITLE 
 Integer SUBWORKTASK_TITLE

A constant specifying the Title of a task in a workflow for an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_TYPE_MILESTONE 
 Integer SUBWORKTASK_TYPE_MILESTONE

A constant specifying that the task is a Milestone task.

o SUBWORKTASK_TYPE_NORMAL 
 Integer SUBWORKTASK_TYPE_NORMAL

A constant specifying that the task is a Normal task and not a Milestone task.

o SUBWORKTASK_USERCOMMENT 
 Integer SUBWORKTASK_USERCOMMENT

A constant specifying the UserComment for a task in a workflow for an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_USERDATA 
 Integer SUBWORKTASK_USERDATA

A constant specifying the UserData for a task in a workflow for an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORKTASK_USERSTATUS 
 Integer SUBWORKTASK_USERSTATUS

A constant specifying the UserStatus for a task in a workflow for an update call.

Use this constant with the call WAPI.UpdateTaskAttribute().

o SUBWORK_CUSTOMDATA 
 Integer SUBWORK_CUSTOMDATA

A constant specifying the CustomData for a subWork in an update call.

Use this constant with the call WAPI.UpdateSubWorkAttribute().

o SUBWORK_FLAGS 
 Integer SUBWORK_FLAGS

A constant specifying the Flags for a subWorkflow in an update call.

Use this constant with the call WAPI.UpdateSubWorkAttribute().

o SUBWORK_FLAG_ARCHIVEONCOMPLETE 
 Integer SUBWORK_FLAG_ARCHIVEONCOMPLETE

A constant specifying that the workflow should automatically be Archived upon completion.

This constant can be combined with the other SUBWORK_FLAG constants by Bitwise OR and used with the call WAPI.UpdateSubWorkAttribute() when using the SUBWORK_FLAGS constant to control workflow actions.

o SUBWORK_FLAG_DELETEONCOMPLETE 
 Integer SUBWORK_FLAG_DELETEONCOMPLETE

A constant specifying that the workflow should automatically be Deleted upon completion.

This constant can be combined with the other SUBWORK_FLAG constants by Bitwise OR and used with the call WAPI.UpdateSubWorkAttribute() when using the SUBWORK_FLAGS constant to control workflow actions.

o SUBWORK_FLAG_RESUMEONRETURN 
 Integer SUBWORK_FLAG_RESUMEONRETURN

A constant specifying that when this workflow is used for a sub-workflow and the sub-workflow completes, the task that started the sub-workflow should be marked as done and the workflow route continued.

This constant can be combined with the other SUBWORK_FLAG constants by Bitwise OR and used with the call WAPI.UpdateSubWorkAttribute() when using the SUBWORK_FLAGS constant to control workflow actions.

o SUBWORK_FLAG_SKIPWEEKENDS 
 Integer SUBWORK_FLAG_SKIPWEEKENDS

A constant specifying that the workflow should skip weekends when calculating due dates.

This constant can be combined with the other SUBWORK_FLAG constants by Bitwise OR and used with the call WAPI.UpdateSubWorkAttribute() when using the SUBWORK_FLAGS constant to control workflow actions.

o SUBWORK_FLAG_TEMPMAP 
 Integer SUBWORK_FLAG_TEMPMAP

A constant specifying that the Map definition that is used by this workflow should be deleted when the workflow is deleted.

This constant can be combined with the other SUBWORK_FLAG constants by Bitwise OR and used with the call WAPI.UpdateSubWorkAttribute() when using the SUBWORK_FLAGS constant to control workflow actions.

o SUBWORK_PROJECT 
 Integer SUBWORK_PROJECT

A constant specifying the Project for a subWorkflow in an update call.

Use this constant with the call WAPI.UpdateSubWorkAttribute().

o SUBWORK_STATUS_DONE 
 Integer SUBWORK_STATUS_DONE

A status constant specifying that the subwork has completed.

o SUBWORK_STATUS_EXECUTING 
 Integer SUBWORK_STATUS_EXECUTING

A status constant specifying that the subwork has not yet completed.

o SUBWORK_TITLE 
 Integer SUBWORK_TITLE

A constant specifying the Title of a subWorkflow in an update call.

Use this constant with the call WAPI.UpdateSubWorkAttribute().

o SUBWORK_USERDATA 
 Integer SUBWORK_USERDATA

A constant specifying the UserData for a subWorkflow in an update call.

Use this constant with the call WAPI.UpdateSubWorkAttribute().

o TRUE 
 Integer TRUE

A constant specifying that the True links should be taken.

This constant is used by the WAPI.TaskDone() function as the flag indicating which link types should be taken coming from the task.

o WORK_CUSTOMDATA 
 Integer WORK_CUSTOMDATA

A constant specifying the CustomData for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_FLAGS 
 Integer WORK_FLAGS

A constant specifying the Flags for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_MANAGERID 
 Integer WORK_MANAGERID

A constant specifying the ManagerID for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_OWNERID 
 Integer WORK_OWNERID

A constant specifying the OwnerID for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_PROJECT 
 Integer WORK_PROJECT

A constant specifying the Project for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_STATUS_ARCHIVED 
 Integer WORK_STATUS_ARCHIVED

A status constant specifying that the workflow has been Archived.

o WORK_STATUS_DONE 
 Integer WORK_STATUS_DONE

A status constant specifying that the workflow has been Completed.

o WORK_STATUS_EXECUTING 
 Integer WORK_STATUS_EXECUTING

A status constant specifying that the workflow is still executing.

o WORK_STATUS_STOPPED 
 Integer WORK_STATUS_STOPPED

A status constant specifying that the workflow has been Stopped.

o WORK_STATUS_SUSPENDED 
 Integer WORK_STATUS_SUSPENDED

A status constant specifying that the workflow has been Suspended.

o WORK_TITLE 
 Integer WORK_TITLE

A constant specifying the Title for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

o WORK_USERDATA 
 Integer WORK_USERDATA

A constant specifying the UserData for a workflow in an update call.

Use this constant with the call WAPI.UpdateWorkAttribute().

Class Methods

o AcceptTask 
 Integer AcceptTask(
               WAPIWORK work,
               Integer workID,
               Integer subworkID,
               Integer taskID )

Assigns a step that was previously assigned to a group to the currently logged in user.

This call changes the SubWorkTask_PerformerID column in the WSubWorkTask table to the ID of the currently logged in user.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subworkID  -  The subworkID for the desired sub-workflow.
taskID  -  The taskID for the desired step.
Returns:
(Integer 0) if successful; Error otherwise.
o AccessWork 
 Integer AccessWork(
               WAPIWORK work,
               Integer workID,
              [Integer subworkID] )

Sets up a WAPIWORK object handle to provide access to the data package of a workflow.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subworkID  -  The optional subworkID for the desired sub-workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o AddTaskLink 
 Integer AddTaskLink(
               WAPIMAPTASK fromtask,
               Integer linktype,
               WAPIMAPTASK totask )

Adds a link, of the specified type, between the specified tasks.

Parameters:
fromtask  -  The WAPIMAPTASK handle specifying the task the link should come from.
linktype  - 

Specifies a constant indicating the link type, can be:
 WAPI.MAPTASK_FALSELINKS
 WAPI.MAPTASK_LOOPLINKS
 WAPI.MAPTASK_TRUELINKS
totask  -  The WAPIMAPTASK handle specifying the task the link should go to.
Returns:
 
(Integer 0) if successful; Error otherwise.
 
o AddWorkData 
 Integer AddWorkData(
               WAPIWORK work,
               Integer type,
               Integer subtype, 
               [String descripton], 
               Dynamic value )

Creates and sets data stored in a data package.

Parameters:
work  -  The WAPIWORK object handle.
type  -  The data package type.
subtype  -  The data package subtype.
description  -  Optional description of the data.
value  -  The data value to store.
Returns:
(Integer 0) if successful; Error otherwise.
o AllocMap 
 WAPIMAP AllocMap(
              WAPISESSION session )

Allocates a WAPIMAP object handle. This map handle is used to define workflow maps.

Parameters:
session  -  The WAPISESSION object handle.
Returns:
The WAPIMAP object handle if successful; Error otherwise.
o AllocMapTask 
 WAPIMAPTASK AllocMapTask(
                    WAPIMAP map )

Allocates a WAPIMAPTASK object handle. This mapTask handle is used to define a task for a workflow map.

Parameters:
map  -  The WAPIMAP object handle for the desired workflow map.
Returns:
The WAPIMAPTASK object handle if successful; Error otherwise.
o AllocNthMapTask 
 WAPIMAPTASK AllocNthMapTask(
                     WAPIMAP map,
                     Integer taskID )

Allocates a WAPIMAPTASK object handle for a particular task in a workflow map definition. This mapTask handle is used to define a task for a workflow map.

Parameters:
map  -  The WAPIMAP object handle for the desired workflow map.
taskID  -  The id for the desired workflow task.
Returns:
The WAPIMAPTASK object handle if successful; Error otherwise.
o AllocSession 
 WAPISESSION AllocSession(
                    CAPILOGIN login )

Allocates a WAPISESSION object for a login user.

A WAPISESSION contains information pertaining to workflow management.

Parameters:
login  -  The CAPILOGIN object handle specifically for the login user.
Returns:
The WAPISESSION object handle if successful; Error otherwise.
o AllocSubWork 
 WAPISUBWORK AllocSubWork(
                    WAPIWORK work )

Allocates a WAPISUBWORK object for the specified WAPIWORK object.

Parameters:
work  -  The WAPIWORK object handle.
Returns:
The WAPISUBWORK object handle if successful; Error otherwise.
o AllocWork 
 WAPIWORK AllocWork(
               WAPISESSION session )

Allocates a WAPIWORK object.

Parameters:
session  -  The WAPISESSION object handle.
Returns:
The WAPIWORK object handle if successful; Error otherwise.
o ArchiveWork 
 Integer ArchiveWork(
               WAPIWORK work,
               Integer workID )

Sets the status of a Stopped or Completed workflow to Archived.

This changes the Work_Status field of the workflow to WAPI.WORK_STATUS_ARCHIVED.

Use a WAPIWORK object returned from a previous call to WAPI.AllocWork().

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o CallSubWork 
 Integer CallSubWork(
               WAPIWORK work )

Initiates a Sub-Workflow using the information supplied in a previous call to WAPI.PrepareSubMap() or WAPI.PrepareSubWork().

Parameters:
work  -  The WAPIWORK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o ColumnStringToValue 
 RecArray ColumnStringToValue(
                    WAPISESSION session,
                    RecArray array,
                    String colName )

Converts the values returned by a call to WAPI.WorkList() from Strings to their true values.

Some pieces of data are stored as Strings or BLOBs in the WAPI database. To improve performance these values are returned as Strings and not their original type. If the original type of the data is required this call is used to convert the data from a String back to the original type.

Parameters:
session  -  The WAPISESSION object handle.
array  -  The returned RecArray.
colName  -  The name of the column whose values should be converted.
Returns:
A RecArray with the values of the specified column name converted from a String to their original types.
o DeleteMapByID 
 Integer DeleteMapByID(
                WAPISESSION session,
                Integer mapID )

Deletes the Map from the Map database with the specified mapID.

Parameters:
session  -  The WAPISESSION object handle.
mapID  -  The ID of the desired Map.
Returns:
(Integer 0) if successful; Error otherwise.
o DeleteMapTask 
 Integer DeleteMapTask(
                WAPIMAPTASK task )

Deletes the task from the map definition. This task was determined using WAPI.AllocMapTask() or WAPI.AllocNthMapTask().

Parameters:
task  -  The WAPIMAPTASK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o DeleteTaskLink 
 Integer DeleteTaskLink(
                 WAPIMAPTASK fromTask,
                 Integer linkType,
                 WAPIMAPTASK toTask )

Deletes the link from the specified tasks.

Parameters:
fromTask  -  The WAPIMAPTASK handle specifying the task the link comes from.
linkType  -  Specifies a constant indicating the link type, can be:
 WAPI.MAPTASK_FALSELINKS
 WAPI.MAPTASK_LOOPLINKS
 WAPI.MAPTASK_TRUELINKS
toTask  -  The WAPIMAPTASK handle specifying the task the link goes to.
Returns:
(Integer 0) if successful; Error otherwise.
o DeleteWork 
 Integer DeleteWork(
               WAPIWORK work,
               Integer workID )

Deletes the specified Stopped or Completed workflow.

Use a WAPIWORK object returned from a previous call to WAPI.AllocWork().

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o DeleteWorkData 
 Integer DeleteWorkData(
                 WAPIWORK work,
                 Integer type,
                 Integer subtype )

Deletes data from the Data Package specified by the type and subtype.

Use a WAPIWORK object returned from a previous call to WAPI.AccessWork().

Parameters:
work  -  The WAPIWORK object handle.
type  -  The type of data in the Data Package.
subtype  -  The subtype of data in the Data Package.
Returns:
(Integer 0) if successful; Error otherwise.
o FreeMap 
 Integer FreeMap(
             WAPIMAP map )

Frees the memory held by the WAPIMAP object.

Parameters:
map  -  The WAPIMAP object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o FreeMapTask 
 Integer FreeMapTask(
               WAPIMAPTASK task )

Frees the memory held by the WAPIMAPTASK object.

Parameters:
task  -  The WAPIMAPTASK handle.
Returns:
(Integer 0) if successful; Error otherwise.
o FreeSession 
 Integer FreeSession(
               WAPISESSION session )

Logs out the WAPISESSION object and frees any associated memory.

Parameters:
session  -  The WAPISESSION object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o FreeSubWork 
 Integer FreeSubWork(
               WAPISUBWORK subWork )

Frees the memory held by the WAPISUBWORK object.

Parameters:
subWork  -  The WAPISUBWORK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o FreeWork 
 Integer FreeWork(
              WAPIWORK work )

Frees the memory held by the WAPIWORK object.

Parameters:
work  -  The WAPIWORK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o GetTaskLinks 
 List GetTaskLinks(
             WAPIMAPTASK task,
             Integer linkType )

Gets a List of the task ids for all links of the specified types for the specified task.

Parameters:
task  -  The WAPIMAPTASK handle.
linkType  -  Specifies a constant indicating the link type, can be:
 WAPI.MAPTASK_FALSELINKS
 WAPI.MAPTASK_LOOPLINKS
 WAPI.MAPTASK_TRUELINKS
Returns:
A List of task ids if successful; Error otherwise.
o GetWorkData 
 Dynamic GetWorkData(
               WAPIWORK work,
               Integer type,
               Integer subtype )

Gets the data from the specified type and subtype stored in the data package.

Parameters:
work  -  The WAPIWORK object handle.
type  -  The type of data in the Data Package.
subtype  -  The subtype of data in the Data Package.
Returns:
The data from the data package; Error otherwise.
o LLMapToWMap 
 Integer LLMapToWMap(
               WAPIMAP map,
               RecArray mapInfo,
               RecArray tasks,
               RecArray links )

Takes a map definition from Livelink OScript and converts it to a WAPIMAP definition.

Parameters:
map  -  The WAPIMAP object handle.
mapInfo  -  A RecArray with only one row which describes various properties of the map.
tasks  -  A RecArray with one row for each task to add to the map definition.
links  -  A RecArray with one row for each link to add to the map definition.
Returns:
(Integer 0) if successful; Error otherwise.
o ListWorkData 
 RecArray ListWorkData(
                 WAPIWORK work,
                 [Boolean allWork )

Returns the data that was stored for the specified work.

Parameters:
work  -  The WAPIWORK object handle.
allWork  -  Optional parameter used to specify whether all the data, including any subworkflow data, should be returned. By default allWork is set to False.
Returns:
A RecArray of work data if successful; error otherwise.
o LoadMapByID 
 Integer LoadMapByID(
               WAPIMAP map,
               Integer mapID )

Loads the map information from the Map database for the map with the specified ID.

Allocate a WAPIMAP object then use this call to populate the WAPIMAP data.

Parameters:
map  -  The WAPIMAP object handle.
mapID  -  The ID for the desired map.
Returns:
(Integer 0) if successful; Error otherwise.
o LoadTaskStatus 
 RecArray LoadTaskStatus(
                  WAPISESSION session,
                  Integer workID,
                 [Integer subWorkID],
                 [Integer taskID] )

Loads the task information for the specified workID, subWorkID, and taskID.

If only the workID is specified then the returned RecArray will contain 1 row for every task in every subWork for the work with the given workID. If the workID and subWorkID are specified then the RecArray will contain 1 row for every task in the subWork for the given workID and subWorkID. If the workID, subWorkID, and taskID are specified then only 1 row will be returned for the desired task.

Parameters:
session  -  The WAPISESSION object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The optional subWorkID for the desired sub-workflow.
taskID  -  The optional taskID for the desired workflow task.
Returns:
A RecArray of task information if successful; Error otherwise.
o LoadWorkAudit 
 RecArray LoadWorkAudit(
                 WAPISESSION session,
                 Integer workID,
                [Integer subWorkID],
                [Integer taskID] )

Loads the audit trail for the specified workID, subWorkID, and taskID.

If only the workID is specified then the returned RecArray will contain the audit information for every subWork and task for the work with the given workID. If the workID and subWorkID are specified then the RecArray will contain the audit information for the given workID and subWorkID. If the workID, subWorkID, and taskID are specified then only the audit information for the desired task will be returned.

Parameters:
session  -  The WAPISESSION object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The optional subWorkID for the desired sub-workflow.
taskID  -  The optional taskID for the desired workflow task.
Returns:
A RecArray of audit information if successful; Error otherwise.
o LoadWorkStatus 
 List LoadWorkStatus(
              WAPISESSION session,
              Integer workID,
             [Integer subWorkID],
             [Integer taskID] )

Loads the information for a workflow. You can optionally limit the amount of data returned by specifying a subWorkID and a taskID. A List of 3 RecArrays is returned where the first RecArray contains information about the workflow as a whole, the second RecArray contains information about the sub-workflows, and the third RecArray contains information about the workflow tasks.

Parameters:
session  -  The WAPISESSION object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The optional subWorkID for the desired sub-workflow.
taskID  -  The optional taskID for the desired workflow task.
Returns:
A List of 3 RecArrays if successful; Error otherwise.
o PrepareMap 
 Integer PrepareMap(
               WAPIWORK work,
               WAPIMAP map,
              [Integer flags] )

Saves the map definition to the map database and sets up the work object for workflow initiation.

Parameters:
work  -  The WAPIWORK object handle.
map  -  The WAPIMAP object handle for the desired map.
flags  - 

Optional flag values to control the map. The available values are:
WAPI.MAP_FLAG_ARCHIVEONCOMPLETE
WAPI.MAP_FLAG_DELETEONCOMPLETE
WAPI.MAP_FLAG_EMAILATTACHMENTASFILE
WAPI.MAP_FLAG_EMAILATTACHMENTASLINK
WAPI.MAP_FLAG_RESUMEONRETURN
WAPI.MAP_FLAG_SKIPWEEKENDS
WAPI.MAP_FLAG_TEMPMAP
Returns:
(Integer 0) if successful; Error otherwise.
o PrepareSubMap 
 Integer PrepareSubMap(
                WAPIWORK work,
                WAPIMAP map,
               [Integer flags] )

Saves the map definition to the map database and sets up the work object to initiate the map as a sub-workflow.

Parameters:
work  -  The WAPIWORK object handle.
map  -  The WAPIMAP object handle for the desired map.
flags  -  Optional flag values to control the map. The available values are:
WAPI.MAP_FLAG_ARCHIVEONCOMPLETE
WAPI.MAP_FLAG_DELETEONCOMPLETE
WAPI.MAP_FLAG_EMAILATTACHMENTASFILE
WAPI.MAP_FLAG_EMAILATTACHMENTASLINK
WAPI.MAP_FLAG_RESUMEONRETURN
WAPI.MAP_FLAG_SKIPWEEKENDS
WAPI.MAP_FLAG_TEMPMAP
Returns:
(Integer 0) if successful; Error otherwise.
o PrepareSubWork 
 Integer PrepareSubWork(
               WAPIWORK work,
               Integer mapID,
              [Integer flags] )

Sets up the work object to initiate the specified map as a subworkflow.

Parameters:
work  -  The WAPIWORK object handle.
mapID  -  The ID of the desired Workflow Map.
flags  -  Optional flag values to control the map. The available values are:
WAPI.MAP_FLAG_ARCHIVEONCOMPLETE
WAPI.MAP_FLAG_DELETEONCOMPLETE
WAPI.MAP_FLAG_EMAILATTACHMENTASFILE
WAPI.MAP_FLAG_EMAILATTACHMENTASLINK
WAPI.MAP_FLAG_RESUMEONRETURN
WAPI.MAP_FLAG_SKIPWEEKENDS
WAPI.MAP_FLAG_TEMPMAP
Returns:
(Integer 0) if successful; Error otherwise.
o PrepareWork 
 Integer PrepareWork(
               WAPIWORK work,
               Integer mapID,
              [Integer flags] )

Sets up the work object to initiate the specified map as a workflow.

Parameters:
work  -  The WAPIWORK object handle.
mapID  -  The ID of the desired Workflow Map.
flags  -  Optional flag values to control the map. The available values are:
WAPI.MAP_FLAG_ARCHIVEONCOMPLETE
WAPI.MAP_FLAG_DELETEONCOMPLETE
WAPI.MAP_FLAG_EMAILATTACHMENTASFILE
WAPI.MAP_FLAG_EMAILATTACHMENTASLINK
WAPI.MAP_FLAG_RESUMEONRETURN
WAPI.MAP_FLAG_SKIPWEEKENDS
WAPI.MAP_FLAG_TEMPMAP
Returns:
(Integer 0) if successful; Error otherwise.
o ReassignTask 
 Integer ReassignTask(
                WAPIWORK work,
                Integer workID,
                Integer subWorkID,
                Integer taskID,
                Integer userID )

Reassigns the task specified by the workID, subWorkID, and taskID to the given userID.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The subWorkID for the desired workflow.
taskID  -  The taskID for the desired workflow task.
userID - The ID of the user to which the task should be reassigned.
Returns:
(Integer 0) if successful; Error otherwise.
o ReplaceMap 
 Integer ReplaceMap(
               WAPIMAP map )

Saves the modified map definition to the map database replacing the original.

Parameters:
map  -  The WAPIMAP object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o ResumeWork 
 Integer ResumeWork(
               WAPIWORK work,
               Integer workID )

Sets the status of a suspended workflow to Executing.

This changes the Work_Status field of the workflow to WAPI.WORK_STATUS_EXECUTING.

Use a WAPIWORK object returned from a previous call to WAPI.AllocWork().

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o SaveMap 
 Integer SaveMap(
             WAPIMAP map)

Saves a WAPIMAP map definition to the map database.

Parameters:
map  -  The WAPIMAP object handle.
Returns:
The ID for the new map if successful; Error otherwise.
o SetCallback 
 Integer SetCallback(
               WAPISESSION session,
               Dynamic feature,
              [Dynamic object] )

Specifies the WAPI callback routine and context argument that is passed to the callback.

Parameters:
session  -  The WAPISESSION object handle.
feature  -  The name of the script to execute.
object  -  The optional object that contains the script.
Returns:
(Integer 0) if successful; Error otherwise.
o SetWorkData 
 Integer SetWorkData(
               WAPIWORK work,
               Integer type,
               Integer subtype,
               [String description],
               Dynamic value )

Sets data stored in a data package.

Parameters:
work  -  The WAPIWORK object handle.
type  -  The type of the data.
subtype  -  The subtype of the data.
description  -  The optional description of the data.
value  -  The data to store.
Returns:
(Integer 0) if successful; Error otherwise.
o StartTask 
 Integer StartTask(
              WAPIWORK work,
              Integer workID,
              Integer subWorkID,
              Integer taskID,
              Integer flags )

Marks the specified task as started and sets up the WAPIWORK object handle to be able to access the work package.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The subWorkID for the desired workflow.
taskID  -  The taskID for the desired workflow task.
flags - A flag for StartTask options. This flag can be combined by Bitwise OR using the following constants:
 WAPI.STARTTASK_FLAG_REEXECUTE
 WAPI.STARTTASK_FLAG_NOAUDIT
Returns:
(Integer 0) if successful; Error otherwise.
o StartWork 
 Integer StartWork(
              WAPIWORK work,
              [String title] )

Initiates a workflow that was prepared with a call to WAPI.PrepareWork() and readies any initial tasks.

Parameters:
work  -  The WAPIWORK object handle.
title  -  The optional title of the Workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o StopWork 
 Integer StopWork(
              WAPIWORK work,
              Integer workID )

Sets the status of an Executing or Suspended workflow to Stopped.

This changes the Work_Status field of the workflow to WAPI.WORK_STATUS_STOPPED.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o SuspendWork 
 Integer SuspendWork(
               WAPIWORK work,
               Integer workID )

Sets the status of an Executing workflow to Suspended.

This changes the Work_Status field of the workflow to WAPI.WORK_STATUS_SUSPENDED.

Use a WAPIWORK object returned from a previous call to WAPI.AllocWork().

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o TaskAuditUserData 
 Integer TaskAuditUserData(
                  WAPIWORK work,
                  Integer workID,
                  Integer subWorkID,
                  Integer taskID,
				  Dynamic data,
                  [Integer iterNum])

Adds a row to the audit trail and stores the specified data. Even though the iterNum parameter is optional, if not specified the iternum will be accessed from the appropriate Workflow database table by using the workID, subworkID and taskID. If you already have the iterNum, it is more efficient to pass it in instead of having the function access it.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The work ID of the Workflow
subworkID  -  The subwork ID of the Workflow
taskID  -  The task ID of the task
data  -  The data to store.
iterNum  -  The optional iteration number for this specific task
Returns:
(Integer 0) if successful; Error otherwise.
o TaskCancel 
 Integer TaskCancel(
              WAPIWORK work )

Notifies the workflow engine that work on this task is completed for the time being but skip marking the task as Done and send the workflow on to the next step.

Parameters:
work  -  The WAPIWORK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o TaskDone 
 Integer TaskDone(
              WAPIWORK work,
             [Dynamic linkType] )

Marks the task as Done and takes the paths from the task that are of the specified link type. If the linkType is not specified, then the True/Normal paths will be taken.

Parameters:
work  -  The WAPIWORK object handle.
linkType  -  The optional type of link paths that should be taken from this step.
Returns:
(Integer 0) if successful; Error otherwise.
o UpdateSubWorkAttribute 
 Integer UpdateSubWorkAttribute(
                     WAPIWORK work,
                     Integer workID,
                     Integer subWorkID,
                     Integer attribute,
                     Dynamic value )

Updates the value of a subWork attribute for a workflow.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The subWorkID for the desired workflow.
attribute  -  Specifies a constant indicating the subWork attribute. Acceptable values are:
WAPI.SUBWORK_TITLE
WAPI.SUBWORK_PROJECT
WAPI.SUBWORK_FLAGS
WAPI.SUBWORK_USERDATA
WAPI.SUBWORK_CUSTOMDATA
value
-
 The new value for the attribute.
Returns:
(Integer 0) if successful; Error otherwise.
o UpdateSubWorkPrepare 
 Integer UpdateSubWorkPrepare(
                    WAPIWORK work,
                    WAPIMAP map,
                    Integer workID,
                    Integer subWorkID )

Prepares the map and work object for a workflow already in-process for update. The new map definition is saved to the map database. The in-process workflow must be suspended in order for this call to succeed.

Parameters:
work  -  The WAPIWORK object handle.
map  -  The WAPIMAP object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The subWorkID for the desired workflow.
Returns:
(Integer 0) if successful; Error otherwise.
o UpdateSubWorkStart 
 Integer UpdateSubWorkStart(
                   WAPIWORK work )

Updates the in-process workflow specified by work. This is used after a call to WAPI.UpdateSubWorkPrepare(). Here, the work information is updated, and the workflow is made to now point to the new map definition.

Parameters:
work  -  The WAPIWORK object handle.
Returns:
(Integer 0) if successful; Error otherwise.
o UpdateTaskAttribute 
 Integer UpdateTaskAttribute(
                   WAPIWORK work,
                   Integer workID,
                   Integer subWorkID,
                   Integer taskID,
                   Integer attribute,
                   Dynamic value )

Updates the value of a task attribute for a workflow.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
subWorkID  -  The subWorkID for the desired workflow.
taskID  -  The taskID for the desired task.
attribute - Specifies a constant indicating the task attribute. Acceptable values are:
WAPI.SUBWORKTASK_TITLE
WAPI.SUBWORKTASK_USERCOMMENT
WAPI.SUBWORKTASK_PERFORMERID
WAPI.SUBWORKTASK_USERSTATUS
WAPI.SUBWORKTASK_FLAGS
WAPI.SUBWORKTASK_USERDATA
WAPI.SUBWORKTASK_CUSTOMDATA
value - The new value for the attribute.
Returns:
(Integer 0) if successful; Error otherwise.
o UpdateWorkAttribute 
 Integer UpdateWorkAttribute(
                   WAPIWORK work,
                   Integer workID,
                   Integer attribute,
                   Dynamic value )

Updates the value of a work attribute.

Parameters:
work  -  The WAPIWORK object handle.
workID  -  The workID for the desired workflow.
attribute  - 

Specifies a constant indicating the work attribute. Acceptable values are:
WAPI.WORK_TITLE
WAPI.WORK_PROJECT
WAPI.WORK_MANAGERID
WAPI.WORK_FLAGS
WAPI.WORK_USERDATA
WAPI.WORK_CUSTOMDATA

value  -  The new value for the attribute.
Returns:
(Integer 0) if successful; Error otherwise.
o WorkList 
 RecArray WorkList(
               WAPISESSION session,
               String viewName,
               Dynamic whereClause,
               Integer flags )

Returns workflow information using the specified view, SQL "where" clause, and flags. If specific workflow information is required, a view can be constructed in the database schema, and this call can be used to select rows from that view.

Parameters:
session  -  The WAPISESSION object handle.
viewName  -  The view to do the select from
whereClause  -  An SQL "where" clause if one is desired, 0 or Undefined if not.
flags  -  Flag value for built-in "where" clauses. These flags can be combined by Bitwise OR using the following constants:
WAPI.LIST_IFINITIATED
WAPI.LIST_IFMANAGED
WAPI.LIST_IFPERFORMER
Returns:
A RecArray of work information if successful; Error otherwise.
o WorkList2 
 RecArray WorkList2(
               WAPISESSION session,
               String viewName,
               Dynamic whereClause,
               Dynamic orderby,
               Integer flags )

Returns ordered Workflow information using the specified view, SQL "where" clause, SQL “orderby” clause and flags. If specific Workflow information is required, a view can be constructed in the database schema, and this call can be used to select rows from that view.

Parameters:
session  -  The WAPISESSION object handle.
viewName  -  The view to do the select from
whereClause  -  An SQL "where" clause if one is desired, 0 or Undefined if not.
orderby  -  An SQL "orderby" to order the results.
flags  -  Flag value for built-in "where" clauses. These flags can be combined by Bitwise OR using the following constants:
WAPI.LIST_IFINITIATED
WAPI.LIST_IFMANAGED
WAPI.LIST_IFPERFORMER
Returns:
A RecArray of work information if successful; Error otherwise.