Page History

...

Name

Definition

Required?

Value

workflowConfigMarker

workflowConfigDef

<none>

workflowConfigType

workflowConfigValueDef

required

if grouper is the only implementation in grouper.properties, auto populate with "grouper", otherwise list other implementations

workflowConfigApprovals

workflowConfigValueDef

required

This is a JSON config of the workflow approvals. must have "initiate" and "complete"

Code Block

{
  states: [
    {
      stateName: "initiate",
      
      // optional, if no group specified, then whoever has OPTIN
      allowedGroupId: "abc123def456"     
    },
    
    {
      stateName: "supervisor",
      approverSubjectId: "${initiatorSubject.attribute['supervisorSubjectId']}",
      approverSubjectSourceId: "mypeople"
    },
    
    {
      stateName: "dataOwner",
      //who can approve
      approverGroupId: "sdgf76gdf87",  
      //who is notified, if blank, then use approverGroupId
      approverNotifyGroupId: "dfkjh234kjb"
    },
    
    {
      stateName: "complete",
      //if blank use the selected groups from form or just the group
      //the workflow is assigned to
      actionAssignToGroupactions: [
           {
              actionName: "assignToGroup",
              actionArg0: "sgk234kh234" 
            }
        ]
    }
  ]
}

workflowConfigName

workflowConfigValueDef

required

Name of workflow. No two workflows in the same owner should have the same name

workflowConfigId

workflowConfigValueDef

required

Camel-case alphanumeric id of workflow. No two workflows in all of Grouper can have the same ID

workflowConfigDescription

workflowConfigValueDef

required

Textarea which describes the information in the workflow. Must be less than 4k

workflowConfigParams

workflowConfigValueDef

required

Note: max 10 params, checkbox is true/false

Code Block

{
  params: [
    { 
      paramName: "agreeToTerms",
      type: "checkbox",
      editableInStates: "initiate",
      required: "true"
    },
    {
      paramName: "notes",
      type: "textarea",
      editableInStates: "initiate"
    },
    {
      paramName: "notesForApprovers",
      type: "textarea",
      editableInStates: "supervisor, dataOwner"
    },
    {
      paramName: "reason",
      type: "textfield",
      editableInStates: "initiate"
    }
  ]
}

workflowConfigForm

workflowConfigValueDef

optional

Note: Grouper with javascript will enable or disable these form fields, or fill in values, as needed. The form field names need to match the names in the params. The id must match with "Id" appended to the end. If a name or id doesnt exist in the HTML there will be an error

Code Block

Fill out this form to be added to this group.<br /><br />
Several approvals will take place which usually take less than 2 business days<br /><br />
State the reason you would like this access: <input type="text" name="reason" id="reasonId" /><br /><br >
<input type="checkbox" name="agreeToTerms" id="agreeToTermsId" /> I agree this this institutions' <a href="https://whatever.whatever/whatever">terms and conditions</a><br /><br />
Notes: <textarea rows="4" cols="50" name="notes" id="notesId"></textarea><br /><br />
Notes for approvers: <textarea rows="4" cols="50" name="notesForApprovers" id="notesForApproversId"></textarea><br /><br />

workflowConfigViewersGroupId

workflowConfigValueDef

optional

GroupId of people who can view this workflow and instances of this workflow. Grouper admins can view any workflow (blank means admin only). Anyone in an approver group can view the workflow.

workflowConfigSendEmail

workflowConfigValueDef

required (default to true, no blank option available)

true/false if email should be sent

workflowConfigEnabled

workflowConfigValueDef

default to true (required, no blank option)

Could by "true", "false", or "noNewSubmissions", i.e. let current forms go through

workflowPriorityworkflowConfigPriority

workflowConfigValueDef

integer

no two workflows on the same group can have the same priority. If two workflows are available for the same subject, then pick the one with the highest priority, if the "join group" button is pressed

...

Name

Definition

Value

workflowInstanceMarker

workflowInstanceDef

<none>

workflowInstanceState

workflowInstanceValueDef

Any of the states, plus "exception" if there is a problem, workflows must have "initiate", and "complete", plus "rejected" if someone rejects it.

workflowInstanceLastUpdatedMillisSince1970

workflowInstanceValueDef

number of millis since 1970 when this instance was last updated

workflowInstanceConfigMarkerAssignmentId

workflowInstanceValueDef

Attribute assign ID of the marker attribute of the config (same owner as this attribute, but there could be many workflows configured on one owner)

workflowInstanceInitiatedMillisSince1970

workflowInstanceValueDef

millis since 1970 that this workflow was submitted

workflowInstanceUuid

workflowInstanceValueDef

uuid assigned to this workflow instance

workflowInstanceFilename

workflowInstanceValueDef

filename of workflow directory that holds the workflow files

workflowInstanceFilePointer

workflowInstanceValueDef

depending on storage type, this is a pointer to the workflow in storage, e.g. the S3 address. note the S3 address is .csv suffix, but change to __metadata.json for instance metadata

workflowInstanceEncryptionKey

workflowInstanceValueDef

randomly generated 16 char alphanumeric encryption key (never allow display or edit of this)

workflowLastEmailedDateworkflowInstanceLastEmailedDate

workflowInstanceValueDef

yyyy/mm/dd date that this was last emailed so multiple emails dont go out on same day

workflowLastEmailedStateworkflowInstanceLastEmailedState

workflowInstanceValueDef

the state of the workflow instance when it was last emailed

workflowLogworkflowInstanceLog

workflowInstanceValueDef

has brief info about who did what when on this instance

workflowErrorworkflowInstanceError

workflowInstanceValueDef

error message including stack of why this instance is in "exception" state

workflowInstanceParamValue0

workflowInstanceValueDef

Code Block
{paramName: "agreeToTerms", paramValue: "true", lastUpdatedMillis: 12324345432434234, editedByMemberId: abc123}

workflowInstanceParamValue1

workflowInstanceValueDef

Code Block
{paramName: "notes", paramValue: "Im traveling abroad and need access to such and such", lastUpdatedMillis: 12324345432434234, editedByMemberId: abc123}

workflowInstanceParamValue2

workflowInstanceValueDef

Code Block
{paramName: "notesForApprovers", paramValue: "He will be collaborating with such and such which is why he needs access", lastUpdatedMillis: 12324345432434234, editedByMemberId: abc123}

workflowInstanceParamValue3

workflowInstanceValueDef

Code Block
{paramName: "reason", paramValue: "Need access to whatever system", lastUpdatedMillis: 12324345432434234, editedByMemberId: abc123}

workflowInstanceParamValue4

workflowInstanceValueDef

workflowInstanceParamValue5

workflowInstanceValueDef

workflowInstanceParamValue6

workflowInstanceValueDef

workflowInstanceParamValue7

workflowInstanceValueDef

workflowInstanceParamValue8

workflowInstanceValueDef

workflowInstanceParamValue9

workflowInstanceValueDef

Changes to group drop down

...

Page tree

Versions Compared

Old Version 6

New Version 7

Key

Changes to group drop down