2.5.1.1 Create Business Terms

Based on the Action created, follow the steps below to create a Business Term.

To create a custom Business Term for an Action, do the following:
  1. Go to the Inbox by clicking the Inbox button on the Home page
    The Inbox page is displayed.
  2. To create a custom Business Term for an Action, do the following:
    1. Select the required Action for which you need to create a custom Business Term.
      The Action Details Page is displayed.
    2. On the Extension tab, click Create Business Term.
      The New Business Term page is displayed.
    3. On the Definition tab, set the following values.

      Table 2-7 Business Terms Field Names and Description on the Definition Tab

      Field Name Description
      Business Term Logical Name Type a unique name for the Business Term. By default, the logical name will be appended with the Affix Type which is Prefix and the Affix Value for this prefix is "Custom " with a space in the last before beginning the Business Term. For Example: Custom BusinessTerm1

      Type a unique name for the Business Term Logical Name.

      • The Business Term needs to be long and meaningful. Short meaningless Abbreviations cannot be used.
      • The Business Term must always be in Camel case.
      • Logical names must have A to Z and 0 to 9 characters only
      • The Business Term can consist of alphanumeric without special characters. Maximum allowed length is 150 characters. A single space can be used as a Delimiter to separate the words.

      Note:

      You should not create two Business Terms with the same logical name in different cases. For Example: Business Term1 and business term1.
      Classification Select one of the following categories for the Business Term:
      • Date and Timestamp
      • Flag or Indicator
      • List of Values
      • Monetary Amount
      • Numerical Non-Monetary
      • Text Description
      • Identifiers
      Logical Data Type Select the required Logical Data Type that defines the Data Type and Length of the Business Term. For more information, see the Logical Data Type and Data Length Table.

      Note:

      If you want to configure the List of Values, select the Logical Data Type from the following list:
      • Flag
      • Indicator
      • Code_Alphanumeric
      • Code_Alphanumeric_Long
      • Code_Numeric

      Note:

      It is recommended to not have more than 10 distinct LOVs (List of Values) for lov codes definition. If the number of distinct LOVs exceeds 10, it is advisable to create a new custom dimension.
      Personally Identifiable Information Select if the Business Term is personal information. The value can be a Yes or No (Enable the Toggle Switch for Yes and disable for No).

      Note:

      All the PII attributes created by the User is enabled for data masking while creating a cloned environment in the system.
      Add Click this button to add this Business Term in the Glossary List
      Glossary Name It is auto-populated based on the logical name of the Business Term.
      Glossary Context It is auto-populated with a pre-defined value (FSDF).
      Business Term Description Double-click on the blank space corresponding to this field and type a proper Description for the Business Term:
      • It must be a complete sentence with possible indication of data domain and list of values it contains along with business context.
      • Business term description shall be without special characters. Maximum allowed length is 4000 characters.
      Delete To delete a Glossary item, select the Glossary and click Delete.
      Logical Data Type and Data Length

      This section provides the list of the logical data type and its data length.

      Table 2-8 Logical Data Type and Data Length

      Logical Data Type Data Length
      Amount NUMBER(22,3)
      Amount_Long NUMBER(38,6)
      Amount_Medium NUMBER(30,11)
      Code_Alphanumeric VARCHAR2(20)
      Code_Alphanumeric_Long VARCHAR2(60)
      Code_Numeric NUMBER(14)
      Currency VARCHAR2(3)
      Date DATE
      Description_Short VARCHAR2(100)
      Description_Medium VARCHAR2(1000)
      Description_Long VARCHAR2(4000)
      Description VARCHAR2(255)
      Flag CHAR(1)
      Indicator VARCHAR2(1)
      Number_Factor NUMBER(10,6)
      Number_Factor_Long NUMBER(38,15)
      Numeric NUMBER(10)
      Numeric_Long NUMBER(30)
      Rate_Percent NUMBER(11,6)
      Rate_Percent_Medium NUMBER(15,11)
      Rate_Percent_Long NUMBER(30,11)
      SurrogateKey NUMBER(10)
      SurrogateKey_Long NUMBER(15)
      Amount_Currency NUMBER(22,3)
      Amount_Currency_Long NUMBER(38,6)
      Amount_Currency_Date NUMBER(22,3)
      Amount_Currency_Date_Long NUMBER(38,6)
    4. On the Relationships Tab, set the following values.

      Table 2-9 Business Terms Field Names and Description on the Relationships Tab

      Field Name Description
      Add Click this button to add the Business Term in the Glossary List.
      Group Code Enter an identifier that represents that one Business Term is related to another Business Term.

      Group Code shall be alphanumeric with maximum 10 characters in length.

      An existing group code can be mentioned if the new relationship falls into existing group.
      Relationship Type Enter the relationship type that occurs between Business Terms. For more information, see the Related Business Terms.
      Related Business Term Double-click on the blank space corresponding to this field and type a proper Description.
      Delete To delete a Relationship item, select the Relationship and click Delete.
    5. On the List of Values Tab, click Add and set the following values.

      Note:

      The Add or Delete options in List of Values tab is enabled only for the Custom Business Terms for the following Data types:
      • Flag
      • Indicator
      • Code_Alphanumeric
      • Code_Alphanumeric_Long
      • Code_Numeric

      Table 2-10 Business Terms Field Names and Description on the List of Values Tab

      Field Name Description
      Code Enter the code for the LOV. For Example: Y. This is limited to one character and only alphanumeric character is supported and should be unique. The code is case sensitive.
      Display Name Enter the display name for the LOV.
      Description Enter the description for the LOV.
      Following are the current behavior of LOV:
      • The Business Term with Logical Data Type as Flag, Indicator, Code_Alphanumeric, Code_Alphanumeric_Long and Code_Numeric are allowed to have associated LOV. For other BT types, it is recommended to create a Dimension.
      • LOV definition will capture Code, Display Name, and Description.
      • The LOV should match the data type and data length of the Business Term.
      • The Business Term follows the existing governance validations. For example: You cannot modify after the approval, only Action owner is allowed to modify, and so on. For more details, see the Approval workflow of Issues and Actions section.
      Based on the list of values configured for a given custom business terms, the system auto generates data quality rules for the associated entities.
    6. Click Save.

      Note:

      When you create an Action for the first time and wish to extend the catalog, during a Business Term or a Dimension Entity creation, the following warning is displayed:

      "Please ensure that the affix details are configured. Click Yes to proceed with saving the Business Term/Dimension"

      A confirmation message is displayed. Click OK.
    7. On the Extension Tab, in the Business Term Extensions Section, the new Business Terms are listed.
    8. Click Submit to submit the Action for approval.
      A confirmation message is displayed.
    9. Click Yes to confirm.
      Your confirmation is acknowledged.

      Note:

      Once a Business Term has been Approved or Published, it cannot be modified or removed from the Extension. The properties of an existing Out-of-box Business terms cannot be modified, but any new custom Business Terms which are in only Draft status can be modified

      Note:

      If you create any custom Business Term and want to use the same in any of the custom Dimension or in extending a Fact entity, the Business Term alone must be initially published.
  3. To update a draft Business Term for an Action, do the following:
    1. Click the required Action for which you need to update a Business Term. The Action Details Page is displayed.
    2. On the Extension Tab, click the Business Term that you need to update.
      The Business Term Details Page is displayed.
    3. You can update any Field and Click Save.
      A confirmation message is displayed. Click OK to confirm.
    4. On the Extension Tab, in the Business Term Extensions Section, the new Business Terms are listed. Click outside the Action Details Page to close it.
    For information about Approval of Action (for Business Term), see the Approval workflow of Issues and Actions section.