- Data Catalog
- Catalog Extension
- Manage Business Terms
6.2 Manage Business Terms
Based on the Action created, follow the steps below to create a Business Term.
- Go to the Inbox by clicking the Inbox Button on the Home PageThe Inbox Page is displayed.
- To create a Business Term for an Action, do the following:
- Select the required Action for which you need to create a Business Term.The Action Details Page is displayed.
- On the Extension Tab, click Create Business Term.The New Business Term Page is displayed.
- On the Definition Tab, set the following values.
Table 6-2 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 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.
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. 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 LengthThis section provides the list of the logical data type and its data length.
Table 6-3 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) Clob CLOB Blob BLOB Code_Alphanumeric VARCHAR2(20) Code_Alphanumeric_Long VARCHAR2(60) Code_Numeric NUMBER(14) Currency VARCHAR2(3) Date DATE Description_Short VARCHAR2(100) Description VARCHAR2(255) Description_Medium VARCHAR2(1000) Description_Long VARCHAR2(4000) 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) Timestamp TIMESTAMP Amount_Currency NUMBER(22,3) Amount_Currency_Long NUMBER(38,6) Amount_Currency_Date NUMBER(22,3) Amount_Currency_Date_Long NUMBER(38,6) - On the Relationships Tab, set the following values.
Table 6-4 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. - Click Save.A confirmation message is displayed. Click OK.
- On the Extension Tab, in the Business Term Extensions Section, the new Business Terms are listed.
- Click Submit to submit the Action for approval.A confirmation message is displayed.
- 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 modifiedNote:
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.
- Select the required Action for which you need to create a Business Term.
- To update a draft Business Term for an Action, do the following:
- Click the required Action for which you need to update a Business Term. The Action Details Page is displayed.
- On the Extension Tab, click the Business Term that you need to updateThe Business Term Details Page is displayed.
- You can update any Field and Click Save.A confirmation message is displayed. Click OK to confirm.
- 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 for Issues and Actions Section in the OFS Accounting Foundation Cloud Service Core Functions Release 22D.