--- category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Workday Extend, Platform and Product Extensions/Integration] keyword: [Extend, Model Components, MCBO, Security domains, Business objects, Business processes, Attachment objects, Tasks, Reports] nav: wcp_docs parent_url: /wcp_docs/ title: >- Reference: Model Component Attributes layout: subsection --- Workday Extend enables you to use these attributes when configuring model components: - Common Attributes - Security Domains - Business Objects - Business Processes - Attachment Objects - Tasks - Reports - Fields and Field Types - Derived Fields ## Common Attributes

Attribute	Usage
`id`	Extend uses the `id` to provide identity to components defined in the app. The `id` doesn't display in Workday tenants. It maintains the identity of components when you update your app through subsequent deployments. Use only numeric integers between 1 and 32767.
`name`	Used by aliases used in the tenant, such as Web Service Aliases and WQL Aliases. Extend uses the `name` when referencing app components within the same app. Example: The `name` of a security domain is a `defaultSecurityDomain` of a business object. Enter a unique `name` for each model component type within an app. You can only use alphanumeric characters with upper camel case formatting.
`label`	You can configure an optional `label` that Workday displays in the tenant. If you specify a `label`, it must be unique for each model component type within an app. If you don't specify a `label`, Workday displays the `name` in the tenant.
`description`	You can configure an optional `description` that Workday displays in the tenant: In the Business Object Details report for fields and report data sources of business objects and attachment objects. In the Workday Data Dictionary report for fields of business objects and attachment objects.

## Security Domains Include an `id`, a `name`, and an optional `label` when configuring a security domain. You can reference security domains in business objects and fields within the same app. After you deploy your app to a tenant, you must create a security policy for each security domain.

Attribute	Usage
`enabledForPageSecurity`	When you set this value to `true`, you can secure the pages of your app with a security domain.
`enabledForOrchestrationSecurity`	When you set this value to `true`, you can secure the orchestrations of your app with a security domain.

## Business Objects You can use business objects to define the data model for an app. Each business object contains many [fields](/wcp_docs/hod1558556125085.html#section-fields-and-field-types) and has these additional attributes:

Attribute Usage

defaultSecurityDomains A string array that contains the default security domains that control access to the business object. Each business object requires at least 1 default security domain. You can only use the names of security domains defined in the same app.

Attribute	Usage
`defaultSecurityDomains`	A string array that contains the default security domains that control access to the business object. Each business object requires at least 1 default security domain. You can only use the names of security domains defined in the same app.
`defaultCollection`	Include an `id`, a `name`, a `label`, and optionally a `description` when configuring a `defaultCollection`. Extend uses the `name` value as the name of the REST API resource to access all instances of the business object. Workday recommends that you use a pluralization of your object. Example: Charities. Extend uses the `label` value as the unfiltered report data source for the business object. Workday recommends that you prefix the business object with All and then pluralize it. Example: All Charities. Extend uses the `description` value as the Description of the report data source for the business object in the Business Object Details report.
`enableIndex`	Set this optional boolean attribute to `true` to index the field. You can index up to 5 regular fields for each Extend business object and attachment. You can only index fields that are secured by the default security domains of the business object or attachment. You can't index derived fields or `MULTI_INSTANCE` fields. Extend generates query parameters for all indexed fields in your app. Note: You don't need to apply the `enableIndex` attribute to `SINGLE_INSTANCE` fields of business objects. Extend indexes these fields automatically.

defaultCollection

Include an id, a name, a label, and optionally a description when configuring a defaultCollection.

Extend uses the name value as the name of the REST API resource to access all instances of the business object. Workday recommends that you use a pluralization of your object. Example: Charities.
Extend uses the label value as the unfiltered report data source for the business object. Workday recommends that you prefix the business object with All and then pluralize it. Example: All Charities.
Extend uses the description value as the Description of the report data source for the business object in the Business Object Details report.

enableIndex

Set this optional boolean attribute to true to index the field. You can index up to 5 regular fields for each Extend business object and attachment. You can only index fields that are secured by the default security domains of the business object or attachment. You can't index derived fields or MULTI_INSTANCE fields. Extend generates query parameters for all indexed fields in your app.

Note: You don't need to apply the enableIndex attribute to SINGLE_INSTANCE fields of business objects. Extend indexes these fields automatically.

## Business Processes Defining a business process enables Workday Extend developers to create new business process types and event business objects. These artifacts enable you to manage the state of the business objects you define in your apps.

Attribute	Usage
`description`	The description of the business process.
`targetBusinessObject`	Enter the name of a business object you defined for the app. Workday creates a 2-way reference between the event business object for the business process and the business object defined as the target. Note: The `targetBusinessObject` can't be a Workday-delivered business object.
`securityDomains`	An optional string array that overrides the default security domains defined at the business object level. You can only use the names of security domains defined in the same app.
`details`	A required attribute that references a specific `pageRoute` to a PMD defined in the presentation folder of the app. You can insert the `id` of the event record into the path of the `{eventId}`, enabling users to create a PMD file that calls relevant business process REST APIs and retrieves data from the target business object. Workday renders this page whenever event details display in the tenant.
`approvalStep`	You can add an approval step to business process definitions that you create from the business process type. Add allowed actions to the `approvalStep`. Example: `"actions": ["APPROVE", "DENY", "SEND_BACK"]`. You can define a dedicated `pageRoute` that references a PMD you created for the app. You can include the `{eventId}` in the path so the PMD can use it. When you don't define a `pageRoute`, we provide a basic approval experience to users in My Tasks with no contextual information.
`actionSteps`	You can add 1 or more action steps to business process definitions that you create from the business process type. For each action step, define a dedicated `pageRoute` that references a PMD you created for that action step in the business process definition. Include the `{eventStepId}` in the path so the PMD can use it.
`revisePageRoute`	If `SEND_BACK` is an allowed action on an `approvalStep`, you must define a `pageRoute` for the Revise action. The `revisePageRoute` must reference a PMD you created for that action in the business process definition. Include the `{eventStepId}` in the path so the PMD can consume it.
`allowsCancel`	When you set this value to `true`, you can enable users to cancel the business process event.
`allowsRescind`	When you set this value to `true`, you can enable users to rescind the business process event. When you configure a new Extend business process as a subprocess, we automatically enable the `allowsRescind` attribute.
`allowsManualSendBack`	When you set this value to `true`, you can enable an administrator to manually send back the business process at any point in time, even when the business process isn't assigned to them. To manually send back a business process, the administrator must be in a security group that has access to the Manual Send Back action in the Who Can Do Actions on Entire Business Process section of the business process security policy.
`useForOrchestrate`	When you set this value to `true`, you can: Use an Orchestration to initiate the business process. Edit the business process definition to add an Orchestration Service step.

## Attachment Objects You can use attachment objects to associate file data with a business object and to attach images to a business object.

Attribute	Usage
`defaultSecurityDomains`	A string array that contains the default security domains that control access to the attachment object. Each attachment object requires at least 1 default security domain. You can only use the names of security domains defined in the same app.
`defaultCollection`	Include an `id`, a `name`, a `label`, and optionally a `description` when configuring a `defaultCollection`. Extend uses the `name` value as the name of the REST API resource to access all instances of the attachment object. Workday recommends that you use a pluralization of your object. Example: charityLogos. Extend uses the `label` value as the unfiltered report data source for the attachment object. Workday recommends that you prefix the attachment object with All and then pluralize it. Example: All Charity Logos. Extend uses the `description` value as the Description of the report data source for the attachment object in the Business Object Details report.
`enableIndex`	Set this optional boolean attribute to `true` to index the field. You can index up to 5 regular fields for each Extend business object and attachment. You can only index fields that are secured by the default security domains of the business object or attachment. You can't index derived fields or `MULTI_INSTANCE` fields. Extend generates query parameters for all indexed fields in your app. Note: You don't need to apply the `enableIndex` attribute to `SINGLE_INSTANCE` fields of attachments. Extend indexes these fields automatically.
`isFilePurgeable`	Set this optional boolean attribute to `true` to enable Extend to purge the file data and filename of the attachment object.

## Tasks You can use these attributes when configuring tasks with or without business object context in Workday Extend:

Attribute	Usage
`businessObject`	Use when you want to author a task in the context of the business object. You can create a context-free task by removing the `"businessObject": "MyBusinessObject",` line from the template.
`routePath`	When you enter a `routePath`, you must use an existing `routingPattern` specified in the `tasks[]` array in the AMD file of your app.
`securityDomains`	An optional string array that overrides the default security domains defined at the business object level. You can only use the names of security domains defined in the same app.
`secured`	Set this optional boolean attribute to `true` to provide contextual security on the task in addition to the domain security policy set on the task. You'll only be able to view or run the task as a related action from the instances that you're contextually secured to access.

## Reports You can use these attributes when configuring reports in Workday Extend:

Attribute	Usage
`businessObject`	The business object in your app that contains the report data source.
`defaultSecurityDomains`	A string array that contains the default security domains that control access to all columns within the report. Each report requires at least 1 default security domain. You can only use the names of security domains defined in the same app.
`sortConfigs`	You can use this optional string array to sort reports by specific fields and specify the sort order. For each field you want to sort by, specify these required attributes: `id` `order` `field` `direction` Valid values for `direction` are `ASCENDING` and `DESCENDING`.
`columns`	Use this string array to specify each column you want to display in the report. When you configure a column, you must enter a field specified in the `businessObject` of the report definition. For each column, enter an `id`, a `name`, an `order`, and a `field`. To add a column that returns an instance of the business object, enter `"isSelfReferencing": true` instead of the `field`.

## Fields and Field Types You can configure these attributes when you create fields for business objects and attachment objects. The name and label of a field must be unique within a business object or attachment object.

Attribute	Usage
`securityDomains`	An optional string array that overrides the default security domains defined at the business object level. You can only use the names of security domains defined in the same app.
`isPurgeable`	Set this optional boolean attribute to `true` to enable Extend to purge data stored in the field.

Workday Extend enables you to configure these additional attributes for field types:

Field Type	Additional Attributes
`TEXT`	`isReferenceId`: If `true`, Extend designates this field as the Reference ID of the business object. When you mark a field as the Reference ID, the field is required and you can't delete it. You can only configure this attribute once per business object, and you can't use these symbols in the field name: Backslash Double quotes Forward slash Plus sign Semicolon Workday recommends setting the attribute to `true` before you load data. If `isReferenceID` is `true`, the instance data of the field must be unique. If the instance isn't unique and you attempt to add the attribute to the data model, the deployment will fail. `enableSearch`: If `true`, you can select values of this field from a prompt when you filter by instances in a custom report. You can use the filter to prompt the user to select an instance of the target Extend business object, or you can select an instance of the target Extend business object from the Comparison Value prompt. You can enable a maximum of 3 `TEXT` fields per app for search in prompts. If `enableSearch` is `true`, `enableIndex` must also be `true` for the field. Workday recommends setting the `enableSearch` attribute to `true` before you load data. If `enableSearch` is `true`, the instance data of the field must be unique. If the instance isn't unique and you attempt to add the attribute to the data model, the deployment will fail. Set `enableSearch` to `true` if you want to use the business object in a Discovery Board filter. `useForDisplay`: If `true`, Extend uses the contents of this field to set the display value of the business object or attachment. You can only configure this attribute once per business object or attachment. You can't set this attribute on a `MULTI_INSTANCE` field. Note: By default, the `descriptor` of an attachment object is the `fileName` of the object. When you set `"useForDisplay": true` on a field of an attachment object, the display name and the `descriptor` of the attachment object become the contents of this field. As a best practice, don't use the `descriptor` as the file name within the `fileUploader` or `attachmentList` widgets. When you specify the attachment name, update any PMD that uses the `attachmentList` tag to use the `fileName` of an attachment object. Example: `"attachmentName": "<% getData.image.fileName %>"`
`RICH_TEXT`	This field type doesn’t support these attributes: `enableIndex` `enableSearch` `isReferenceID` `useForDisplay` Use this field type to create fields in business objects and attachment objects that store rich text formatting. Users can then configure text that renders with appropriate formatting, such as bold text, on Extend pages. Example: In the Create Charity task, a user enters a description using the rich text widget formatting tool to create the markup text such as: Bold. Italics. Ordered and numbered lists. When the user accesses the All Charities report, the description includes the formatted text. Workday recommends using Rich Text field type with the rich text widget on PMD pages to ensure the desired format when writing and viewing data. For PMD page limitations, see richText. On Extend pages, use a rich text widget or a formatting tool to create the markup text. Note: This functionality only applies to new fields you create in your Extend app. You can’t change the field type for existing business objects and attachment objects in promoted apps (IMPL/SBOX/PROD).
`DATE`	`precision`: You can configure this attribute to set the precision of the date. You can use these values: `MILLISECOND` `SECOND` `MINUTE` `HOUR` `DAY` `MONTH` `YEAR`
`DECIMAL`	`decimals`: You can configure this attribute to define up to 10 decimal places.
`INTEGER`	None.
`CURRENCY`	None.
`BOOLEAN`	None.
`SINGLE_INSTANCE`	`target`: A string containing the name of another business object defined in the same app or the name of a Workday-delivered business object. `secureByTarget`: When `true`, Workday delegates contextual security to the instance of the target business object in addition to the security it applies to the Extend business object. `useForDisplay`: If `true`, Extend uses the contents of this field to set the display value of the business object or attachment. You can only configure this attribute once per business object or attachment. Note: By default, the `descriptor` of an attachment object is the `fileName` of the object. When you set `"useForDisplay": true` on a field of an attachment object, the display name and the `descriptor` of the attachment object become the contents of this field. As a best practice, don't use the `descriptor` as the file name within the `fileUploader` or `attachmentList` widgets. When you specify the attachment name, update any PMD that uses the `attachmentList` tag to use the `fileName` of an attachment object. Example: `"attachmentName": "<% getData.image.fileName %>"`
`MULTI_INSTANCE`	`target`: A string containing the name of another business object defined in the same app or the name of a Workday-delivered business object. You can't set the `secureByTarget` or `useForDisplay` attributes on a `MULTI_INSTANCE` field. You can't convert `SINGLE_INSTANCE` fields to `MULTI_INSTANCE` fields. Workday recommends that you keep the count of instances per `MULTI_INSTANCE` field below 1,000. Larger numbers of instances per `MULTI_INSTANCE` field might affect performance.

Note: When you add or update a `CURRENCY` field in a business object, you must include the `currency` and `value` attributes in the API request body. Example: ``` { "name": "DogsMatter", "description": "Charity for Dogs", "minDonationAmount": { "currency": "USD", "value": "50" }, "maxDonationAmount": { "currency": "USD", "value": "1000" } } ``` ## Derived Fields You can configure the same attributes on derived fields as you can on standard fields. However, Extend doesn't support the `CURRENCY` or `SINGLE_INSTANCE` field types for derived fields. ### Related Information [Administrator Guide: Concept: Workday REST API Date, Time, and Time Zone Handling](https://doc.workday.com/access/sources/dita/topic?wd:docset=adminguide&ft:locale=en-US&resourceid=jas1392746623599) [Tutorial: Getting Started with Model Components](https://wd5.myworkday.com/workday/learning/course/84f2dcc34eff01f6facdbc20612cd98b?type=9882927d138b100019b928e75843018d) [Administrator Guide: Steps: Set Up Currencies](https://doc.workday.com/access/sources/dita/topic?wd:docset=adminguide&ft:locale=en-US&resourceid=dan1370796985702) [Reference: Derived Fields](/wcp_docs/syr1643821053546.html)