Update Complete BP Record

Description

This method updates a record in Unifier. It also provides the ability to add attachments to the upper form. It will not delete existing attachments.

Support

This service is available at both company-level and project/shell-level BPs of type non-workflow Line Item type and can only update information on upper form. Line items will be ignored. Additionally, the service is also available at project/shell level for Cost (Non-Payment type), Simple, Text type, and Document Type (Basic and Advanced) business process. In these cases, too, the service can only update information on upper form. Line items will be ignored.

Installation

ASP and Self host

Level	Yes or No
Company Level	Yes
Project/Shell Level	Yes

Prototype

public XMLObject updateCompleteBPRecord(String shortname, String authcode, string projectNumber, String BPName, String BPXML, String iszipfile, FileObject[] fileobjects );

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/shell in Unifier.
BPName	Identifier of the BP
BPXML	Content of the BP that needs to be updated
iszipfile	This tag identifies if the file provided under the fileobjects tag is a zip file or not. Values for this tag are "yes" or "no".
fileobjects	Array of FileObjects, each FileObject is made up of two components: String filename (this should be the same name as in the record data <_attachment><filename> tag, and javax.activation.DataHandler as filestream. Files can be sent as a single zipped file or individual files.

BPXML Elements

The BPXML Elements are based on BP design. To use this method, the user must first use getBPRecord service. getBPRecord service will provide user with valid XML elements that are part of BP design.

If you want to update record for a BP at company level, do not pass projectnumber parameter.

If you send invalid projectnumber, you will get an error.

<record_no> tag as part of <_bp> element is required while send updateBPRecord message.

Attachments can be added only to the upper form.

Files can be sent as a single zipped file or individual files for the complete transaction record, the same file can be referenced multiple times in the same transaction. However, files contained in the zip file should still be described by separate attachment elements.

API

This API requires Integration Design to be published in uDesigner for the business process.

Attachment file cross references is not supported. The reference sub element under attachments should always have the value ‘No'.

Adding attachments is optional. If attachment elements are not provided, the API behaves exactly like updateBPRecord API.

Note: This API is not compatible with non Java web services client platforms.

Total attachment size per request across all files is limited to 250 MB. It is recommended that files are compressed into 1 zip file for submission to the API.

This service can be used for Projects/Shells of cost code type CBS and Generic.

Return Value

See Appendix A: Return Values.