Workday Adaptive Planning Collectors

Type

Required

Workday Adaptive Planning

Name

Required

Descriptive free-text name for the collector

Data Source

Required

Select a pre-configured data source from the drop down or click Create New to create a new data source.

Schema Name

Required

Enter a name for the schema where the collected data will be stored. This can be a pre-configured schema or a new schema which will be created the first time the collector is run.

Credential

Required

Select a pre-configured Workday Adaptive Planning credential from the drop-down.

Adaptive Collector Type

Required

Export Attributes

rowtype

Value will be either Attribute or AttributeValue.

Indicates whether the row represents a custom attribute or the value of a custom attribute.

parentid

Populated for attribute values only.

Indicates this value's parent attribute or attribute value.

id

Workday Adaptive Planning internal id number. This value is required when making updates to the attribute or attribute value.

name

Name of the attribute or attribute value.

type

Populated for attributes only.
Value will be either account, level, or dimension.

Indicates whether the attribute can be applied to a Workday Adaptive Planning account, level or dimension.

autocreate

Populated for attributes only.
Value will be either 0 or 1.

Indicates whether an attribute value can be created automatically for this attribute when data is loaded. If 0, attribute values will not be created. If 1, attribute values will be created.

keepsorted

dimensionid

Populated for attributes of type dimension only.

Indicates the custom dimension the attribute is associated with.

seqno

Per Adaptive API docs:

Added in API v17 but reserved for future use.

Type

Workday Adaptive Planning

Name

Descriptive free-text name for the collector

Data Source

Select a pre-configured data source from the drop down or click Create New to create a new data source.

Schema Name

Enter a name for the schema where the collected data will be stored. This can be a pre-configured schema or a new schema which will be created the first time the collector is run.

Credential

Select a pre-configured Workday Adaptive Planning credential from the drop-down.

Workday Adaptive Planning Collector Type

Export Dimensions

Version Name

If selected, only dimensions associated with this version will be collected.

Dimensions

Only information for the selected dimension(s) is returned.

Include Attributes

If true, attributes and attribute values for the dimensions are collected.

Include Dimension Values

If true, dimension values are also collected.

Include Inaccessible Values

If true, values inaccessible to the current user are collected. Defaults to false. Only users with the "Modeling" or "Import to all levels" permissions may set this option to true.

rowtype

Value will be one of Dimension, DimensionValue, or Attribute

Indicates whether the row represents a custom dimension, a dimension value or an attribute value.

parentid

Populated for DimensionValue and Attribute rows only.

If rowtype is DimensionValue, indicates the value’s parent dimension.
If rowtype is Attribute, indicates the values parent dimension value.

id

Populated for Dimension and DimensionValue.

Workday Adaptive Planning internal id number. This value is required when making updates to the dimension, dimension value or attribute value.

name

Name of the dimension, dimension value or attribute. (The value of the attribute is in the value column.)

shortname

Populated for dimensions and dimension values only. As configured in Workday Adaptive Planning.

autocreate

Populated for dimensions only.
Value will be either 0 or 1.

Indicates whether a dimension value can be created automatically for this dimension when data is loaded. If 0, dimension values will not be created. If 1, dimension values will be created.

listdimension

Populated for dimensions only.
Value will be either 0 or 1.

Indicates whether the dimension is a list dimension (1) or not (0).

keepsorted

Populated for dimensions only.
Value will be either 0 or 1.

Indicates whether the dimension is kept sorted in the Workday Adaptive Planning UI.

useonlevels

Populated for dimensions only.
Value will be either 0 or 1.

1 if the selected dimension can be used on levels, 0 otherwise.

seqno

Per Workday Adaptive Planning API docs:

Added in API v17 but reserved for future use.

description

Populated for dimension values only.

value

Populated for attribute row types only.

attributeid

Populated for attribute row types only. The id of the attribute. This value can be matched to an attribute collected via Export Attributes. Use parentid to associate the attribute value to a dimension.

valueid

Populated for attribute row types only. The id of the attribute value.

Type

Workday Adaptive Planning

Name

Descriptive free-text name for the collector

Data Source

Select a pre-configured data source from the drop down or click Create New to create a new data source.

Schema Name

Enter a name for the schema where the collected data will be stored. This can be a pre-configured schema or a new schema which will be created the first time the collector is run.

Credential

Select a pre-configured Workday Adaptive Planning credential from the drop-down.

Workday Adaptive Planning Collector Type

Export Levels

Version Name

If selected, only levels associated with this version will be collected.

Include Groups

If true ,a comma-separated list of all groups the level is in is collected.

Include Inaccessible Values

If false, the response will only include levels to which the user has data access, either direct or implied. Note that this means the response may no longer be a single rooted tree of levels, but may be a series of disjoint subtrees of the overall tree.

Include Uncategorized

If true include phantom levels. Phantom levels are included in the response only when the user has access to them.