Check Business Object Data Availability

Performs a search and returns a list of business object data status information for a range of requested business object data in the specified storage.

Multiple partition filters support

Delegate Class

org.finra.dm.service.activiti.task.CheckBusinessObjectDataAvailabilityMultiplePartitions

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
contentType	Y	xml, json		N	Indicator whether XML or JSON is provided for businessObjectDataAvailabilityRequest.
businessObjectDataAvailabilityRequest	Y			N/A	The business object data availability request. Please refer to Business Object Data Availability Post for details.

(Deprecated) Only a single partition filter allowed

Delegate Class

org.finra.dm.service.activiti.task.CheckBusinessObjectDataAvailability

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
namespace	Y			N	The name of a valid namespace known by the system.
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).
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.
partitionKey	N			N	The partition key of the business object format (e.g. PROCESS_DATE).
partitionValues	Y (when startPartitionValue and endPartitionValue are not present)			Y	The list of partition values delimited by the pipe character ( | ).
startPartitionValue	Y (when partitionValues is not present)			Y	The start partition value for the partition value range.
endPartitionValue	Y (when partitionValues is not present)			Y	The end partition value for the partition value range.
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.
storageName	Y			N	The storage name.

Output Parameters

Name	Description
{taskId}_jsonResponse	JSON response of the business object availability. Please refer to Business Object Data Availability Post for details.
{taskId}_isAllDataAvailable	Boolean value (i.e. true or false) whether all requested data is available.

Sample Usage in Activiti XML

Multiple partition filters support

<serviceTask id="CheckBusinessObjectDataAvailabilityTaskTbd" name="Check Business Object Data Availability" activiti:class="org.finra.dm.service.activiti.task.CheckBusinessObjectDataAvailabilityMultiplePartitions">
   <extensionElements>
      <activiti:field name="contentType" stringValue="xml"/>
      <activiti:field name="businessObjectDataAvailabilityRequest" expression="${businessObjectDataAvailabilityRequest}"/>
   </extensionElements>
</serviceTask>

(Deprecated) Only a single partition filter allowed

With partition values

<serviceTask id="CheckBusinessObjectDataAvailabilityTask" name="Check Business Object Data Availability" activiti:class="org.finra.dm.service.activiti.task.CheckBusinessObjectDataAvailability">
   <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="businessObjectFormatVersion" expression="${businessObjectFormatVersion}"/> 
      <activiti:field name="partitionValues" expression="${parittionValues}"/> 
      <activiti:field name="businessObjectDataVersion" expression="${businessObjectDataVersion}"/> 
      <activiti:field name="storageName" expression="${storageName}"/> 
   </extensionElements>
</serviceTask>

With partition range

<serviceTask id="CheckBusinessObjectDataAvailabilityTask" name="Check Business Object Data Availability" activiti:class="org.finra.dm.service.activiti.task.CheckBusinessObjectDataAvailability">
   <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="businessObjectFormatVersion" expression="${businessObjectFormatVersion}"/> 
      <activiti:field name="startPartitionValue" expression="${startPartitionValue}"/> 
      <activiti:field name="endPartitionValue" expression="${endPartitionValue}"/> 
      <activiti:field name="businessObjectDataVersion" expression="${businessObjectDataVersion}"/> 
      <activiti:field name="storageName" expression="${storageName}"/> 
   </extensionElements>
</serviceTask>