Learning Plan Instance Import

This page details how Learnng Plan Instance data are imported via the https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/1460502917.

1 Overview
2 Supported operations
3 File format: Identifying the Learning Plan Instance to modify
4 File format: Identifying the Data Import Step and/or Workflow Action
- 4.1 Explicitly specifying the Data Import Step and/or Workflow Action
- 4.2 Letting the system “figure it out”

Overview

The Learning Plan Instance import feature allows Applications to be modified via batch file upload.

This supports numerous use cases:

Synchronizing LearningBuilder with 3rd party system of record;
Bulk editing / data manipulation
Bulk process-based operations (via the execution of Workflow Actions on )

Supported operations

The Learning Plan Instance import process can perform the following operations:

Update an existing Learning Plan Instance

File format: Identifying the Learning Plan Instance to modify

Each row in the uploaded file must identify an existing Learning Plan Instance to update.

If multiple matches are found then the row is rejected. Additional information is needed to uniquely identify the one to update.
If a single match is found then it is updated via a Data Import Step on its Complete Learning Plan Workflow.
If zero matching records are found, the row is rejected with an error.

Fields	Updates when…	Inserts when…	Fails when…

Fields	Updates when…	Inserts when…	Fails when…
`:LearningPlanInstanceId`	A single `Learning Plan Instance` exists with this internal ID.	Never	Zero `Learning Plan Instances` exist with this ID
(`:UniqueId` or `:MemberRoleId`) + (`:LearningPlanName` or `:LearningPlanId)`	A single `Learning Plan Instance` matches the specified `Member Role`, `Learning Plan`, and `Learning Plan Instance` parameters. If the Data Import Step cannot be performed against `Workflow Instances` in a terminal state, then only Incomplete `Learning Plan Instances` are considered as candidates.	Never	More than one candidate `Learning Plan Instance` is identified.
(`:UniqueId` or `:MemberRoleId`) + (`:LearningPlanName` or `:LearningPlanId`) + (`:CycleEndDate` or `:CycleEndYear`)		Never
(`:Email` or `:MemberId`) + (`:LearningPlanName` or `:LearningPlanId)`	A single `Learning Plan Instance` matches the specified `Member`, `Learning Plan`, and `Learning Plan Instance` parameters. If the Data Import Step cannot be performed against `Workflow Instances` in a terminal state, then only Incomplete `Learning Plan Instances` are considered as candidates.	Never	More than one candidate `Learning Plan Instance` is identified.
(`:Email` or `:MemberId`) + (`:LearningPlanName` or `:LearningPlanId)` + (`:CycleEndDate` or `:CycleEndYear`)		Never

File format: Identifying the Data Import Step and/or Workflow Action

The Workflow Import Queue uses the Workflow Engine to manipulate data, so every row of an uploaded file must be associated with a specific Workflow Action on a specific Data Import Step. These elements can be specified in the file itself, or they can be omitted and the system will use the configuration to determine what to do.

Explicitly specifying the Data Import Step and/or Workflow Action

TODO

Letting the system “figure it out”

TODO