Anaplan model connections as a pipeline source or sink

To connect your pipeline to an Anaplan model, you can create the model connection when you create the pipeline. Once created, the model connection can be used for other pipelines.

In the sections below, the procedures are similar and involve how to set up an Anaplan model as either a source or sink. The key differentiator between the use cases is where you specify the Anaplan model.

This table summarizes the process of how to create a pipeline with a model for various use cases.

This section describes how to create a pipeline with an Anaplan model as the data source.

To create a pipeline with an Anaplan model as a source:

1. Select Data Orchestrator from the top-left navigation menu.
2. Choose a dataspace from the list.
3. Select Pipelines from the left-side panel.
4. Select Create pipeline.
5. Enter a Name for your pipeline and then select Create.
   You are taken to the pipeline designer view.
6. Select the Source icon to configure the data source:
   1. Select Anaplan from the Connection type dropdown.
   2. Select Model from the Choose connection dropdown.
   3. Enter a new Label to change the name that displays in the pipeline source node.
   4. Choose a connection method: 
      • Saved connection: From the dropdown, select a previously created connection to an Anaplan model. 
      • Create a new connection: Select the link to create a new connection to a model. In the Create new connection dialog, select the Workspace and Model you want to connect to, enter a Name and Description (optional) for the connection, and then select Done.
   5. Select Source location > Choose Object, and choose a model source object.
      You can select a module, saved view, list, or hierarchy.
   6. Optionally, enable these settings based on the object you selected:
      • Modules: You can enable the Use code when available switch.
      • Saved views: You can enable these switches: Omit Summary and Use code when available.
      • Lists: You can enable the Use code when available switch.
      • Hierarchies: You can enable the Use code when available switch.
7. Select the Sink icon to configure the target destination:
   1. Select a Connection type from the dropdown.
      You can select an external system (for example S3) or Anaplan.
   2. Select a connection from the Choose Connection dropdown:
      • External system: If you selected an external system as the connection type, select an existing connection.
      • Model or Datasets: If you selected Anaplan as the connection type, select Model or Datasets.
   3. Enter a new Label to change the name that displays in the pipeline sink node.
   4. Complete the remaining fields that display in the Targets panel, based on the connection you selected:
      • External system: See the relevant writeback pipeline page for your external system for more information.
      • Anaplan model: If you choose this, then Anaplan models are both the source and sink in this pipeline. For information on configuring the sink, see Step 7 in the Anaplan models as a pipeline sink section.
      • Anaplan dataset: See Anaplan dataset connections in pipelines for more information.
8. Select Publish, and then select Run to execute the data transfer.

This section describes how to create a pipeline with an Anaplan model as the sink destination.

To create a pipeline with an Anaplan model as a sink:

1. Select Data Orchestrator from the top-left navigation menu.
2. Choose a dataspace from the list.
3. Select Pipelines from the left-side panel.
4. Select Create pipeline.
5. Enter a Name for your pipeline and then select Create.
   You are taken to the pipeline designer view.
6. Select the Source icon to configure the data source:
   1. Select a Connection type from the dropdown.
      You can select an external system (for example S3) or Anaplan.
   2. Select a connection from the Choose Connection dropdown:
      • External system: If you selected an external system as the connection type, select an existing connection.
      • Model or Datasets: If you selected Anaplan as the connection type, select Model or Datasets.
   3. Enter a new Label to change the name that displays in the pipeline source node.
   4. Complete the fields that display in the Source panel, based on the connection you selected:
      • External system: See the relevant read pipeline page for your external system for more information.
      • Anaplan model: If you choose this, then Anaplan models are both the source and sink in this pipeline. For information on configuring the source, see Step 6 in the Anaplan models as a pipeline source section.
      • Anaplan dataset: See Anaplan dataset connections in pipelines for more information.
7. Select the Sink icon to configure the target destination:
   1. Select Anaplan from the Connection type dropdown.
   2. Select Model from the Choose connection dropdown.
   3. Enter a new Label to change the name that displays in the pipeline sink node.
   4. Choose a connection method: 
      • Saved connection: From the dropdown, select a previously created connection to an Anaplan model. 
      • Create a new connection: Select the link to create a new connection to a model. In the Create new connection dialog, select the Workspace and Model you want to connect to, enter a Name and Description (optional) for the connection, and then select Done.
   5. Select Source location > Choose Object, and choose a model target object.
      You can select a module, saved view, list, or hierarchy.
   6. Select Target mapping > Mapping, and map the source values to the target values.
   7. If you selected a hierarchy, you can select the Balance hierarchy checkbox.
      For more information, see the Balanced vs. unbalanced hierarchies page.
   8. Select a Match option for the target object you selected.
      See the Match options section below.
   9. Select an Update type: 
      • Upsert: Updates existing rows and adds new rows if needed.
      • Replace: Replaces all existing data with the new data being extracted, and overwrites any previous data.
8. Select Publish, and then select Run to execute the data transfer.

When the pipeline data is pushed to the target model, the match option determines how to match the items in the target model object with the data in the pipeline.

Use this table to determine which match option to select for the model target object. If you selected a list, the match options differ depending on if you selected a standard list or numbered list.