CreateUserActionHandler

CreateUserActionHandler

Description

This ActionHandler creates a new user or modifies existing ones. The creation can be done with default password or with an activation link where the new user can set a new password.


Class

com.dooris.bpm.actionhandler.CreateUserActionHandler

 

Parameter

Parameter

Default value

Description

Valid examples

Parameter

Default value

Description

Valid examples

email MANDATORY

N/A

Email address of the newly created user

john.doe@yourcompany.com

${emailVariableName}

userNotification

noInfo

Decision how the user should be created:

  1. noInfo 
    → user is created with default password

  2. activationLink 
    → user is created an email with the link where he can activate his user and set a password is sent

  3. accessLink 
    → user is created and an email with the link to SAML login is sent

noInfo

activationLink

accessLink

${userNotificationVariableName}

 

name

 

Name of the newly created user (if not set then name = email)

john.doe

${nameVariableName}

roles

member

Which roles will be assigned to user (administrator roles cannot be assigned)

member,starter

${rolesVariableName}

groups

 

To which groups should the user be added

dummyGroup1,dummyGroup2

${groupsVariableName}

faultTolerance

0

How the ActionHandler handles exceptions (e.g. when email is already in use):

0 → the exception is shown to user and current action is rolled back

1 → the exception is written in the responseVariable, user is also not created but process moves on

0

1

ignoreLdapAuth

false

User property ignoreLdapAuth can be set to true or false while creating

true

false

${ignoreLdapVariableName}

nameFirst

 

User's first name

John

${nameFirstVariableName}

nameLast

 

User's last name

Doe

${nameLastVariableName}

phoneNumber

 

User's phone number

0123456789

${phoneNumberVariableName}

country

 

User's country

Germany

${countryVariableName}

companyId

 

User's company ID

012345

${companyIdVariableName}

companyName

 

User's company name

yourcompany

${companyNameVariableName}

personnelNumber

 

User's personnel number

456789

${personnelNumberVariableName}

supervisor

 

User's supervisor (name or ID)

Dan

0123456

${supervisorVariableName}

department

 

User's department

Testing

${departmentVariableName}

costCenter

 

User's cost center

Euro

${costCenterVariableName}

departmentChief

 

User's department chief (name or ID)

Dan

0123456

${departmentChiefVariableName}

defaultRepresentative

 

User default representative (name or ID)

Dan

0123456

${defaultRepresentativeVariableName}

responseVariable

 

This is the variable where the response is written out

responseVariableName

userStatus

 

Specifies the type of user created.

Standard or Temporary Task User

STANDARD
TEMPORARY

modifyExistingUserAttributes

false

If true, user attributes like first name, last name will be updated if the user already exists.

false

true

modifyExistingUserStatus

false

If true, the status (STANDARD or TEMPORARY) will be updated for existing users.

false

true

modifyExistingUserActivation

true

If true, an existing DEACTIVATED user will be activated.

false

true

The last three parameters were added in v26.0.6 and are not available in prior versions.