Includes the ID in descriptor fields (applies when ConnectionType is set to WQL).

Syntax

Connect-Workday -IncludeIDInDescriptor bool

Data Type

bool

Default Value

true

Remarks

Rows in WQL that reference other rows store data in two parts: an internal Workday ID and a descriptor that is a human-readable name for the row being referenced.

For example, a country may have the internal ID 86bc49361cf911ee9f2d00155d17ccfc with the descriptor "Canada".

The cmdlet exposes these as two columns, for example, [visaCountry.id] and [visaCountry.descriptor].

This connection property determines the values of the descriptor column:

• By default, the cmdlet combines the values into a name like "Canada / 86bc49361cf911ee9f2d00155d17ccfc". This allows the cmdlet to optimize filters and aggregations using the descriptor column. The cmdlet extracts the ID value and sends it to Workday while the query uses the more readable descriptor value.
• If this connection property is set to False, the cmdlet reports only the descriptor text in the descriptor column.

The cmdlet performs the following optimizations when this connection property is set to True:

SELECT * FROM foreignWorkers WHERE [visaCountry.descriptor] = 'Canada / 86bc49361cf911ee9f2d00155d17ccfc'
-- WQL: The ID value is extracted and filtered directly
SELECT ... FROM foreignWorkers WHERE visaCountry = '86bc49361cf911ee9f2d00155d17ccfc'

SELECT [visaCountry.descriptor], COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.descriptor]
-- WQL: The ID value is used for aggregation and combined with the descriptor when reading. 
SELECT visaCountry, COUNT(*) FROM foreignWorkers GROUP BY visaCountry

-- Doing this with IncludeIDInDescriptor=false requires aggregating by the ID and looking up the descriptor
-- SELECT t2.descriptor, t1.COUNT FROM (SELECT [visaCountry.id] AS id, COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.id]) t1
--                                INNER JOIN foreignWorkers t2 ON t1.id = t2.id