outboundEndPoints & Submitting Data

Where can outboundDataURI be used?

Only on edit pages.

What is the purpose of outboundDataURI?

It defines an outbound endpoint that an edit page can call to send data to an external or Workday REST API.

What fields are required for each outbound endpoint in outboundEndPoints[]?

url, baseUrlType, name, and authType.

Is httpMethod required for Outbound?

No. The default is POST, so httpMethod is only needed when you want to use another method.

What does the baseUrlType attribute specify?

It specifies a dataProvider key defined in the AMD

What does the name attribute do?

It allows you to reference the outbound endpoint when binding a field to a tag value.

What does the authType attribute specify?

It specifies the authentication type ID defined in authTypes[] in the Site Metadata (SMD).

Where is the data provider referenced by baseUrlType defined?

In the App Metadata (AMD).

What does baseUrlType point to?

A dataProvider key in the AMD.

What does the AMD data provider define?

It defines the base URL used by the outbound endpoint.

What is the relationship between baseUrlType and the AMD?

baseUrlType references the AMD data provider's key, whose value contains the base URL.

Example: what does baseUrlType: "workday-procurement" reference?

It references the AMD data provider with:

If baseUrlType is workday-procurement and url is /requisitions, what is the resulting endpoint? A: The endpoint resolves to:

https://api. workday.com/procurement/v3/requisitions

Where are authentication types defined for PMDs?

In authTypes[] in the Site Metadata (SMD).

What authentication type do Workday REST APIs use by default?

SSO

What special rule applies to authentication schemes other than ISU?

You can use the scheme value from the SMD as the authType value in PMDs.

Can outboundDataURI be used on view pages?

No. Only edit pages.

What are the four required outbound endpoint fields?

url, baseUrlType, name, authType.

Example of outboundEndPoints

"outboundData": {"outboundEndPoints": [{"name": "submitRequisition", "url": "/requisitions", "authType": "sso", “httpmethod”:”POST”, "baseUrlType": "workday-procurement"} ]}

Example of valuesOut in a widget

{"id": "supOrg", "enabled": "<% size(superOrgs. value)!= 1 %>", "type": "instanceList", "label": "SupOrg", "valuesOut": [{"value": "<% self. value[0] %>", "valueOutBinding": "simaBO. supervisoryOrganization. id"} ]}

What is the timeout for an individual endpoint on a Presentation Component page?

24 seconds.

What happens if an individual endpoint exceeds 24 seconds?

It returns a timeout error.

What is the total request timeout on a Presentation Component page?

60 seconds.

What can be included in the 60-second request?

Initial page loads, page submissions, and remote validations.

What must happen if multiple endpoints are called in one request?

All operations must complete within the 60-second request limit.

How can you invoke an outbound endpoint conditionally?

Use the exclude attribute.

Does an endpoint failure roll back previous successful outbound requests

No. If one outbound endpoint fails, updates from preceding outbound requests aren't rolled back.

In what order are multiple outbound endpoints invoked?

In the order in which they are defined in outboundEndPoints[].

Does an endpoint failure roll back previous successful outbound requests?

No. If one outbound endpoint fails, updates from preceding outbound requests aren't rolled back.

Can a PMD script use the invoke method to call an outbound endpoint?

No.

What can the invoke method call instead?

A deferred inbound endpoint, which can be an Orchestration that performs additional processing.

Which event can be used to construct or manipulate the outbound request body?

The onSend event.

Invoke Endpoint Example

workersPositionDataDeferred. invoke({'supervisoryOrganizationId': supervisoryOrganization. value[0]})

When should you use valuesOut[] instead of valueOutBinding

When a widget contains multiple related values that need to be submitted to different outbound fields.

The request body of an outbound endpoint oftentimes contains a data collection or a list of records. To bind an outbound field within a list in a valueOutBinding, specify the list [] notation in the field path. Example:

"valueOutBinding": "outboundEndpointName. listName[]. fieldPath

Example of valueOutBounding in Widget

{"type": "text", "id": "quantityText", "label": "Quantity", "valueOutBinding": "submitRequisition. requisitionLines[0]. quantity"},

Example of valueOutBounding in Widget

{"type": "text", "id": "location", "label": "Event Location", "required": "<% true %>", "value": "<% event. location %>", "valueOutBinding": "updateEvent. location"},

Example of valueOutBounding in Widget

{"type": "currency", "currencyCode": "USD", "id": "cost", "label": "Fee (USD)", "valuesOut": [{"value": "USD", "valueOutBinding": "updateEvent. cost. currency"}, {"value": "<%self. value%>", "valueOutBinding": "updateEvent. cost. value"} ]}