Naming conventions¶
Use the following naming conventions to ensure that your tenant is configured with consistent and predictable names, including feed names, domain table names, database and database table names, query and orchestration names, and segment and campaign names.
Note
A tenant that is configured to support multiple brands or regions should use a consistent prefix for each brand and/or region.
Important
Avoid using dates within names as much as possible. Most data sources that are provided to Amperity are live datasets that contain records that are added or upserted on a regular bases. If you must use a date within a name, use the YYYYMMDD format.
The following situations often require using a date within a name.
Snapshots that compare data at different points in time.
Feeds and couriers that capture files that change over time.
Recommended patterns¶
The following table describes recommended naming patterns.
Component |
Naming convention |
Example |
---|---|---|
Campaigns |
Use a name that describes the purpose of the campaign. |
Mothers Day Cross Channel Google Ads Midwest High AOV |
Couriers |
Use a combination of source and feed for the name of the courier as much as possible. Separate the source and feed name using an underscore ( |
Adobe_Clickstream or Adobe_Clickstream_Daily Sailthru_Responses Braze_Audience_EMEA, Braze_Audience_PNW Amazon_S3:Static (which contains individual files for postal codes, geolocation data, etc.) |
Custom databases |
Use title case to describe the data that is contained within this database, including category and purpose. |
Production Brand Production Amperity Analytics |
Database tables |
Use a combination of source and feed for the name of the database table as much as possible. Separate the source and feed name using an underscore ( |
Adobe_Clickstream Sailthru_Responses Braze_Audience Amazon_S3_StateCodes Shopify_Orders |
Destinations |
Use the name of the system to which Amperity will send data. |
Adobe Oracle_Responsys Pebble_Post Amazon_S3 |
Domain tables |
The name of a domain table is determined by the name of the data source, and then the name of the feed, separated by a colon ( |
Adobe:Clickstream Sailthru:Responses Braze:Audience Amazon_S3:StateCodes Shopify:Orders Important Custom domain tables should follow the source/feed naming convention as often as possible. Apply a consistent prefix to the source name to identify the table as a custom domain table, and then append the purpose of the table. For example, a custom domain table that filters Shopify data, and then applies semantic tags for unified transactions: CDT_Shopify_Orders_UT. |
Feeds |
Use the name of the dataset provided by the system that provided this data to Amperity Important All internal feed names, such as a bad values blocklist, should be prefixed with “Amperity”. For example: Amperity:Blocklist. |
Clickstream, Responses, Audience, StateCodes, Orders, etc. |
Folders |
Group queries and segments using folders. Assign each folder a functional name that accurately describes all of the items within that folder. Tip Use short folder names as often as possible. |
Braze Direct_Mail |
Queries |
Use a name that describes the purpose and result type for the query. Add details like “historical”, “daily”, or “test” as appropriate. Add details if the data is regional or by brand. |
Braze_Audience_Test Customers_Hawaii, Customers_California Tip Prefix a query in a folder with that folder name as often as possible. For example: Direct_Mail_Customers_Hawaii. |
Segments |
Use a name that describes the purpose and audience type for the segment. Add details like “historical”, “daily”, or “test” as appropriate. Add details if the data is regional or by brand. |
Birthdays_Under_40 High_AOV_Active_Loyal High_CLV_Historical Tip Prefix a segment in a folder with that folder name as often as possible. Braze_Birthdays_Under_40. |
Sources |
Use the name of the system that provided this data to Amperity. |
Adobe, Sailthru, Braze, Amazon S3, Shopify, etc. |