Understand the Config YAML file content

Each metadata repository contains a config.yml file (See Understand project metadata repository content).

This file contains the project's custom generator configuration, such as:

Config file details

After customizations in the Project's Advanced Settings, the file should look like the following:

Properties:
  - InternalCode: 'ef97e49f-dc56-416c-bf23-8005ef550bac'
    Name: 'Custom_property'
    PropertyGroupId: '56d7965c-ec82-4510-a4ce-074e5e66d57e'
    PropertyValueTypeId: 'd834af62-aaa5-479e-8fcc-0f6d6743f05e'
    DefaultValue: 'true'
PropertyMappings:
  - InternalCode: '9c6b58c0-30fd-4843-97ee-96dbf795bec4'
    EntityTypeId: 'df05aa47-2139-4b99-8ebd-9551304983fc'
    Name: 'Custom_property'
    PropertyId: 'ef97e49f-dc56-416c-bf23-8005ef550bac'
    DefaultValueOverride: 'true'
    ModelObjectTypeId: 'ac3f7f40-3068-47df-af3d-c6990ad73f7d'
PropertyMappingOverrides:
  - PropertyMappingId: '93b44091-ba63-411b-b48a-2c224e3da2bb'
    DefaultValueOverride: 'Distinct'
DefaultTerms:
  - InternalCode: '442b0cf6-4d84-46f7-bddb-ff7da45b2d95'
    Name: 'Default_Term'
    ShortName: 'Default_Term'
    IsEditable: true
    HasDefaultTermToBeCreated: true
    Role: 'Attribute'
DefaultTermMappings:
  - Name: 'Default_Term'
    InternalCode: 'a62de953-a57e-44ee-a565-774ac5f0e4a1'
    DefaultTermId: '442b0cf6-4d84-46f7-bddb-ff7da45b2d95'
    ModelObjectTypeId: 'ac3f7f40-3068-47df-af3d-c6990ad73f7d'
    PartId: '825b126f-28c4-47d9-9324-7272f2b8b858'
DefaultTermPlatformDataTypeMappings:
  - Name: 'Default_Term'
    InternalCode: '66b36ccf-663b-45ef-860a-5a16b187ce93'
    DefaultTermId: '442b0cf6-4d84-46f7-bddb-ff7da45b2d95'
    PlatformDataTypeId: 'ad190237-5c2c-4a43-aa8c-3fda2081c1c6'
NamingRules:
  - InternalCode: '3666cd10-3386-4595-afa4-35e7a9ba3113'
    Name: 'BusinessVault Composite Source View'
    NamePattern: 'BDV_BC_{ModelObject.Name}_Source'
    Scope: 'ModelObjectType'
DefaultTermNamingConventions:
  - InternalCode: '3d0d1df1-e8a7-45bb-abf4-63b4ecdbc2ea'
    NamingConvention: '_BG_DimId'
CustomTemplateModules:
  - InternalCode: 'ac0793f9-1456-4175-878d-acec62aafe91'
    ModelObjectTypeId: 'ac3f7f40-3068-47df-af3d-c6990ad73f7d'
    PartId: '825b126f-28c4-47d9-9324-7272f2b8b858'
    ModelObjects:
      - '87b878a5-9a92-43b7-98bb-88b6b5ddcd61'
      - '991a5c22-4cc9-49c6-8c05-46150c19660a'
      - 'cb9387a4-a52a-43a4-9907-20dd1ef06550'
      - 'ea014965-d23f-410a-bf7f-aed3f114532e'
    ModuleTemplate: "using biGENIUS.ArchitectureModel.Domain;\nnamespace CustomTemplate\n{\n  public class Executor\n  {\n    public string GetOutput(TargetObject targetObject, ArchitectureModel architectureModel)\n    {\n      var sql = \"CREATE TABLE mytable ....\";\n      return sql;\n    }\n  }\n}"
HiddenWarnings:
  - Code: ''
    Message: 'Model object ''F_ResellerSales'' of type ''Fact'' has a relationship to a historized model object, but the effective timestamp default term (BG_EffectiveTimestamp) not mapped. Relations will be resolved to the latest version in related model object.'

The different nodes contain:

InternalCode
 Node name  Node description  Node value example
 Properties
 List of Custom Properties -
Properties > InternalCode
Custom Property internal code (GUID format)
ef97e49f-dc56-416c-bf23-8005ef550bac
Properties > Name
Custom Property name
Custom_property
Properties > PropertyGroupId
Custom Property group id (GUID format) - This means it is a Custom Property and not a Property from the Generator
56d7965c-ec82-4510-a4ce-074e5e66d57e
Properties > PropertyValueTypeId
Custom Property type id (GUID format) - Correspond to a Data Type
d834af62-aaa5-479e-8fcc-0f6d6743f05e
Properties > DefaultValue
Custom Property default value - Depends on the Data Type defined
true
PropertyMappings
List of Custom Property Mappings
-
PropertyMappings > InternalCode
Custom Properties Mapping internal code (GUID format)
9c6b58c0-30fd-4843-97ee-96dbf795bec4
PropertyMappings > EntityTypeId
Custom Property Mapping  Entity Type id (GUID format) - Correspond to Model Object, Project, Term...
df05aa47-2139-4b99-8ebd-9551304983fc
PropertyMappings > Name
Custom Property name
Custom_property
PropertyMappings > PropertyId
Custom Property Mapping ID (GUID format)
ef97e49f-dc56-416c-bf23-8005ef550bac
PropertyMappings > DefaultValueOverride
Custom Property Mapping default value override - This means we choose another default value than the one defined in the Custom Property
true
PropertyMappings > ModelObjectTypeId
Custom Property Mapping Model Object Type ID - Correspond to Hub, Satellite...
ac3f7f40-3068-47df-af3d-c6990ad73f7d
PropertyMappingOverrides
List of Properties Default values (Custom or not) -
PropertyMappingOverrides > 
PropertyMappingId
Property Mapping ID (GUID format)
93b44091-ba63-411b-b48a-2c224e3da2bb
PropertyMappingOverrides > 
DefaultValueOverride
Property Default Value
Distinct
DefaultTerms
List of Default Terms -
DefaultTerms > 
InternalCode
Default Term internal code (GUID format)
442b0cf6-4d84-46f7-bddb-ff7da45b2d95
DefaultTerms > 
Name
Default Term name
Default_Term
DefaultTerms > 
ShortName
Default Term short name
Default_Term
DefaultTerms > 
IsEditable
Fixed to "true"
true
DefaultTerms > 
HasDefaultTermToBeCreated
Fixed to "true"
true
DefaultTerms > 
Role
Fixed to "Attribute"
Attribute
DefaultTermMappings List of Default Term Mappings -
DefaultTermMappings > Name Default Term name Default_Term
DefaultTermMappings > InternalCode Default Term Mapping internal code (GUID format) a62de953-a57e-44ee-a565-774ac5f0e4a1
DefaultTermMappings > DefaultTermId Default Term id (GUID format) 442b0cf6-4d84-46f7-bddb-ff7da45b2d95
DefaultTermMappings > ModelObjectTypeId Default Term Mapping Model Object Type ID - Correspond to Hub, Satellite... ac3f7f40-3068-47df-af3d-c6990ad73f7d
DefaultTermMappings > PartId Default Term Mapping Part ID - Correspond to Hub View, Hub Table... 825b126f-28c4-47d9-9324-7272f2b8b858
DefaultTermPlatformDataTypeMappings List of Default Term Platform Data Type Mappings -
DefaultTermPlatformDataTypeMappings > Name Default Term name Default_Term
DefaultTermPlatformDataTypeMappings > InternalCode Default Term Platform Data Type Mapping internal code (GUID format) 66b36ccf-663b-45ef-860a-5a16b187ce93
DefaultTermPlatformDataTypeMappings > DefaultTermId Default Term ID (GUID format) 442b0cf6-4d84-46f7-bddb-ff7da45b2d95
DefaultTermPlatformDataTypeMappings > PlatformDataTypeId Default Term Platform Data Type Mapping platform data type id (GUID format) ad190237-5c2c-4a43-aa8c-3fda2081c1c6
NamingRules
List of Naming Rules -
NamingRules > InternalCode
Naming Rule internal code (GUID format)
3666cd10-3386-4595-afa4-35e7a9ba3113
NamingRules > Name
Naming Rule name
BusinessVault Composite Source View
NamingRules > NamePattern
Naming Rule pattern
BDV_BC_{ModelObject.Name}_Source
NamingRules > Scope
Naming Rule scope
ModelObjectType
DefaultTermNamingConventions
List of Naming Conventions
-
DefaultTermNamingConventions > InternalCode
Naming Convention internal code (GUID format)
3d0d1df1-e8a7-45bb-abf4-63b4ecdbc2ea
DefaultTermNamingConventions > NamingConvention
Naming Convention value
_BG_DimId
CustomTemplateModules List of Custom Templates -
CustomTemplateModules > InternalCode Custom Template internal code (GUID format)
ac0793f9-1456-4175-878d-acec62aafe91
CustomTemplateModules> ModelObjectTypeId Custom Template Model Object Type ID - Correspond to Hub, Satellite...
ac3f7f40-3068-47df-af3d-c6990ad73f7d
CustomTemplateModules> PartId Custom Template Part ID - Correspond to Hub View, Hub Table...
825b126f-28c4-47d9-9324-7272f2b8b858
CustomTemplateModules> ModelObjects Custom Template Model Object list
- '87b878a5-9a92-43b7-98bb-88b6b5ddcd61'!
- '991a5c22-4cc9-49c6-8c05-46150c19660a'
- 'cb9387a4-a52a-43a4-9907-20dd1ef06550'
- 'ea014965-d23f-410a-bf7f-aed3f114532e'
CustomTemplateModules> ModuleTemplate Custom Template code content
"using biGENIUS.ArchitectureModel.Domain;\nnamespace CustomTemplate\n{\n  public class Executor\n  {\n    public string GetOutput(TargetObject targetObject, ArchitectureModel architectureModel)\n    {\n      var sql = \"CREATE TABLE mytable ....\";\n      return sql;\n    }\n  }\n}"
HiddenWarnings List of hidden warnings
-
HiddenWarnings > Code Hidden warning code soon available
HiddenWarnings > Message Hidden warning message
Model object ''F_ResellerSales'' of type ''Fact'' has a relationship to a historized model object, but the effective timestamp default term (BG_EffectiveTimestamp) not mapped. Relations will be resolved to the latest version in related model object.