In alignment with best practices for Chains artifacts, it is advisable to implement consistent naming conventions for Wdata objects—such as Tables and Queries—to facilitate easier navigation and management. The guidelines provided here are intended to help you organize artifacts consistently from the outset.
Fact tables and dimension tables
Fact tables typically contain data that accumulates over time, while dimension tables store supplementary datasets that provide additional context to the data. When naming both types of tables, consider the following best practices:
- Naming Convention: Use a consistent naming convention that clearly indicates the purpose and content of both Fact Tables and Dimension Tables.
- Descriptive Names: Apply descriptive names to both types of Tables to ensure they are easily identifiable and understandable.
- Source System: Include the originating system for the data in the name.
Examples:
-
Fact Table: Trial Balance - Workday
Description: Stores trial balance transactional data for Avikro Financial, sourced from Workday. -
Dimension Table: Chart of Accounts - Workday
Description: Stores the chart of accounts data for Avikro Financial, sourced from Workday. -
Dimension Table: Profit Centers - SAP
Description: Stores profit center information for Avikro Financial, sourced from SAP. -
Dimension Table: Exchange Rates - Central Bank API
Description: Provides currency conversion rates for Avikro Financial, sourced from the Central Bank API.
This template ensures consistency in naming conventions, descriptive clarity, and accurate identification of the Source System for both Fact and Dimension Tables.
Queries
When defining naming conventions for queries, it’s essential to maintain a standard approach. This ensures that users can easily identify the correct query for retrieving specific data.
- Naming Convention: Use a consistent naming convention that clearly defines the purpose and content of the Query.
- Descriptive Names: Apply descriptive names to Queries to facilitate easy identification and understanding.
- Source System: Specify the originating system for the data.
Example:
-
Query Name: Extended Trial Balance - Workday - Financial Statement
Description: This Query retrieves trial balance data from Workday, with supplementary datasets tailored for generating financial statements.
Note: It is important to avoid using pipe delimiters (|) in Tables & Queries. Instead, use hyphens (-) to prevent any potential issues with these artifacts.
Adhering to this naming convention will also make it clear which Query should be used when creating an incoming Connection to a Spreadsheet.
Descriptions
Descriptions are often the most overlooked part of the design and build process, but they are crucial for improving understanding and usability. Descriptions should provide additional context, such as:
- Indicating if a Table or Query is a placeholder.
- Noting if a Query needs editing before use.
- Clarifying the specific function of an artifact like a query, such as identifying payments that are less than 20% lower than in the previous period.
By including clear and detailed descriptions, users can quickly grasp the purpose and content of each artifact, reducing confusion, minimizing errors, and enhancing overall efficiency in managing the Wdata environment.
Folders/Environments
When organizing a workspace, it is recommended to categorize tables and queries into folders based on their intended use. This structure enables users to easily navigate and determine which artifacts are designated for Development, Testing, and Production.
Since Wdata currently lacks support for out of the box Application Lifecycle Management, it's recommended to append names to artifacts and folders to indicate their respective environment. This helps manage the application lifecycle and avoids any errors or issues. Note that Production artifacts do not need appended names.
Here’s another approach to managing Wdata Tables & Queries:
Summary
Using consistent naming conventions, descriptions with context and organizing your Wdata Artifacts helps make your workspace easier to navigate and manage. Clear, descriptive names and a well-organized folder structure ensure that everyone can quickly find and use the necessary Tables, Queries, and other resources. Following these simple practices not only makes your work more efficient but also improves teamwork and keeps your data organized. As your data needs grow, sticking to these conventions will continue to make your data management smooth and straightforward.