Generate Business Object Format DDL

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format. DDL service is designed to provide platform specific DDL, currently limited to Hive 13. Future enhancements will provide DDL for other DBMS which may have different methods for working and the DDL would be different.

Please refer to Business Object Format Generate DDL Post for more information.

Delegate Class

org.finra.dm.service.activiti.task.GenerateBusinessObjectFormatDdl

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
namespace	Y	String		N	The namespace of the business object definition.
businessObjectDefinitionName	Y	String		N	The name of the business object definition (e.g. NEW_ORDERS).
businessObjectFormatUsage	Y	String		N	The business object format usage (e.g. PRC).
businessObjectFormatFileType	Y	String		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 latest format version is used to retrieve the schema.
outputFormat	Y	HIVE_13_DDL (Hive version 0.13.0)		Y	The output format for the generated DDL (e.g. HIVE_13_DDL).
tableName	Y	String		N/A	The table name to be used in the generated DDL.
customDdlName	N	String		N	The name of the custom DDL. When custom DDL name is specified, the generated DDL uses the custom DDL which had previously been stored against the relative business object format.
includeDropTableStatement	N	true, false	false	Y	If "true", a drop table statement for an existing table will be added to the generated DDL.
includeIfNotExistsOption	N	true, false	false	Y	If "true", a "IF NOT EXISTS" option will be added to the "CREATE TABLE ..." statement in the generated DDL. Please note that this parameter value has no effect on the relative "CREATE TABLE ..." statement, when generated DDL uses custom DDL.

Output Parameters

Name	Description
{taskId}_businessObjectFormatDdl	The business object format DDL.

Sample Usage in Activiti XML

<serviceTask id="GenerateBusinessObjectFormatDdlTask" name="Generate business object format DDL" activiti:class="org.finra.dm.service.activiti.task.GenerateBusinessObjectFormatDdl">
   <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="outputFormat" expression="${outputFormat}"/>
      <activiti:field name="tableName" expression="${tableName}"/>
      <activiti:field name="customDdlName" expression="${customDdlName}"/>
      <activiti:field name="includeDropTableStatement" expression="${includeDropTableStatement}"/>
      <activiti:field name="includeIfNotExistsOption" expression="${includeIfNotExistsOption}"/> 
   </extensionElements>
</serviceTask>