跳至主要内容
文档
文档
Adaptive Planning
Create Planning Association Loaders

Create Planning Association Loaders

The Planning Association Loader lets you map metadata about user dimension and level associations from the staging area into
Adaptive Planning
. Associations connect levels and custom dimensions to users. Level ownership is a type of user association that connects users to levels. Unlike regular level associations, level ownership also comes with other privileges. See.
Once you create a loader, you can run it manually or schedule it to run as part of an Integration task. See Create Integration Tasks.

Prerequisites

  • The Planning Association Loader requires staging data from an import of an existing Data Source.
  • Required Permissions: Model, Integration Operator, Data Designer

Basic Steps

  1. Enter data source settings
  2. Configure column mapping
  3. Create business rules
  4. Preview the loader output
  5. Run or schedule the loader

Navigation

Compass.png From the nav menu, go to
Integration
Design Integrations

Enter Data Source Settings

The Data Source Settings lets you choose the source table you want to use from integration staging data, and select what associations to load.
  1. Select
    Create New Loader
    in the
    Loaders
     pane of the Component Library.
  2. Select
    Planning
    Association Loader
    as the loader type. Enter a name for the loader.
  3. Click
    Create
    .
  4. Enter the Association Loader
    General Properties
     information in the
    Data Source Settings tab
    :
    • Source Table
      : Select the source table from the dropdown list. The source tables in the list are of all the tables available in the staging area you have access to.
    • Mapping Profile
      : You can link to a mapping profile as part of the loader creation process. Select the mapping profile from the dropdown list. The mapping profiles in the list are the ones you have access to. See the mapping profile section of the Planning Data Loader. This mapping profile, along with any mappings loaded as part of metadata loaders map the planning levels and dimensions. See Create Planning Data Loaders. Example: If the association loader has level column value "999999" (or for Workday, a WID) then the mapping profile determines which planning level that refers to.
    • Level or Dimension
      : Select level for level ownership or level association. Select a dimension to load dimension associations.
    • Attribute:
       (Optional) Select an Adaptive Planning attribute for the level or dimension. This lets you map and load associations for level or dimension attributes.
    • Mode
      : Select
      Update
       to modify associations or ownership assignments on a subset of levels. This updates the level, not the user. Updates to the level require all users associated with that level in the payload. Select
      Replace All
       to delete all users within the associations mentioned in the payload and replace them.
      • If you use Adaptive Planning with Workday Human Capital Management or Workday Financials,
        Mode
         automatically populates with
        Update
        .
      • If you don't use Adaptive Planning with Workday Human Capital Management or Workday Financials,
        Mode
         automatically populates with
        Replace All
        .
    • Proceed with warnings
      : Check to continue running the loader with warnings. If you leave it unchecked, the loader will stop when it encounters a warning. Enabling this means the loader skips unmapped dimensions or levels and creates a warning in the logs while allowing the loader to continue processing.
    • Log Level:
       Choose the type of details to capture when running the loader.
      • Off
        : No errors logged.
      • Error
        : Log serious errors only.
      • Info
        : Log basic information, such as when the loader was updated.
      • Verbose
        : Detailed information about all phases and actions. Used primarily for debugging or auditing.

Configure Column Mapping

Column Mapping lets you map columns from the data source to the associations available in
Modeling > Model Management > Levels
 or
Modeling > Model Management > Dimensions
. You must map
User
 and
Planning Columns
.
If you are a Workday customer running a User Sync in this environment, the User column must map to the source column that contains WIDs. If you didn't run User Sync or are not a Workday customer, the user column needs to be mapped to the source column that contains usernames or emails.
If there are several
Planning Columns
 to map, use the
Show
filter to select:
  • All:
     Shows all users.
  • Required
    :
    Shows all required Planning columns, like User and Level.
  • Unmapped
    :
    Shows all unmapped Planning columns.
  • Mapped
    :
    Shows all mapped Planning columns.
You can use the
Search
field to find columns. Enter a complete or partial name to search for and click the magnifying glass. Any staging columns matching the search appear in the results.
Map Columns
  1. Click the
    Column Mapping
    tab. The Column Mapping tab has these columns:
    • Status
      : A checkmark Mapped Column indicates a mapped column. An exclamation point Unmapped Column indicates an unmapped column.
    • Planning Column
      : Displays all of the Planning columns available for mapping. Mandatory Planning columns are indicated by bold text with an asterisk.
    • Source Column
      : Displays the columns within the staging table chosen from the Data Source Settings.
  2. Select an unmapped column and click the dropdown. A list of columns you can map to appears in the dropdown list. As you map the columns, the status indicator changes from red IntegrationMappingUnmapped.png to green IntegrationMappingMapped.png.
Mapping Columns for Level Ownership
If you want to load only level ownership, don't map an identifier for the association code for the level in the
Source Column
. Level ownership in
Administration
 >
Associations
 comes from leaving the association code empty.
Mapping Columns for Level and Dimension Association
If you want to load level and dimension associations, map an identifier such as
Ref ID
 for the association code in the
Source Column.
You can't load both level ownership and level association in a single loader. Create one loader for level ownership and a separate loader for level association.
Mapping Columns for Attribute Association
If you want to load level or dimension attributes with associations, map them in the
Source Column
. Attributes appear at the bottom of the mappings, below Association Name.
Unmap Columns
You can unmap columns to ignore the staging data you don't want to load. You can also unmap columns one at a time following loader runs, to troubleshoot which columns generate errors in the logs.
To unmap columns, click
Unmap
and choose:
  • Unmap All
    : Unmaps all of the the columns.
  • Unmap Selected
    : Unmaps only the columns that are selected.
Unmapping a column changes the status icon to an en exclamation point IntegrationMappingUnmapped.png.

Create Business Rules

You can use Business Rules to create SQL expressions that limit the staging data that is available for loading. Only records that meet your filter criteria will load.
The
Business Rules
 tab contains a text area for entering SQL:
To create an SQL filter:
  1. In the
    Business Rules
     tab, select
    SQL Filter
    . Click
    Edit
    .
  2. Enter an SQL expression. You can click an item in the
    Available Columns
     list to bring that column into the SQL expression instead of typing it.
  3. Click
    Apply
    to check your SQL syntax. Errors in your syntax turn the border around the expression red. Hover your cursor over the SQL editor to see syntax error information.
    For detailed SQL syntax help, click
    'online help'
    in the Notes section of the Edit SQL Filter. See Reference: SQL Expressions.
  4. Correct any errors in your syntax and click
    Apply
    . Only staging rows that match the SQL expression will import when you run the loader.

Preview the Loader Output

You can preview the loader output before performing a full load to check that the mappings work how you want. You can also download its output as an XML file to manually verify the user level ownership associations from your data source against your requirements before loading them.
Click
Preview loader output
 in the Actions pane.
The loader runs, applying all transformations and business rules as part of the run. A status popup displays the steps the loader executed. If there are user association values to load, the loader creates an XML file and sends an email notification with the output of the loader as a zipped XML attachment.
An additional popup lets you download the preview loader output as a zipped XML file after the loader succeeds. The download popup may take a moment to appear depending on the number of association values and the size of the file.
Fix Validation Errors
When the preview loader output or manual load runs, the source data is validated for errors. Examples of the validations include checks if:
  • The Source Id value for the User or Level and Dimension value is missing (empty) in the data.
  • The Source Id is not mapped.

Run the Loader

After saving a Planning Association Loader with all the required configuration settings, the loader can be run manually or run as a scheduled integration task.
Wait about 15 - 30 minutes between each Planning Association Loader run so that the
Adaptive Planning
 has time to synchronize with your import. Larger imports take longer to synchronize. Wait time depends on model size and other factors.
You can import directly from the source system or you can run the loader using staging values that were already imported. When the loader runs, select which of these behaviors you want. Choose
Bypass data import
to use the existing staging table for loading. Bypassing data import is not available when using spreadsheets as data sources.
As part of the run process, the loader checks that the data in the staging table has been mapped correctly. Multiple validations are applied during the load. Any errors that occur during the load indicate what needs to be resolved for a successful import.
Include the Planning Association Loader in an Integration Task
Any integration task can contain one or more loaders. A task can also contain other integration tasks as well as Discovery metric loaders and scripted loaders.
Best Practice: Have separate integration tasks for each loader.
If a task contains multiple loaders, then parameters from each loader are presented when the task is run. If there is a common/shared parameter used in the loader(s) within a task, then the task only prompts for the parameter once. You can choose to override parameter prompts.
For scheduled runs of the task, the default values of the parameters stored when the loaders were created are used.