---
category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Integration]
keyword: [Integrate, Workday Integration, Orchestrate for Integrations, Orchestration, Orchestration Builder]
nav: wcp_docs
parent_url: /wcp_docs/
title: >- 
  Reference: JoinResiduals Member Functions
layout: subsection
---

<a id="d352e91"></a>
<b>Instance Type: JoinResiduals</b>

<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>booleanJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>Boolean
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type Boolean.</p></td></tr><tr><td>csvRowJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>CsvRow
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type CsvRow.</p></td></tr><tr><td>csvRowSkippedRecords</td><td>Arguments: <ul><li>None
</li></ul> Return Type: <ul><li>CsvRowIterator
</li></ul> <p>Returns an iterator of skipped records in cases where the records are of type CsvRow.</p></td></tr><tr><td>dataJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>Data
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type Data.</p></td></tr><tr><td>dataSkippedRecords</td><td>Arguments: <ul><li>None
</li></ul> Return Type: <ul><li>DataIterator
</li></ul> <p>Returns an iterator of skipped records in cases where the records in the Join On data set are of type Data.</p></td></tr><tr><td>dateJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>Date
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type Date.</p></td></tr><tr><td>dateTimeJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>DateTime
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type DateTime.</p></td></tr><tr><td>localTimeJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>LocalTime
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key in cases where the record is of type LocalTime.</p></td></tr><tr><td>missingMatches</td><td>Arguments: <ul><li>joinOnRecord (Any type)
</li></ul> Return Type: <ul><li>MatchedWithIterator
</li></ul> <p>Returns an iterator of the missing matches for the specified skipped record.</p></td></tr><tr><td>multipleBooleansJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>BooleanIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of type Boolean.</p></td></tr><tr><td>multipleCsvRowsJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>CsvRowIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of type CsvRow.</p></td></tr><tr><td>multipleDataJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>DataIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of type Data.</p></td></tr><tr><td>multipleDatesJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>DateIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of Date type.</p></td></tr><tr><td>multipleDateTimesJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>DateTimeIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of DateTime type.</p></td></tr><tr><td>multipleLocalTimesJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>LocalTimeIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of LocalTime type.</p></td></tr><tr><td>multipleMatches</td><td>Arguments: <ul><li>joinOnRecord (Any)
</li></ul> Return Type: <ul><li>MatchedWithIterator
</li></ul> <p>Returns an iterator of the multiple matches for the specified skipped record.</p></td></tr><tr><td>multipleNumbersJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>NumberIterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of Number type.</p></td></tr><tr><td>multipleStringsJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>String Iterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of String type.</p></td></tr><tr><td>multipleZonedDateTimesJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>ZonedDateTime Iterator
</li></ul> <p>In the case of multiple matches, returns an iterator of the unused Joined With records for the specified outputName and key, where each value is of ZonedDateTime type.</p></td></tr><tr><td>noJoinOnRecords</td><td>Arguments: <ul><li>None
</li></ul> Return Type: <ul><li>Boolean
</li></ul> <p>Returns true if the join-on iterator didn't yield any records.</p></td></tr><tr><td>numberJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>Number
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key, where the record is of Number type.</p></td></tr><tr><td>stringJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>String
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key, where the record is of String type.</p></td></tr><tr><td>stringSkippedRecords</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>String Iterator
</li></ul> <p>In the case where the records in the Join On data set are of type String, returns an iterator of skipped records that are missing or have multiple matches.</p></td></tr><tr><td>summary</td><td>Arguments: <ul><li>None
</li></ul> Return Type: <ul><li>String
</li></ul> <p>Returns a summary of skipped records and unused Join With keys for display purposes.</p></td></tr><tr><td>toString</td><td>Arguments: <ul><li>None
</li></ul> Return Type: <ul><li>String
</li></ul> <p>Returns a string representation of the value.</p></td></tr><tr><td>unusedJoinWithKeys</td><td>Arguments: <ul><li>outputName (String)
</li></ul> Return Type: <ul><li>StringList
</li></ul> <p>Returns a list of unused Join With keys for the specified outputName.</p></td></tr><tr><td>unusedMultipleMatchJoinWithKeys</td><td>Arguments: <ul><li>outputName (String)
</li></ul> Return Type: <ul><li>StringList
</li></ul> For the specified outputName, returns a list of keys that are unused because they occur more than once in the Join With dataset and the multiple match rule is configured to skip records.</td></tr><tr><td>zonedDateTimeJoinedWith</td><td>Arguments: <ul><li>outputName (String)
</li><li>key (String)
</li></ul> Return Type: <ul><li>ZonedDateTime
</li></ul> <p>Returns the unused Joined With record for the specified outputName and key, where the record is of ZonedDateTime type.</p></td></tr></tbody></table><br/>

