Infor Process Automation servlets for Inbasket functions

IPA servlets are available to perform the following Inbasket related functions:

Get task list
Get work items
Get work items for user
Get work detail (Note The XML result has URLs for add/change/delete of messages/folders/variables.)
Add workunit variable
Change workunit variable
Delete workunit variable
Add workunit folder
Change workunit folder
Delete workunit folder
Add workunit message
Change workunit message
Delete workunit message
Dispatch workunit/Take action

Each call consists of the servlet URL followed by one or more parameter name and value pairs, and the servlets return an XML document response. Details on each servlet are in the succeeding topics.

The function call mus be in the general format:

http://host:port/bpm/inbox/<function>?Param1=value1&Param2=value2&...

The <function> is case sensitive, but the parameter names are not.

The IPA servlets are very similar to the PFI Inbasket servlet, except that there is a servlet for each function instead of utilizing one servlet and using "FUNCTION=". In most cases the XML response is also the same as that of the PFI servlet, but may contain additional attributes and/or tags.

Get task list

URL: /bpm/inbox/getTasks

Parameters:


Required	Optional
dataArea	task

Example: /bpm/inbox/getTasks?dataArea=lmtest

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <USERTASKS pendingForUser="true" wu_dispatch_alert="true" msgtype="Success" returnmsg="OK" userid="lawson">
        <TASK nbrwobs="4" pending="true" id="Approver">
            <DESCRIPTION></DESCRIPTION>
            <TASKDETAILURL>/bpm/inbox/getWobs?DATAAREA=lmtest&amp;TASK=Approver&amp;STARTWUN=0&amp;NBRWUNS=10&amp;
               PAGE=NEXT</TASKDETAILURL>
        </TASK>
        <TASK nbrwobs="2" pending="true" id="FilterTask">
            <DESCRIPTION></DESCRIPTION>
            <TASKDETAILURL>/bpm/inbox/getWobs?DATAAREA=lmtest&amp;TASK=FilterTask&amp;STARTWUN=0&amp;NBRWUNS=10&amp;
             PAGE=NEXT</TASKDETAILURL>
        </TASK>
        <TASK nbrwobs="13" pending="true" id="Task1">
            <DESCRIPTION></DESCRIPTION>
            <TASKDETAILURL>/bpm/inbox/getWobs?DATAAREA=lmtest&amp;TASK=Task1&amp;STARTWUN=0&amp;NBRWUNS=10&amp;
              PAGE=NEXT</TASKDETAILURL>
        </TASK>
    </USERTASKS>
</INBASKET>

Get work items (objects)

URL: /bpm/inbox/getWobs

Parameters:


Required	Optional
dataArea task	startWun nbrWuns page (defaults to "NEXT" if not specified)

Example: /bpm/inbox/getWobs?dataArea=lmtest&task=Approver

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKOBJECTS msgtype="Success" returnmsg="OK" nbrworkunits="1" rduser="lawson" task="Approver">
        <WORKOBJECT preexec="" displayexec="displaytest.htm" workcatval="" workunit="23">
            <WORKTITLE>html display</WORKTITLE>
            <GOURL>/bpm/inbox/dispatch?DATAAREA=lmtest&amp;WORKUNIT=23&amp;TASK=Approver&amp;ACTID=2</GOURL>
            <DETAILURL>/bpm/inbox/workDetail?DATAAREA=lmtest&amp;WORKUNIT=23</DETAILURL>
            <DISPLAYEXECURL>/bpm/htmlinbasket/inbasket/execs/displaytest.htm?23|html%20display|lmtest&amp;PRODUCT=LPA
            </DISPLAYEXECURL>
            <LISTACTIONS>
                <LISTACTION action="yes"></LISTACTION>
                <LISTACTION action="no"></LISTACTION>
            </LISTACTIONS>
            <LISTMESSAGE>html display</LISTMESSAGE>
            <WORKCATEGORY></WORKCATEGORY>
            <PRODUCTLINE>lmtest</PRODUCTLINE>
            <STARTDATE>2013-01-08</STARTDATE>
            <ReAssigned>false</ReAssigned>
            <MESSAGESPENDING count="0" hasPending="false"/>
            <FOLDERSPENDING count="0" hasPending="false"/>
            <HASDISPLAYEXEC hasDisplayExec="true"/>
            <HISTORYPENDING count="0" hasPending="false"/>
            <Originator>lawson</Originator>
        </WORKOBJECT>
        <NEXTURL>/bpm/inbox/getWobs?DATAAREA=lmtest&amp;TASK=Approver&amp;STARTWUN=29&amp;
          PAGE=NEXT&amp;NBRWUNS=2</NEXTURL>
        <PREVURL></PREVURL>
    </WORKOBJECTS>
</INBASKET>

Get work items for user

URL: /bpm/inbox/getUserWobs

Parameters:


Required	Optional
dataArea	startWun nbrWuns page (defaults to "NEXT" if not specified)

Example: /bpm/inbox/getUserWobs?dataArea=lmtest&startWun=0&nbrWuns=10&page=NEXT

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKOBJECTS msgtype="Success" returnmsg="OK" nbrworkunits="1" rduser="lawson" task="lawson">
        <WORKOBJECT preexec="" displayexec="WebApp=ProcessFlowAdministrator&amp;BusClass=PfiWorkunit&amp;NavigationName=ViewWorkunit&amp;Keys=
              PfiWorkunit=20&amp;SessionKeys=" workcatval="" workunit="20">
            <WORKTITLE>Test UA LM</WORKTITLE>
            <GOURL>/bpm/inbox/dispatch?DATAAREA=lmtest&amp;WORKUNIT=20&amp;TASK=lawson&amp;ACTID=2</GOURL>
            <DETAILURL>/bpm/inbox/workDetail?DATAAREA=lmtest&amp;WORKUNIT=20</DETAILURL>
            <LISTACTIONS>
                <LISTACTION action="ApproveIt"></LISTACTION>
                <LISTACTION action="RejectIt"></LISTACTION>
            </LISTACTIONS>
            <LISTMESSAGE>Test UA LM</LISTMESSAGE>
            <WORKCATEGORY></WORKCATEGORY>
            <PRODUCTLINE>lmtest</PRODUCTLINE>
            <STARTDATE>2013-01-04</STARTDATE>
            <ReAssigned>false</ReAssigned>
            <MESSAGESPENDING count="0" hasPending="false"/>
            <FOLDERSPENDING count="0" hasPending="false"/>
            <HASDISPLAYEXEC hasDisplayExec="true"/>
            <HISTORYPENDING count="0" hasPending="false"/>
            <Originator>lawson</Originator>
        </WORKOBJECT>
        <NEXTURL>/bpm/inbox/getUserWobs?DATAAREA=lmtest&amp;TASK=lawson&amp;STARTWUN=31&amp;
           PAGE=NEXT&amp;NBRWUNS=10</NEXTURL>
        <PREVURL></PREVURL>
    </WORKOBJECTS>
</INBASKET>

Get work detail

URL: /bpm/inbox/workDetail

Parameters:


Required
dataArea workunit

Example: /bpm/inbox/workDetail?dataArea=lmtest&workunit=1

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="normal" returnmsg="OK" approdline="lmtest" wun="1">
        <FOLDERS>
            <FOLDER formname="name1" type="URL" time="Wed Jan 16 17:06:05 GMT-07:00 2013" date="Wed Jan 16 17:06:05 GMT
                -07:00 2013" attachby="lawson" filename="name1" seqNum="4">
                <FOLDERURL>http://www.cnn.com</FOLDERURL>
                <FOLDERKEY></FOLDERKEY>
            </FOLDER>
            <FOLDERADDURL>/bpm/inbox/addFolder?DATAAREA=lmtest&amp;WORKUNIT=1&amp;FLDTYPE=
                 &amp;FLDNAME=&amp;FLDURL=</FOLDERADDURL>
            <FOLDERCHGURL>/bpm/inbox/chgFolder?DATAAREA=lmtest&amp;WORKUNIT=1&amp;SEQNUM=&amp;FLDTYPE=&amp;FLDNAME=
                &amp;FLDURL=</FOLDERCHGURL>
            <FOLDERDELURL>/bpm/inbox/delFolder?DATAAREA=lmtest&amp;WORKUNIT=1&amp;SEQNUM=</FOLDERDELURL>
        </FOLDERS>
        <MESSAGES>
            <MESSAGE attachby="lawson" attachtime="Fri Jan 18 15:04:10 GMT-07:00 2013" attachdate="Fri Jan 18 15:04:10 GMT-07:00 2013" id="WU msg 1" type="Workunit" msgNum="2">
                <MESSAGECONTENT>test wu msg 1</MESSAGECONTENT>
            </MESSAGE>
            <MESSAGE attachby="lawson" attachtime="Fri Jan 18 15:04:34 GMT-07:00 2013" attachdate="Fri Jan 18 15:04:34 GMT-07:00 2013" id="Test validation 1" type="Validation" msgNum="3">
                <MESSAGECONTENT>validation 1</MESSAGECONTENT>
            </MESSAGE>
            <MESSAGEADDURL>/bpm/inbox/addMessage?DATAAREA=lmtest&amp;WORKUNIT=1&amp;MSGTYPE=
                &amp;SUBJECT=&amp;CONTENT=</MESSAGEADDURL>
            <MESSAGECHGURL>/bpm/inbox/chgMessage?DATAAREA=lmtest&amp;WORKUNIT=1&amp;MSGNUM=
                &amp;MSGTYPE=&amp;SUBJECT=&amp;CONTENT=</MESSAGECHGURL>
            <MESSAGEDELURL>/bpm/inbox/delMessage?DATAAREA=lmtest&amp;WORKUNIT=1&amp;MSGNUM=</MESSAGEDELURL>
        </MESSAGES>
        <WORKHISTORY/>
        <WUVARIABLES nbrvars="6">
            <VARIABLE type="String" name="FileName">/inbound/test1.txt</VARIABLE>
            <VARIABLEADDURL>/bpm/inbox/addVariable?DATAAREA=lmtest&amp;WORKUNIT=1&amp;
               VARNAME=&amp;VARTYPE=&amp;VARVALUE=</VARIABLEADDURL>
            <VARIABLECHGURL>/bpm/inbox/chgVariable?DATAAREA=lmtest&amp;WORKUNIT=1&amp;
               VARNAME=&amp;VARVALUE=</VARIABLECHGURL>
            <VARIABLEDELURL>/bpm/inbox/delVariable?DATAAREA=lmtest&amp;WORKUNIT=1&amp;VARNAME=</VARIABLEDELURL>
        </WUVARIABLES>
    </WORKDETAILS>
</INBASKET>

Add workunit variable

URL: /bpm/inbox/addVariable

Parameters:


Required
dataArea workunit varName varType varValue (Boolean, Integer, Long, Double, String, Date)

Example: /bpm/inbox/addVariable?dataArea=lmtest&workunit=1&varName=a1&varType= String&varValue=aaa

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <WUVARIABLES nbrvars="1">
            <VARIABLE type="String" name="a1">aaa</VARIABLE>
        </WUVARIABLES>
    </WORKDETAILS>
</INBASKET>

Change workunit variable

URL: /bpm/inbox/chgVariable

Parameters:


Required
dataArea workunit varName varValue

Example: /bpm/inbox/chgVariable? dataArea=lmtest&workunit=1&varName=a1&varValue=New%20value

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <WUVARIABLES nbrvars="1">
            <VARIABLE type="String" name="a1">New value</VARIABLE>
        </WUVARIABLES>
    </WORKDETAILS>
</INBASKET>

Delete workunit variable

URL: /bpm/inbox/delVariable

Parameters:


Required
dataArea workunit varName

Example: /bpm/inbox/delVariable?dataArea=lmtest&workunit=1&varName=a1

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1"/>
</INBASKET>

Add workunit folder

URL: /bpm/inbox/addFolder

Parameters:


Required	Optional
dataArea workunit fldName fldUrl	fldType (URL, S3, LM, M3 - if specified fldType is invalid, defaults to URL)

Example: /bpm/inbox/addFolder? dataarea=lmtest&workunit=1&fldName=folder1&fldUrl=http://www.cnn.com&fldType=URL

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <FOLDERS>
            <FOLDER formname="folder1" type="URL" time="Wed Jan 30 10:27:54 GMT-07:00 2013" date="Wed Jan 30 10:27:54 GMT-07:00 2013" attachby="lawson" filename="folder1" seqNum="11">
                <FOLDERURL>http://www.cnn.com</FOLDERURL>
                <FOLDERKEY></FOLDERKEY>
            </FOLDER>
        </FOLDERS>
    </WORKDETAILS>
</INBASKET>

Change workunit folder

URL: /bpm/inbox/chgFolder

Parameters:


Required
dataArea workunit seqNum fldType (URL, S3, LM, M3 - defaults to URL if specified fldType is invalid) fldName fldUrl

Example: /bpm/inbox/chgFolder? dataArea=lmtest&workunit=1&seqNum=11&fldName=Yahoo&fldUrl=http://www.yahoo.com&fldType=URL

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <FOLDERS>
            <FOLDER formname="Yahoo" type="URL" time="Wed Jan 30 10:31:52 GMT-07:00 2013" date="Wed Jan 30 10:31:52 GMT-07:00 2013" attachby="lawson" filename="Yahoo" seqNum="11">
                <FOLDERURL>http://www.yahoo.com</FOLDERURL>
                <FOLDERKEY></FOLDERKEY>
            </FOLDER>
        </FOLDERS>
    </WORKDETAILS>
</INBASKET>

Delete workunit folder

URL: /bpm/inbox/delFolder

Parameters:


Required
dataArea workunit seqNum

Example: /bpm/inbox/delFolder?dataArea=lmtest&workunit=1&seqNum=11

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1"/>
</INBASKET>

Add workunit message

URL: /bpm/inbox/addMessage

Parameters:


Required
dataArea workunit msgType (Workunit, Validation, Comment, Action - defaults to Workunit if specified msgType is invalid) subject content

Example: /bpm/inbox/addMessage? dataArea=lmtest&workunit=1&subject=bad%20data&content=data&msgType=Validation

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <MESSAGES>
            <MESSAGE attachby="lawson" attachtime="Wed Jan 30 10:39:01 GMT-07:00 2013" attachdate="Wed Jan 30 10:39:01 GMT-07:00 2013" id="bad data" type="Validation" msgNum="8">
                <MESSAGECONTENT>data</MESSAGECONTENT>
            </MESSAGE>
        </MESSAGES>
    </WORKDETAILS>
</INBASKET>

Change workunit message

URL: /bpm/inbox/chgMessage

Parameters:


Required
dataArea workunit msgNum msgType (Workunit, Validation, Comment, Action - defaults to Workunit if specified msgType is invalid) subject content

Example: /bpm/inbox/chgMessage? dataArea=lmtest&workunit=1&msgNum=8&subject=new%20subject&content=new%20content&msgType=Action

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1">
        <MESSAGES>
            <MESSAGE attachby="lawson" attachtime="Wed Jan 30 10:43:09 GMT-07:00 2013" attachdate="Wed Jan 30 10:43:09 GMT-07:00 2013" id="new subject" type="Action" msgNum="8">
                <MESSAGECONTENT>new content</MESSAGECONTENT>
            </MESSAGE>
        </MESSAGES>
    </WORKDETAILS>
</INBASKET>

Delete workunit message

URL: /bpm/inbox/delMessage

Parameters:


Required
dataArea workunit msgNum

Example: /bpm/inbox/delMessage?dataArea=lmtest&workunit=1&msgNum=8

Sample output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<INBASKET>
    <WORKDETAILS msgtype="Success" returnmsg="OK" wun="1"/>
</INBASKET>

Dispatch workunit /Take action

URL: /bpm/inbox/dispatch

Parameters:


Required	Optional
dataArea workunit actId action	task reason message

Example: /bpm/inbox/dispatch? dataArea=lmtest&workunit=28&actId=2&task=Approver&reason=MyReason&message=MyMessage&action=yes

Sample output:

<?xml version="1.0" encoding="ISO-8859-1"?>
<INBASKET>
		  <WORKDISPATCH wun="23" returnmsg="Dispatched Work Object 23 Action Taken yes" msgtype="Success" >
		  </WORKDISPATCH>
</INBASKET>