| Info |
|---|
...
| title | Summary |
|---|
Activity Container attributes allow a single |
...
Attribute on a Workflow to contain |
...
multiple “child” Activity Instances. The data for those child Activities is collected through a standard Complete Activity Workflow. |
| Table of Contents |
|---|
Overview
Container Attributes let you collect multiple “things” as part of a Workflow,
...
Use Cases
A typical Workflow Popup contains a fixed number of fields. This works fine when the number of required data elements is known in advance. For example, if you know you need to collect three pieces of text, you can add three Short Text attributes to the Workflow.
However, in some use cases the number of necessary fields is not known in advance. In these cases, the Activity Container attribute allows you to collect an arbitrary amount of data, all tracked under a single Workflow Attribute.
For example, consider the "Complaints and Investigations" use case in which an Activity Instance represents a complaint against a licensed practitioner. During the course of the investigation, an investigator might need to conduct any number of interviews with witnesses or other key parties. The Activity Container attribute allows those interviews to be attached to the complaint.
Additionally, each of those interviews is recorded as a full-fledged Activity Instance, so the full Workflow Engine can be used for each interview. This allows for the use of multiple Attributes, validation rules, and multi-step data input flows during the data entry process.
Configuration
This attribute collects:
- The Activity ID to use when creating child Activity Instances
- The Workflow Status to assign to child Activity Instances when being copied to a new Learning Plan Instance
- Whether to show details of the activity in an expandable list and the Trigger Text used to show / hide the list.
- An Empty List Message
- The singular and plural display labels for the activity.
Step-specific Configuration
Additional configuration settings are managed at the Step level, including:
- Maximum number of child elements
- UI element text - instruction text, button labels, etc
- Whether or not users are allowed to upload child data using CSV
- If upload is allowed, what Workflow Step / Action should be used to control the fields/validation/etc.
- A link to a customized upload template (optional; if omitted, a simple CSV template is dynamically created)
Display Modes
...
where each “thing” has multiple data fields.
Consider, for instance, this aspect of the Office Dog training scenario:
Applicants are required to upload veterinary records to prove they are good, healthy doggos.
As a part of these records, the applicant must identify their full vaccination history including the date and vaccine for each shot.
Applicants must provide at least one set of records, but can provide multiple if they have them.
In this case we have:
A need to support an arbitrary number of “things” (shot records), and
Each “thing” has multiple data fields associated with it (date + vaccine provided)
It is difficult to configure the Workflow Engine to support an arbitrary number of items and collect multiple data fields for each item. It generally results in a bunch of fields like Shot1_Date1, Shot1_Vaccine, Shot2_Date, Shot2_Vaccine, etc.
...
Activity Container attributes are designed for this exact scenario. In this scenario, the “Vet Records” Activity Instance can contain a single Container attribute, which can hold multiple “child” Activity Instances, one for each Shot History entry.
...
Usage and Appearance
Configuration
| Note |
|---|
This data type contains both “Definition-level” and “Step-level” settings, and they must both be configured before the container will properly function. |
Attribute Definition-level settings
These settings define the Container itself, such as what type of Activity it can contain and how to refer to the data.
...
Setting | Purpose / Notes |
|---|---|
Child Activity Id | Enter the |
When copied, create new children with Workflow Status | If the Workflow that owns the Container attribute itself is copied, the new Workflow will contain copies of the child Activities as well. This setting controls the status to put them in. Choose Incomplete if you want to force the owner to re-visit each child Activity, perhaps because you want them to update it with new data. Choose Preserve the status of the source record if you want the status of the duplicated child Activity Instance to match the original. (e.g. if the source child Activity Instance was Completed, then the copy will be Completed too) |
Show Details of Contained Activities on Workflow Popup | If checked, information about each child Activity Instance will be shown in an expanding/collapsing list on the Workflow Popup. |
Singular/Plural Name | Provides a label for the system to refer to the child Activity Instances. |
Step-level settings
These settings control how the Container behaves on a specific Workflow step, which allows the visible data to vary based on the state of the containing Activity.
...
Setting | Purpose / Notes | ||
|---|---|---|---|
Max Children | The maximum number of child Activities that can be added to this Activity.
| ||
Edit Instructions | Text displayed on the full-page screen for entering the child Activities. (See below) | ||
“Add Child” Label | Label for the button that adds a new child Activity to the container. | ||
“Return to Workflow” Label | Label for the link that returns to the Workflow Popup. | ||
Grid Columns | A comma-separated list of the Attribute Names, from the child Activity’s Complete Activity Workflow, that should be displayed in the grid of child Activities. | ||
Identify Duplicates using | A comma-separated list of the Attribute Names, from the child Activity’s Complete Activity Workflow, that define a “duplicate”. The combination of these values must be unique amongst all of the child Activity Instances. For instance, in the Shot History use case described above, we would not want more than one Activity Instance to have the same date and vaccine, because that would constitute a duplicate entry. | ||
Allow Upload? | The Activity Container allows the child Activity data to be uploaded as an Excel spreadsheet, rather than entered one-by-one through the UI. This toggle enables or disables that ability for this specific container. | ||
Upload Step | The Workflow Step, of the child Activity’s Complete Activity Workflow, that the uploaded data is mapped against.
| ||
Upload Action | The Action, from the child Activity’s Complete Activity Workflow, to execute for each row of the uploaded data. | ||
Upload Instructions | Displayed to the user on the upload interface. | ||
Template File URL | If you want to improve the user experience, you can hand-craft an Excel document that acts as a template, specifying the column headers that should be included. These files must be hosted somewhere externally to LearningBuilder, and the URL to the file can be entered here. If you leave this blank, a template will be automatically generated based on the Upload Step. | ||
Save Action | The Action to perform on the Workflow Popup when the user clicks to engage the Container interface. If you leave this blank an “ad-hoc” Save will be performed that saves any changes the user made to the popup. If you wish to perform specific Behaviors, or conduct specific validations, when the user engages the Container interface, then you can choose a configured Save Action here. |
Input mode
The Container attribute is managed using a full-page UI.
In input mode, the
...
Workflow displays the count of items in the container, an optional summary list of key details, and a button.
Clicking the button navigates to a full-page UI that shows the current list of child Activity Instances and buttons for adding
...
and modifying data.
...
Display mode
In display mode, the
...
Workflow displays the same details as input mode, but without the button that opens the full-page UI
...
Data Storage
This attribute stores an empty Value in the IAV table. The ITEM_ATTRIBUTE_VALUE_ID is a pointer to the ACTIVITY_CONTAINER_ATTRIBUTE_ACTIVITY_INSTANCE, which links the IAV table to the ACTIVITY_INSTANCE table, where the child Activity Instances are stored.
| Panel | ||
|---|---|---|
| ||
|
...
| title | Business Rules |
|---|
...
.
Related articles
| Filter by label (Content by label) | ||
|---|---|---|
|
| Page Properties | ||
|---|---|---|
| ||
|