DTD Formats

Table A-1 Audit DTD Element

Element	Description	Example Value
actions	Defines the actions that were performed. Defines zero or more occurrences of the following subelements: error setvariable activatetask dotask marktaskdone unmarktaskdone unassigntask settaskcomment settaskpriority settaskproperties settaskduedate rerouted assigntask instantiated auditentry evaluatecondition workflowaborted setworkflowcomment	See Audit DTD Example.
activatetask	Defines the following attributes: time: Time at which the task was activated. taskid: ID of the task that has been activated. name: Name of the task that has been activated.	<activatetask time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
assigntask	Defines the following attributes: time: Time at which the task was assigned. taskid: ID of the task that has been assigned. name: Name of the task that has been assigned.	<assigntask time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
auditentry	Defines the following attributes: time: Time at which the audit entry was logged. taskid: ID of the task for which an audit entry has been logged. name: Name of the task that for which an audit entry has been logged.	<auditentry time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
completed	Time at which the task execution completed.	<completed>2001-06-12 12:45:45.115 </completed>
dotask	Defines the following attributes: time: Time at which the task was executed. taskid: ID of the task that has been executed. name: Name of the task that has been executed.	<dotask time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
error	Defines the following attributes: time: Time at which the error occurred. id: Error ID.	<error time="2001-06-12 12:45:44.824" id="2"/>
evaluatecondition	Defines the following attributes: time: Time at which a condition was evaluated. taskid: ID of the task for which a condition has been evaluated. name: Name of the task for which the condition has been evaluated.	<evaluatecondition time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
instanceid	ID of the workflow instance that is the target of the response document.	<instanceid> 2 </instanceid>
instantiated	Defines the following attributes: time: Time at which the task was instantiated. name: ID of the task that has been instantiated.	<instantiated time="2001-06-12 12:45:44.824" name="Start Test"/>
marktaskdone	Defines the following attributes: time: Time at which the task was marked complete. taskid: ID of the task that has been marked as complete. name: Name of the task that has been marked as complete.	<marktaskdone time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
requestor	ID requestor.	<requestor> wlpisystem </requestor>
rerouted	Defines the following attributes: time: Time at which the task was rerouted. taskid: ID of the task that has been rerouted. name: Name of the task that has been rerouted.	<rerouted time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
settaskcomment	Defines the following attributes: time: Time at which the task comment was set. taskid: ID of the task for which a comment has been set. name: Name of the task for which a comment has been set.	<settaskcomment time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"> This is a comment. </settaskcomment>
settaskduedate	Defines the following attributes: time: Time at which the task due date was set. taskid: ID of the task for which a task due date has been set. name: Name of the task for which a task due date has been set.	<settaskduedate time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"> </settaskduedate>
settaskpriority	Defines the following attributes: time: Time at which the task priority was set. taskid: ID of the task for which a priority has been set. name: Name of the task for which a priority has been set.	<settaskpriority time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"> </settaskpriority>
settaskproperties	Defines the following attributes: time: Time at which the task properties were set. taskid: ID of the task for which properties have been set. name: Name of the task for which properties have been set.	<settaskproperties time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"> </settaskproperties>
setvariable	Defines the following attributes: time: Time at which the variable was set. variable: Name of the variable in XML name token (NMTOKEN) format.	<setvariable time="2001-06-12 12:45:44.824" variable="test1"> value1 </setvariable>
setworkflowcomment	Defines the following attributes: time: Time at which the workflow comment was set. taskid: ID of the task for which a comment has been set. name: Name of the task for which a comment has been set.	<setworkflowcomment time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"> </setworkflowcomment>
started	Time at which the task execution started.	<started> 2001-06-12 12:45:44.824 </started
templatedefinitionid	ID of the workflow template definition that is the target of the response document.	<templatedefinitionid> 2 </templatedefinitionid>
templateid	ID of the workflow template that is the target of the response document.	<templateid> 2 </templateid>
template-name	Name of the workflow template.	<template-name> Start Test </template-name>
unassigntask	Defines the following attributes: time: Time at which the task was unassigned. taskid: ID of the task for which assignment has been revoked. name: Name of the task for which assignment has been revoked.	<unassigntask time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
unmarktaskdone	Defines the following attributes: time: Time at which the task was marked as incomplete. taskid: ID of the task that has been marked as incomplete. name: Name of the task that has been marked as incomplete.	<unmarktaskdone time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>
wlpirequest	Defines the request, including the following subelements: started requestor templateid templatedefinitionid instanceid actions completed	See Audit DTD Example.
wlpiresponse	Root element. Defines the following subelements: instanceid templatedefinitionid wlpirequest	See Audit DTD Example.
workflowaborted	Defines the following attributes: time: Time at which the workflow was aborted. taskid: ID of the task that caused the workflow to be aborted. name: Name of the task that has been marked as incomplete.	<workflowaborted time="2001-06-12 12:45:44.824" taskid="2" name="Task 1"/>

Element	Description	Example Value
calendar	Root element. You must define the following subelements: id name timezone interval (zero or more)	See Business Calendar DTD Example.
date	Date to be included or excluded. This date must be specified using the following format: month dd, yyyy where month specifies the name of the month (such as January), dd specifies the day, and yyyy specifies the year.	<date> December 25, 2001 </date>
dateinterval	Interval of time to be included in or excluded from the calendar. You must define the following subelements: fromdate todate	<dateinterval> <fromdate> January 1, 2001 </fromdate> <todate> January 1, 2002 </todate> </dateinterval>
days	Day to be included or excluded. The value of this element is a text string specifying the name of the day (such as Sunday).	<days>Saturday</days>
exclude	Rule that defines an interval of time to be excluded from the main interval. You can define the following subelements: months (zero or more) days (zero or more) date (zero or more) timeinterval (zero or more) dateinterval (zero or more)	<exclude> <days> Saturday, Sunday </days> <date> January 1, 2001 </date> </exclude>
fromdate	Subelement of interval or dateinterval. When used as subelement of interval, specifies the start date for an interval. When used as subelement of dateinterval, it is specific to the include or exclude. This date must be specified using the following format: month dd, yyyy where month specifies the name of the month (such as January), dd specifies the day, and yyyy specifies the year.	<fromdate> January 1, 2001 </fromdate>
fromtime	Start time from which the business calendar is in effect, or a subelement of timeinterval, in which case it specifies a range of time to include or exclude. This time must be specified using the following format: hh:mm, where hh specifies the hour and mm specifies the minutes.	08:00
id	Unique ID.	<id>10234</id>
include	Rule that defines an interval of time to be included in the main interval. You can define the following subelements: months (zero or more) days (zero or more) date (zero or more) timeinterval (zero or more) dateinterval (zero or more)	<include> <timeinterval> 08:00, 17:00 </timeinterval> </include>
interval	Interval of time that the calendar is in effect. You must define the following subelements: fromdate todate exclude (zero or more) include (zero or more)	<interval> <fromdate> 20010101 </fromdate> <todate> 20020101 </todate> <exclude> <date> 20011225 </date> <days> Saturday, Sunday </days> </exclude> <include> <timeinterval> 08:00. 17:00 </timeinterval> </include> </interval>
months	Month to be included or excluded. The value of this element is a text string specifying the name of the month (such as January).	<months> August </months>
name	Calendar name.	<name> MyCalendar </name>
timeinterval	Interval of time to be included in or excluded from the calendar. You must define the following subelements: fromtime totime	<timeinterval> <fromtime> 17:00:00 </fromtime> <totime> 08:00:00 </totime> </timeinterval>
timezone	Calendar time zone. (See Note following table for valid values.)	<timezone> EST </timezone>
todate	Date until which the business calendar remains in effect. This date must be specified using the following format: month dd, yyyy where month specifies the name of the month (such as January), dd specifies the day, and yyyy specifies the year.	<todate> January 1, 2002 </todate>
totime	Time until which the business calendar is in effect. This time must be specified using the following format: hh:mm, where hh specifies the hour and mm specifies the minutes.	<totime>17:00</totime>

Element	Description	Example Value
call-program	Root element. You must define the following subelements: actionid parm (zero or more) env-var (zero or more) You must define the following attributes: mode: Program mode specifying whether or not the run-time client blocks while executing the client request. This value can be set to sync (synchronous mode), to block the run-time client until completion of the request, or async (asynchronous mode), to execute the client request as a background task. This attribute defaults to async. name: Program name. This attribute is required.	See Client Call Program Request DTD Example.
actionid	Action ID.	<actionid> 992456131534 </actionid>
parm	Parameter definition. This value can be any character string.	<parm> C:\WLPI\readme.txt </parm>
env-var	Environment variable definition. You must define a name attribute that specifies the name of the environment variable in XML name token (NMTOKEN) format.	<env-var name="TEMP"> C:\TEMP </env-var>

Element	Description	Example Value
call-addin	Request for client to call a java addin that is compliant with the Client Call Addin Request DTD.	See Client Call Addin Request DTD Example.
call-program	Request for client to call an external program that is compliant with the Client Call Program Request DTD.	See Client Call Program Request DTD Example.
custom	Custom request consisting of any combination of elements and text.
instanceid	ID of the workflow instance that is the target of the response document.	<instanceid> 3 </instanceid>
message-box	Request for client to respond to a message that is compliant with the Client Message Box Request DTD.	See Client Message Box Request DTD Example.
set-variables	Request for client to set variables that is compliant with the Client Set Variables Request DTD.	See Client Set Variables Request DTD Example.
templatedefinitionid	ID of the workflow template definition that is the target of the response document.	<templatedefinitionid> 2 </templatedefinitionid>
wlpiresponse	Root element. You must define the following subelements: wlpiresponse instanceid templatedefinitionid call-program \| call-addin \| set-variables \| message-box \| custom (zero or more)

Element	Meaning
calladdin	Client Call Addin Request DTD, ClientCallAddInReq.dtd
callpgm	Client Call Program Request DTD, ClientCallPgmReq.dtd
msgbox	Client Message Box Request DTD, ClientMsgBoxReq.dtd
setvars	Client Set Variables Request DTD, ClientSetVarsReq.dtd

Element	Description	Example Value
actionid	Action ID.	<actionid> 991408825931 </actionid>
set-variables	Root element. You must define the following subelements: actionid variable (one or more) You can also define the title attribute to specify the text that appears in the title field of the set variables box. This attribute is optional.	See Client Set Variables Request DTD Example.
variable	Variable to be set. You must define the following attributes: name: Name of the variable to be set, specified in XML name token (NMTOKEN) format. This attribute is required. prompt: Text displayed in a dialog box as a cue to the user, specified in XML name token (NMTOKEN) format. This attribute is optional.	<variable name="ShipToState" prompt="An error has occurred in processing this order. Please enter the valid US state abbreviation for shipping:"> </variable>


	BEA Home \| Events \| Solutions \| Partners \| Products \| Services \| Download \| Developer Center \| WebSUPPORT
	e-docs.bea.com \| Site Map \| Search \| PDF Files \| Contact \| Glossary

WLI Doc Home \| BPM Topics \| Programming BPM Client Applications \| Previous Topic \| Next Topic \| Contents \| Index \| View as PDF