Reference: PagedGet Subassembly Properties
Common Tab
Property | XML Attribute Name | Description |
|---|---|---|
Id
| id
| The unique ID of the PagedGet subassembly within the
assembly. |
Routes Response To
| routes-response-to
| The destination of the response message for the PagedGet
subassembly. |
Execute When
| execute-when
| A condition that determines whether the PagedGet subassembly
executes. |
Endpoint
| endpoint
| The target endpoint address for the subassembly. The PagedGet
component supports a vm:// endpoint address. Example:
vm://wcc/PagedGet . |
Advanced Tab
Property | XML Attribute Name | Description |
|---|---|---|
Store Message
| store-message
| Specify none unless otherwise advised by Workday Support.To
store messages, use Studio's store
step. |
Transport Class
| transport-class
| Specifies an alternative implementation class on a per-assembly basis, if
required. You can globally change the implementation classes by
editing the WEB-INF/classes/spring/assembly-bean.xml file. |
Ignore Dynamic Endpoints
| ignore-dynamic-endpoints
| Specifies whether to ignore the dynamic WS-Addressing (WSA) value in the incoming
message's header or use it to override the value in the transport's
Endpoint property.Use the
set-dynamic-endpoint step to specify
WS-Addressing details. |
Clone Request
| clone-request
| Specifies whether to chain processing between subassemblies. Set to
true to create a copy of the original message so
that any subassembly modifying the request message won't affect the others.
Set to false to pass the original message. |
Propagate Abort
| propagate-abort
| Specifies whether an abort flag propagates from a subassembly to the calling
assembly. A subassembly stops processing when it marks the
MediationContext as aborted. |
Unset Properties
| unset-properties
| Specifies whether all local-out properties reset after the
local-out transport calls a
subassembly. |
Parameters Tab
Parameter | Description |
|---|---|
is.paged.get.request.current.page.xpath
| The XPath location in the request document where the PagedGet
component sets the number of the pages being requested. |
is.paged.get.response.current.page.xpath
| The XPath expression to extract the current page value from the web service response
message. |
is.paged.get.response.total.pages.xpath
| The XPath expression to extract the total pages value from the web service response
message. |
is.paged.get.response.total.results.xpath
| The XPath expression to extract the total results page value from the web service
response message. |
is.paged.get.process.endpoint
| The local-in endpoint of the subassembly that processes each
page of results. Example:
vm://payrollInterface/ProcessPayeesLocalIn .Workday
ignores aggregate parameters when you set this parameter. These
MediationContext properties are available in the
processing subassembly:
|
is.paged.get.aggregate.header
| The header value for aggregated responses in the form of an XML fragment. Example:
<AllData> . |
is.paged.get.aggregate.footer
| The header value for aggregated responses in the form of an XML fragment. Example:
</AllData> . |
is.paged.get.aggregate.xpath
| The XPath expression to apply to the response message when aggregating. |
is.paged.get.namespaces
| Specifies namespaces that aren't available on the document. |
is.paged.get.application
| The application group of the web service you're invoking. Example:
Human_Resources . |
is.paged.get.version
| The version of the public web service you're invoking. As best
practice, use the latest WWS version at the time you're building the
integration. Don't use a dynamic latest version that changes as the
integration runs. For assemblies with a version before 2016.45, this
parameter automatically populates with
util.assemblyVersionAsWWSVersion .For assemblies with a version 2016.45 or later, you must explicitly
supply the Web services version. Example: v27.2 . |
is.paged.get.page.zero
| Specifies whether a response page should be generated for cases where
the total number of pages is zero. |
is.paged.get.parallel
| Specifies whether to retrieve web service responses in parallel, enabling the
subassembly named in the is.paged.get.process.endpoint
parameter to process each paged response. Automatically populates with
false , meaning that web service responses are
aggregated rather than retrieved in parallel.Workday processes parallel
responses using unique contexts that enable read-only access to the
property values and variables that were set before the
PagedGet was entered. When the subassembly
finishes with each page, you lose any properties or variables set during
that processing. The PagedGet still sets the
is.paged.get.total.pages and
is.paged.get.total.results properties on the
calling MediationContext . The
is.paged.get.current.page property is set in the
parallel paged contexts.Workday processes nonparallel responses
in the same context and processes the pages in the subassembly. This
means that you can set properties and variables in the subassembly and
check the state of previous pages. |
is.paged.get.store.requests
| Specifies whether to store the web service request messages for each
page of data in the message store. |
is.paged.get.overall.timeout.seconds
| The overall timeout in seconds. The default, if unset, is 6 hours. The
maximum timeout you can set is 30 hours. |
is.paged.get.timeout.seconds
| The timeout for processing each page. The default, if unset, is 6
hours. Can't exceed the overall timeout value. |
Out Parameters
As the
PagedGet
subassembly processes, it passes these out-parameter
values for use by downstream components:
Out-Parameter | Description |
|---|---|
is.paged.get.last.page
| The final page returned by the web service operation. |
is.paged.get.current.page
| The number of the page currently being processed. |
is.paged.get.total.pages
| The total number of pages to be processed. |
is.paged.get.total.results
| The total number of results returned by the web service
operation. |