get s3 key prefix

Get S3 Key Prefix

Gets an S3 key prefix where business object data can be written to or expected to be found. The S3 key prefix is generated according to the herd S3 Naming Convention set as a configuration value. Please refer to S3 Key Prefix Get for more information.

Delegate Class

org.finra.dm.service.activiti.task.GetS3KeyPrefix

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
namespace	Y			N	The namespace of the business object definition.
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	Y	Integer		N/A	The version of the business object format (e.g. 0). The business object format version must be pre-registered as part of a business object format.
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.
createNewVersion	N	true, false	false	Y	If "true", an S3 key prefix will be created for a new business object data version. Otherwise, only an initial business object data version (v0) S3 key prefix can be returned. This parameter is ignored, when the business object data version is specified.

Output Parameters

Name	Description
{taskId}_s3KeyPrefix	The S3 key prefix to use when writing or accessing the data. Note that the S3 key prefix will not contain a trailing "directory" separator and it will be up to the caller to append one as needed.

Sample Usage in Activiti XML

<serviceTask id="GetS3KeyPrefix" name="Get S3 key prefix" activiti:class="org.finra.dm.service.activiti.task.GetS3KeyPrefix">
   <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}"/>
      <activiti:field name="createNewVersion" expression="${createNewVersion}"/>
   </extensionElements>
</serviceTask>