Entity Attribute Descriptions

This section lists detailed explanations for each attribute of the source entity, target entity, extractor entity, stream entity, and CP JSON files.

For detailed file structures, refer to Content Pack Structure .

The following table shows the attribute descriptions of the source entity JSON file.

Source Entity JSON File
Field Description
metadata_layout_version Version of the metadata format
version Version of the entity metadata
content_pack Content pack name. Should be the same as content_pack_name defined in cp.json
source_product Source product
entity_name Source entity name
entity_business_name Business name of the entity
entity_description Source entity description
schema Target entity attribute array
attribute Source table field that needs to be extracted
attribute_name Attribute name. Serves as a field name in the staging tables
attribute_business_name Attribute business name
attribute_description Source table field description
sql_data_type Field data type
size Field size
is_bk The value is true if the attribute serves as a business key
is_cdc The value is ture if data is incrementally extracted. In most cases, this attribute is used for LAST_UPDATE_DATE. If it is not specified as true, Extractor Engine extracts all records everytime.
is_required The value is ture if this field is not null
column_sequence The column sequence when creating staging tables

The following table shows the attribute descriptions of the target entity JSON file.

Target Entity JSON file
Field Description
metadata_layout_version Version of the metadata format
version Version of this entity metadata
content_pack Content pack name. Should be the same as content_pack_name defined in cp.json
entity_name Target entity name
entity_business_name Business name of the entity
entity_description Target entity description
dimension Included for a target dimension entity
dimension_business_name Dimension business name
is_conformed Whether this dimension is conformed; for future usage
dimension_type Hierarchy or Primary; use Hierarchy if you want to define hierarchical structure for this entity
storage_strategy Includes segmented_by and partition_by
segmented_by Used for table segmentation; specify Default if you want to copy data of this entity to all Vertica clusters
partition_by Used for table partition
fact Included if this is a target fact entity
fact_business_name Business name of the fact
fact_description Description of the fact entity
fact_type ACCUMULATED is the only supported value
schema Target entity attribute array
attribute Name of this attribute
attribute_name Target entity attribute name
attribute_business_name Business name of this attribute
attribute_description Description of this attribute
attribute_type If this is target fact entity, the value should be measure; otherwise the value is dimension.
scd

scd1: Update the record

scd2: Insert a new record

target_data_type Target entity attribute type
size Target entity attribute size
is_required The value is ture if this field is not null
dimension_associated_dimension Defines the dimension if this dimension refers to other dimensions
fact_association_dimension Defines the fact if this fact refers to other dimensions
fact_association_fact

Defines the fact table if this fact table refers to other fact tables

Note: Late arriving fact tables are not supported. Make sure the referred fact table is loaded prior to this fact table.

lookup_entity_name Lookup entity name
role_entity_name Alias for the referred entity
role_entity_business_name Business name for the referred entity
description Description of this lookup

The following table shows the attribute descriptions of the extractor entity JSON file.

Extractor Entity JSON file

Field Description
metadata_layout_version Version of the metadata format
version Version of this entity metadata
source_product Source product
content_pack Content pack name. Should be the same as content_pack_name defined in cp.json
entity_name Entity name
source_entity_name Source table name
extractor The extractor that is called to extract data. Currently OracleDBExtractor is supported.
extraction Contains the extraction attributes
extraction_view An on-the-fly view from which extractor extracts data from.
source_product_version The version of the source product that the extractor extracts from

The following table shows the attribute descriptions of the stream entity JSON file.

Stream Entity JSON file
Field Description
metadata_layout_version Version of the metadata format
version Version of this entity metadata
content_pack Content pack name. Should be the same as content_pack_name defined in cp.json
source_product Source product
stream_name Stream entity name
source_entities_includes Defines the source entity of the stream
source_entity_include The source entity name of the stream
target_entities_includes Defines the target entity of the stream
target_entity_include The target entity name of the stream
transforms Contains the attribute related to SQL transformation
sql Queries that transform source entities to target entities
post_target_transforms Optional. If you want to process other SQLs after data is loaded to target tables, include SQLs in this attribute.
sql Includes SQL queries that is executed as part of POSTTARGET step

The following table shows the attribute descriptions of the CP JSON file.

CP JSON File
Field Description
metadata_layout_version Version of the metadata format
content_pack_name Content pack name
version Version of this content pack
description Description of this content pack
require Dependency of this content pack
platform Platform version that requires to support this content pack
target_entities Target entity section. Lists all target entities that you defined in this content pack
name Target entity name
streams Stream entity section; lists all stream entities that you defined in this content pack
name Stream entity name
source_entities Source entity section; lists all source entities you defined in this content pack
name Source entity name
extraction_entities Extractor entity section; lists all extraction entities you defined in this content pack
name Extractor entity name