Create and Edit Custom Object Definitions
Security:
Custom Object Management
domain in the System functional area.You can extend Workday business objects by creating custom object definitions based on the business object and adding custom fields.
- Access theCreate Custom ObjectorEdit Custom Objecttask.
- As you complete the task, consider:
Option Description Custom Object NameTo avoid errors when you generate an Enterprise Interface Builder (EIB) template for the custom object, don't use special characters.Effective DatedTo edit custom object data for a Workday object while a business process is in progress, base the custom object on anEffective DatedWorkday object.All effective-dated custom objects share the same set of effective dates. When you update any effective-dated custom object, Workday copies the data for all effective-dated custom objects from the previous effective date to the new effective date. To avoid obsolete or missing data when you update custom objects out of sequence, add or update custom objects in ascending effective-date order.Business Object FilterWhen you create a custom object for a custom organization, select a custom organization type from theBusiness Object Filterprompt. TheBusiness Object Filterprompt is only available when you select aCustom Organization.When you create the custom object, it's available to all custom organizations of the same type. You can't reassign the custom object to a different custom organization type after you create it.Custom field limits apply across all custom organizations, not to each custom organization type. - As you complete theGeneral Settingssection, consider:
Option Description Web Service AliasYou can only edit this field on a draft custom object. You can't change the web service alias after you activate the custom object definition.Allow Multiple Instances per Object?You can only edit this field on a draft custom object. You can't change this setting after you activate the custom object definition. - As you complete theField Definitionssection, consider:
Option Description Field LabelWorkday uses theField Labelas the report field name when you use this custom field in custom reports or calculated fields.Field TypeWorkday can share custom field types across all custom objects.You can only edit the field type on a draft custom field. You can't change the field type after you activate the custom field.ValidationsYou can't change whether a custom field is a required field after you activate it. Custom fields used as a reference ID require a value whether or not you make the field required. Workday recommends that custom fields that you use as reference IDs be required fields.When theField TypeisCustom ListorCustom Instance Reference, you can selectMulti-InstanceorSingle-Instance. By default, custom list fields are single-select, unless you selectMulti-Instance.Display OrderWhen multiple custom fields have the sameDisplay Order, Workday uses theField Labelto determine the order.Proposed New FieldsYou can add additional fields.When you're editing an active custom object, Workday saves theUse caution before you add required fields when you have either:- Existing data for an effective-dated custom object.
- More than 1 effective-dated custom object definition for the business object.
Proposed New Fields, but doesn’t activate them until you complete the task.Removed (Inactive) FieldsWhen you remove a custom field:- Workday appends theDo Not Uselabel to the custom field.
- Workday retains custom data, but you can't edit it.
- You can't select the custom field in calculated fields, report fields, condition rules, and integrations.
You can restore a removed field if it doesn't exceed the custom field limit for the business object. - As you complete theDetailssection, consider:
Option Description CategorySelect categories for custom reports and calculated fields.Authorized UsageWorkday enables you to restrict the areas where the custom field displays.Example: If you selectIntegrations, the custom field is only visible in integrations.PromptsOnly available when you have a field type ofCustom Instance Reference. - (Optional) AddPermissionsfor custom object security domains.To select a custom domain, it must have an active security policy with at least 1 security group defined.
- As you complete the activation, consider:
Option Description Display ValueAvailable when you selectAllow Multiple Instances per Object. Enter the custom field that you want to display when you specify this custom object as a field in a custom report.You can't remove the custom field that you select as theDisplay Value.Reference IDWhen you selectAllow Multiple Instances per Object, select aDate,Integer, orTexttype custom field to represent the key for each instance of custom data in the multiple-instance custom object.To display multiple-instance custom objects in the EIB prompt, define aReference IDbefore activating the custom object.The custom field must have a unique value for each instance of the Workday object so that it’s identifiable in custom reporting and REST API updates.When you set a custom field as theReference IDfor a multiple-instance custom object, Workday makes that field required. Workday recommends that you select a required custom field because you can't change this validation after you activate the custom object.You can't:- Use theCustom Paragraph Textfield type for aReference ID.
- Add or change theReference IDafter you activate the custom object.
- Remove the custom field that you select as theReference ID.
Help Text for Custom Object EditEnter help text to display on theEdit Additional Datatask.
Enter data for an effective-dated or non effective-dated custom object.
Optionally, you can:
- Add additional data to an active custom object.
- Edit any field for a draft custom object and its custom fields using theEdit Custom Objecttask.
- View custom object details by running theCustom Object Definitionsreport.
- Compare or correct custom data across multiple effective dates using theView Out of Order Custom Object Changestask.
Also, when the Workday object supports profile groups, you can enter custom data on the
Additional Data
tab of the Workday object.