Description
This method adds a BP line item to an existing business process record based on Integration design that has been defined in uDesigner. For more information refer to the Unifier uDesigner User Guide.
This method can also be used to create new BP records with line items, check LineXML elements sub-topic to find out more.
Support
This process supports all type of BPs.
Installation
ASP and Self host
Level | Yes or No |
|---|---|
Company Level | Yes |
Project or Shell Level | Yes |
Prototype
public XMLObject addBPLineItem(String shortname, String authcode, string projectNumber, string BPName, String ItemXML );
Parameters
Parameter | Description |
|---|---|
shortname | identifier of the company, company’s short name |
authcode | authentication key for the company, in text string |
projectNumber | identifier of the project or shell in Unifier |
BPName | identifier of the business process in Unifier, for example: Invoice. This is case sensitive, and should be the name as given in uDesigner |
ItemXML | identifier for line item content in XML format |
ItemXML Elements
The elements that include as part of LineXML parameter are dependent on the Integration interface design of your BP in uDesigner. ItemXML format can be exported (downloaded) from uDesigner. Elements with direction marked as "Input" or "Both" will be part of XML format.
The following is a list of elements that can be added as part of integration design and their behavior when you include them. Note that elements lists should be sent based on the type of BP for which you are creating a record.
Tag Name | BP Type | Description |
|---|---|---|
<amount> | Cost | Amount is a required field if you are sending line item information under _bp_lineitems. You will see same value on Unifier. |
<CBS_code> | Cost | CBS Code is a required field if you are sending line information under _bp_lineitems. |
<record_no> | Any | You can send record number by using this tag. If you do not specify a record_no tag as part of message then a new record will be created with the line item information that is provided as part of ItemXML If you specify a record_no then system will add new line item(s) based on the data provided as part of ItemXML If the record_no is specified and if it does not exists then a new record will be created with the line item information that is provided as part of ItemXML. |
<status> | Any | You can send record status by using this tag. This tag is valid only for multi-record BPs. If the record_no is specified and if it does not exists then a new record will be created with the line item information that is provided as part of ItemXML. If the BP is a workflow based then the record will be created and will be created and will stay in the initial status that is valid. User has to go through remaining workflow process. If it is a non-workflow based then the message can send a valid status and the record will take that status. If there is only one status defined for the BP then by default that status will be picked even if user sends a wrong status value. |
<li_group_name> | All BPs that support Summary line items other than Summary Payment Application BPs of Base Commit, Change Commit and Payment Applications. | Use to specify group name. |
Return Value
See Return Values