Guide: Workday / Integration and related object naming

Objective

• To provide information about the adopted best practices for naming Integration related items in Workday

Scope

• Recommended naming standards and guidelines

User

• Workday Integration Developers

Environment

• 1191721: Workday
• 1068805: GitLab (SaaS)
• 10374: TeamDynamix (TDX)
• 10277: JIRA Issue Tracker

Naming guidelines

Integration and related-object general naming guidelines

• Start by identifying a unique Integration ID: This ID should be prefixed with INT, and followed by a unique numerical string of at least four digits, e.g. INT0000
• See Guide: Workday / Assign integration system IDs for information on ID selection

 

 

Naming guidelines for Workday-related GitLab repositories

In some cases, GitLab repositories will be needed for Workday integrations. When requesting a new repository that is integration specific, the integration ID should be provided so it can be included in the project name and URL slug.

 

Workday object-specific naming guidelines

Integration systems

• INTXXXX [Vendor/Application/Platform/Service] [Payload Content/Data] [Direction from WD perspective] [WD Integration template]
• Example:
  • INT0050 Anthem Enrollment Outbound Connector
  • INT0310 OPERS Payroll Contributions Outbound EIB

 

Custom reports

• Custom Report name should start with CR INTXXXX [Vendor/Application/Platform/Service] [Payload Content/Data] [WD Integration template]
• When used in an integration, Custom Reports should try to match the integration name
  • Example: CR INT0310 OPERS Payroll Contributions Outbound EIB
• By default, all reports should be shared with all authorized uses (via the Share tab)
• All Custom Reports should be owned by the Integration’s ISU
• When creating an Advanced Custom Report, change the Report namespace to the following (via the Advanced tab: urn:com.workday.report/bsvc

 

Calculated fields

• CF INTXXXX [Calc Field Type Abbreviation] [Calc field description]
  • Example: CF INT0310 TF Worker has Quit
• Note, if creating a Lookup Related Value (LRV), indicate the source business object in the calculated field name
  • Whichever business object you start from to do your calculated fiels should be the business object included in the name
  • Example: CF INT0310 ESI Worker Prior to Last Completed Payroll Result
• When creating calculated fields, change the Category to Integration (via the Additional Info tab). Do not leave the Category as uncategorized
• Always create a new calculated field for your integration, even if a global field exists that satisfies your requirement (i.e. do not use Text Constant C Global field; instead, copy the global field and create “CF INT0310_Text Constant C”)
• Calculated field-type abbreviations are seen below

 

Integration System Users (ISU) and Integration System Security Groups (ISSG)

• ISU_[Integration ID]_[Vendor]
• ISSG_[Integration ID]_[Vendor]
• Examples:​​​​​​
  • ISU_INT0310_OPERS_Payroll_Contributions
  • ISSG_INT0310_OPERS_Payroll_Contributions_Outbound
• There ought to be one security group and one Integration System User per integration. Do not create one security group for multiple integration systems

 

x509 Private Key Pairs (PKP)

• The key should include the vendor name if it is shared by multiple integrations: PKP [Vendor]
• If the key in integration specific, it should include the Integration ID and vendor name: PKP [Integration ID] [Vendor]

 

Retired or out-of-use objects

• Retired or out-of-use objects should be preserved but identified as not in use. Edit the name of the item to include the zzzDNU_ prefix. This should apply to all related items for the integrations, including the items defined above
  • Example, using a calculated field: zzzDNU_CF INT0067 LRV Benefit Enrollment from Benefit Election

 

Calculated field abbreviations

• For a list of calculated field abbreviations, see Guide: Workday / Calculated Field Abbreviations

 

Integration-related objects outside of Workday

TDX Asset Records

• A TeamDynamix asset should be created for each discrete integration
• The asset name should match the Integration System name, e.g. INT0090 Ascensus FSA HSA Enrollments Outbound Connector

 

Documents

• All objects related to integration development should leverage the unique Integration ID in their naming. For example, items such as:
  • Google documents
  • PDF files
  • Diagram / flow files

 

JIRA

• If a Jira story is created, it should reference the integration ID