Get Business Object Data

Retrieves an existing business object data based on the specified parameters.

Delegate Class

org.finra.dm.service.activiti.task.GetBusinessObjectData

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
namespace	Y			N	The namespace.
businessObjectDefinitionName	Y			N	The name of the business object definition (e.g. NEW_ORDERS).
businessObjectFormatUsage	Y			N	The business object format usage (e.g. PRC).
businessObjectFormatFileType	Y			N	The business object format file type (e.g. GZ).
partitionKey	Y			N	The partition key of the business object format (e.g. PROCESS_DATE).
partitionValue	Y			Y	The partition value of the business object data (e.g. 2014-07-21).
subPartitionValues	N			Y	A list of sub partition values delimited by the pipe character ( | ). Delimiter can be escaped by a backslash ( \ ).
businessObjectFormatVersion	N	Integer		N/A	The version of the business object format (e.g. 0). When format version is not specified, the business object data with the latest business format version available for the specified partition value is returned back.
businessObjectDataVersion	N	Integer		N/A	The version of the business object data (e.g. 0). When data version is not specified, the latest business object data is returned back.

Please note:

When both businessObjectFormatVersion and data version are not specified, the businessObjectFormatVersion has the precedence. First, the latest businessObjectFormatVersion is determined by a subquery, which does the following:

1. selects all available data for the specified business object format (disregarding businessObjectFormatVersion) and specified partition value
2. gets the maximum businessObjectFormatVersion value from the records selected in step 1.

Output Parameters

Name	Description
{taskId}_jsonResponse	The business object data in JSON. Please refer to Business Object Data Get for details.

Sample Usage in Activiti XML

<serviceTask id="GetBusinessObjectData" name="Get business object data" activiti:class="org.finra.dm.service.activiti.task.GetBusinessObjectData">
   <extensionElements>
      <activiti:field name="namespace" expression="${namespace}"/>
      <activiti:field name="businessObjectDefinitionName" expression="${businessObjectDefinitionName}"/>
      <activiti:field name="businessObjectFormatUsage" expression="${businessObjectFormatUsage}"/>
      <activiti:field name="businessObjectFormatFileType" expression="${businessObjectFormatFileType}"/>
      <activiti:field name="partitionKey" expression="${partitionKey}"/>
      <activiti:field name="partitionValue" expression="${partitionValue}"/>
      <activiti:field name="subPartitionValues" expression="${subPartitionValues}"/>
      <activiti:field name="businessObjectFormatVersion" expression="${businessObjectFormatVersion}"/>
      <activiti:field name="businessObjectDataVersion" expression="${businessObjectDataVersion}"/>
   </extensionElements>
</serviceTask>