With Catalog Extension, you can extend the seeded Catalog data model to support new or client-specific business use cases. You can create new entity definitions or customize the existing entity definitions based on the use case.
Catalog Object Type |
Create |
Modify |
Extend |
Delete |
|---|---|---|---|---|
Business Term |
Yes |
No |
No |
No |
Dimension Entity |
Yes |
No |
No |
No |
Extend Fact Entities |
No |
No |
Yes |
No |
All the points mentioned above are applicable to both Seeded and Custom Objects:
1. New business terms added to fact entities can be dimension references, measures, flag or indicators and alphanumeric attributes without dimensional reference.
2. Fact logical entities that allowed for extensions are product processors, account transactions, accounting entries, Accounting Entries Header and Transaction Header.
3. Extensions are allowed to logical entities and physical model modification is controlled by service.
4. Required data flow for the extended entities are auto generated by system.
5. Completes the basic data quality checks required for extended entities.
You must identify the additional data requirements to implement in the application through system and business use case analysis. Data model gaps need to be captured in Issues and Action governance framework.
Data model extensions must be designed based on the guidelines provided for each area.
Catalog Result layer is designed as a Star Schema for better performance of Analytical and Reporting queries. Hence it is highly recommended that Dimensional Entities must be created for a pre-defined list of values before adding to the Fact Entities. Adding of alphanumeric attributes for Fact Entities must be avoided wherever possible.
The catalog extension process workflow is as follows:
Figure: Catalog Extension Process Workflow
· Analyze
§ Analyze the requirements based on the existing details in Data Catalog.
§ Use the Catalog Viewer to understand existing Business Terms, logical entities and their properties.
· Review
§ Prepare the list of Gaps – additional business terms, dimensions, fact extensions and other associated properties.
§ Document the list of Gaps – group based on type and purpose of extensions.
§ Review the list of Gaps to ensure if the proposed additions are consistent and conformance according to the Data Catalog Extension Principles and Naming Standards.
· Document
§ An Issue Administrator will Log an Issue (Category as Catalog Extensions) based on the purpose of the extension. To know how to log an Issue, see the Issues Section.
§ Document the details of the extension requirements in the Issue. Upload the analysis and requirement documents.
§ Assign to the Issue Owner.
· Action
§ Issue Owners create Action (Type as Catalog Extension) for the issue. It is recommended to define an action for each type of change. To learn how to create an Action, see the Actions Section in the OFS Accounting Foundation Cloud Service Core Functions Release 22C.
§ Upload the document containing the list of changes in Action details.
§ Action Owners create or extend the catalog objects based on the type of Change Request.
§ Action Owners submits the action for approval.
· Publish
§ Issue Owner reviews submitted actions and approves or rejects along with appropriate comments.
§ After approval no modification is allowed to object definitions.
§ Issue Administrator publishes the approved Action to approve the changes in the Catalog data model.
§ Actions need to be published sequentially and in the logical sequence that would be reflected in schema. To use a Custom BT in a new Dimension Entity or while Extending the Fact, first create and publish the Business Term. Once the BT is published, it will available in the list of Available Business Terms during creation of Dimension Entity and while extending a Fact.
§ You can verify the published Actions from Catalog Viewer for Dimension Entity and Extend Fact Entity.
§ Please note that extensions will be reflected in master repository of objects only on Publish and it is mandatory to publish before users can view or consume the object for further extensions.
§ If a Publish action is successful, the action is displayed under Publish tab. If a Publish action is unsuccessful, the action is displayed under Approved tab.
§ Publish action is an asynchronous process which may take few minutes to complete, User may leave the UI and comeback later to check the status of the event.
Based on the Action created, follow the steps below to create a Business Term.
To create a 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 Business Term for an Action, do the following:
a. Select the required Action for which you need to create a Business Term.
The Action Details page is displayed.
b. On the Extension Tab, click Create Business Term.
The New Business Term Page is displayed.
c. On the Definition Tab, set the following values.
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 category 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 Logical Data Type and Data Length Table |
Personally Identifiable Information |
Select if the Business Term is a personal information or not. The value can be a Yes or No (Enable the Toggle Switch for Yes and disable for No). |
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.
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) |
d. On the Relationships Tab, set the following values.
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. |
e. Click Save.
A confirmation message is displayed.
f. Click OK. On the Extension Tab, in the Business Term Extensions Section, the new Business Terms are listed.
g. Click Submit to submit the Action for approval.
A confirmation message is displayed
h. 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:
a. Click the required Action for which you need to update a Business Term.
The Action Details Page is displayed.
b. On the Extension Tab, click the Business Term that you need to update.
The Business Term Details Page is displayed.
c. You can update any Field and Click Save.
A confirmation message is displayed: Business with ID <ID> updated.
d. Click OK to close the Acknowledgment. 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 22C.