Versions Compared

Old Version 1

changes.mady.by.user Seth Petry-Johnson

Saved on

compared with

New Version Current

changes.mady.by.user Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleOne use case of a Lookup attribute is to model the Instructors assigned to specific Courses. In this model, an Activity Definition

Summary

Activity Lookup attributes allow a Workflow to contain a reference to an Activity Definition.

A common use case for this data type is to assign Instructors to Courses (in scenarios where they cannot be more simply modeled as a Custom List).

Overview

During configuration, a specific Activity Type is selected.

In input mode on a Workflow, the lookup allows the user to choose from a list of published Activities matching that type. (Optionally, the list can be filtered by a custom SQL procedure as well)

Use Case: "Course Instructors"

Note: This page is about the Lookup data type. There is also an /wiki/spaces/DOCS/pages/529793025 that serves a similar purpose. 

Overview

There are various scenarios in which a Workflow needs to display a list of Activities for the user to choose from.

One use case is Course Instructors, if Instructors are represented as Activities rather than Members. In this case, the Provider can choose the appropriate “Instructor” when completing the Create Activity Workflow.

Usage and Appearance

Configuration

This attribute collects:

  • The Activity Type to restrict the options to

  • An optional SQL procedure to provide additional filtering against custom rules

Image Added

Input mode

In input mode, displays a multi-select list containing the available Activities.

Read-only mode

In display mode, displays a list of the selected Activity Titles plus a link to launch the Workflow Overview for each.

Data Storage

This attribute stores a comma delimited list of Activity Ids and uses an /wiki/spaces/DOCS/pages/538411176 to fetch information about the referenced Activity(s).


Panel
titleSample Use Cases

  • Course Instructors: An Activity would be created for each Instructor, and a Lookup attribute

would be

  • is used to link

each

  • the Course activity to

an

  • the Instructor activity.

  • If

custom

  • there are business rules

restrict

  • that control which

Courses a given Instructors is allowed to teach, those rules can be implemented by filtering the Lookup attribute with

  • Instructors can teach which Courses, the lookup can be filtered by a custom SQL procedure that implements those rules.

 

Panel
title

Container Task vs Container Attribute

This page is about the Lookup data type. There is also an /wiki/spaces/DOCS/pages/529793025 that serves a similar purpose. 

Panel
titleSpecial Features
As of version 9.4.0, the Lookup attribute can optionally be filtered by a custom SQL procedure that accepts the Lookup Attribute Id, the Current User Id, and the Workflow Instance Id that holds the lookup attribute. This allows for the modeling of complex business rules that would otherwise be difficult to implement

Business Rules
Note

Only Activity Definitions with a Create Activity Workflow in a Completed Successfully state are selectable.

Note

This Attribute is only useful for Organization type members.

Info

The list of selectable Activities is filtered by Provider.

  • If the Workflow containing the lookup attribute is modifying an Activity, then only lookup Activities with the same Provider are returned.

  • If the Workflow is modifying a different type of entity, then only lookup Activities with a Provider ID matching the workflow owner are returned.

In the same use case of "Course Instructors", for example, this allows each Provider to maintain their own Instructor list.

Filter by label (Content by label)
cqllabel in ( "activity-type-lookups" , "activity-lookup-attr" )
Page Properties
hiddentrue


Related issues