A User Login Workflow Event is triggered every time somebody logs in. This provides you the opportunity to run anything you want at that time, and you can also modify the user's environment. You can:

•Modify the menu a user will get so you can ensure users with particular roles/groups will always get the correct menu.

•Run Veto Workflow Action to prevent the user from logging in.

•Choose the Layouts of particular Biskits the user may see. Call addUserLayout function passing in a layout they are to use.

•Modify the Workflow Created Buttons the user will see.

•There's a list of buttons workflowButtons on the event.

•You can add to the list, remove from the list, or modify the buttons in the list.

•Modifying buttons makes sense if you want to disable them for some users. If you do this, then you should make sure the Biskit Update action when you modify the button is marked as temporary so that the change is not persisted to the database where it could affect other users.

Event Properties

There are no properties you can set on the event beyond the standard properties that can be set on all events.

Properties Available for Child Actions To Use

The following properties are available for use in any child or descendant action:

 

Property

Type

Notes

layouts

List of biskits of type User Layout

The layouts the user can use, use addUserLayout to add to this list.

settings

Biskit of type ExprodoUserSettings

The User Settings allowing customisation of the settings at login time.

user

Biskit of type ExprodoUser

The User Biskit allowing user information to be extracted.

workflowButtons

List of biskits whose type is defined below

The list of buttons created by workflows the user can see

 

The biskits in the workflowButtons property look like this:

Property

Type

Notes

buttons

List of biskits of type User Workflow Biskit Type Button

A list of workflow buttons to be given to the user for display at the appropriate place.

 

Workflow buttons are each configured to display whenever you're viewing a biskit of a particular type, or a list of biskits of a particular type.

 

By using a User Login Workflow Event you can customise which workflow buttons a user has available.

 

When the event runs, it will start with the buttons property set to the standard buttons. You can modify this list to add new buttons, remove existing ones, or modify existing ones just for this user's view (eg removing a button for some users or adding a button for some users).