Steps: Set Up Planning Data Sources
You can use Adaptive Planning as a data source to import metadata and data from your current instance, or another instance. When you set up a Planning data source, you need to create an Adaptive Planning credential. The Adaptive Planning credential lets you reuse authentication details with more Adaptive Planning data sources or loaders.
Watch the video:
3m 16s
Prerequisites
Prerequisites
- Create an Adaptive Planning Data Source Credential
- Verify that the Adaptive Planning credential you select for this data source has the permissions and dimensional access for the metadata and data you need.
- Permissions required:Integration Operator > Data Designer.
Navigation
From the nav menu, go to Basic Steps
- Create an Adaptive Planning credential.
- Create a Planning data source.
- Select the Adaptive Planning sources, such as sheets, dimensions, levels, accounts, attributes, time periods, and versions to import.
- Import the Adaptive Planning structure from the sheets or accounts.
- Import the Adaptive Planning data from staging tables.
- Automate Adaptive Planning imports using an integration task.
Create an Adaptive Planning Credential
Follow the steps to Create an Adaptive Planning Data Source Credential.
Create a Planning Data Source
- Expand Data Sources in the Component Library and selectCreate New Data Source.
- SelectPlanning Data Source.
- Enter a unique name for the data source and selectApply.
- Select an existing Adaptive Planning credential. If one doesn't exist, create it using the steps described earlier. You can select a Workday Credential if the Adaptive Planning user is synchronized from Workday.
- Save the data source settings.
- SelectTest Connectionto verify your credential settings work.
Select Adaptive Planning Sources to Import
The
Adaptive Planning
data source only imports from the sources you select.- Select the Planning Data Source you just created in the Component Library if it isn't already selected.
- SelectManage Sourcesin the Actions pane.
- Select theSourcesfolder in the Manage Sources dialog.
- SelectAddbeneath the Sources folder, or right-click on theSourcesfolder and selectAddto select a:
- Folder to create a container for organizing your sources
- Account source
- Attribute source
- Cube Sheet and its levels, version parameter, and period range
- Dimension
- Level source
- Modeled Sheet and its level and version parameter, and optional period parameter
- Custom source from your selection of dimensions, account, levels, version, and period range from anywhere in your instance. See the Create Parameters for Filters in Custom Sources section for more information. (Optional) you can also include account rollups and level rollups. Account rollups are enabled by default for any preexisting or new Planning Data Sources. Level rollups are disabled by default.
- Time source
- Version source
- Give the source a name indicating how you will use it and selectApply. For example, if this source contains an expense sheet for 2019, you could name it "expense sheet 2019"
- Repeat these steps to add all of the Adaptive Planning sheets and model elements you want to import. Each source becomes a separate table in the staging area.
- (Optional) SelectInclude Codesto include codes for dimension values, attribute values, and levels when your instance supports display names.
- SelectSavein the Actions Pane.
- Create Parameters For Filters in Dimension Sources
- When you select a dimension filter parameter, the import dimension data only returns the filtered dimensions. You can select:
- Only the External Dimension parameter if your Planning credential is connected to an external instance.
- The Shared Dimension parameter if your Planning credential is connected to a self instance.
When you select the version filter parameter, the import dimension data only returns the version filtered dimensions. You can select:- Only the External Version parameter if your Planning credential is connected to external instance.
- The Shared Actuals Version parameter or shared Plan Version if your Planning credential is connected to self instance.
We don't automatically select any dimension parameters.To create parameters for dimension or version filters:- SelectEdit Parametersin theSettingstab of your Dimension Source. You can also select shared parameters when your planning credential is connected to your local instance. This enables you to reuse the available shared parameters for other data sources.
- Right-click theLocalfolder and selectAddin the Edit Parameters dialog.
- SelectExternal Versionto choose the version you want to use.
- SelectExternal Level Singleto choose a single level.
- SelectExternal Level Multipleif you want to choose more than one level.
- SelectExternal Accountto choose the accounts you want to use.
- SelectPeriod Rangeto configure a fixed or dynamic period range.
- Give your parameters names that let you understand their use.
- SelectApply.
With local parameters created, you can now select them for the Account, Level, Version and Period Range filters in the Dimension Source. - Create Parameters For Filters in Custom Sources
- When you create a Custom Source you select parameters for the Account, Level, Version, and Period Range in the Adaptive Planning instance your credentials connect to. You need to create parameters before you can select them. Remember, these parameters relate to what you can select on the external Adaptive Planning instance.The word External you see when you create these parameters reminds you that you are creating them for an external Adaptive Planning instance. You can select shared parameters when your planning credential is connected to your local instance. This enables you to reuse the available shared parameters for other data sources.
- SelectEdit Parametersin the Settings tab for the Custom Source.
- Right-click theLocalfolder and selectAddin the Edit Parameters dialog.
- SelectExternal Versionto choose the version you want to use.
- SelectExternal Level Singleto choose a single level.
- SelectExternal Level Multipleif you want to choose more than one level.
- SelectExternal Accountto choose the accounts you want to use.
- SelectPeriod Rangeto configure a fixed or dynamic period range.
- Give your parameters names that let you understand their use.
- SelectApply.
With local parameters created, you can now select them for the Account, Level, Version and Period Range filters in the Custom Source. - Aggregation
- You can select how to aggregate data along time strata for Cube and Custom sources. Select any of your calendars as the Aggregation Calendar, then select an Aggregation Stratum from that calendar. If you don't select a calendar, your default calendar automatically populates.
Import Structure From Adaptive Planning Sources
After you select the Adaptive Planning sheets and model elements to import, import their structure before importing their data.
Importing structure requires a manual action, and will not run automatically when you select Import Data. If you don't import structure after it has changed, you will see an error prompting you to Import Structure again to update the structure.
- SelectImport Structureand view the import progress.
- Close the Import Structure dialog.
- View the Data Components for the tables and columns you imported. All of the sources you chose from Manage Sources also automatically appear in the staging area so you can preview the data they contain.
- Save the data source.
- Customize Table Settings
- You can customize how data from each Adaptive Planning table imports.
- Select the triangle next to the table name in the Staging Area.
- SelectTable Settings.
- Change the settings. What you can choose varies depending on the table columns.
- Data Import Mode:
- All records replaced each time a data import is run
- All received rows are new and so should be added
- All records that fall within a period range transmitted (available only if a source sheet contains a Timespan)
- Page Cube Sheet Data by Time Strata
- If you set a period parameter you can page cube sheet import data by the time strata that appear in that cube sheet. For example, you can select from Year, Month, or Quarter if those time strata exist for the sheet. Paging breaks apart the import request by time strata, making large cube sheet imports more efficient. The import progress indicates the status of each page load.
Import Data From Adaptive Planning
Once the Adaptive Planning sheet and model element structures import, you can import their data.
- Drag any additional Adaptive Planning tables you might want from the Data Components area into the Staging Area
- SelectImport Datain the Actions Pane. The data gets processed by your import filters and parameters.
- Provide any needed values for parameter prompts that appear at run-time.
- View the import progress for any import errors or messages.
- Review the data in the Staging Area. Imported data remains there until you clear it by selectingClear staging tablesin the Actions pane.
After you import to the staging tables, you can load from staging into Adaptive Planning with a loader.
- Specify the Source Version during run-time
- You can change theExternal Versionparameter at runtime to return filtered data and runImport Datawith the updated filter value. Go toManage SourcesinActions paneto set the external Version parameter.Example: When you set the Version filter for a Sheet source to be an External Version parameter and run Import Data, we populate the Plan Version drop down list with versions that were available during the external version configuration.
- Reimporting Dimension Values After Deleting One in the Dimension Admin
- If you reimport dimension values after deleting one in the Dimension Admin, a row for the deleted dimension value appears in the staging area. The row contains a hidden isDeleted column set to True in the staging table preview.To get rid of this row, clear your staging table and reload it.
Automate Imports Using an Integration Task
With a data source set up, you can create an Integration Task that runs this loader on a schedule automatically.
Any Integration Task can have one or more loaders. A task can contain other tasks, like a Planning Data Loader, a Planning Account Loader, or a Scripted Loader.
Best Practice: Have separate Integration tasks for each loader.
If a task contains multiple loaders, parameters from each loader display in a prompt when the task runs. If there is a common or shared parameter in the loaders within a task, the task prompts for the parameter only once. You can select to override parameter prompts.
For scheduled runs of the task, default values of the parameters are used.