Configure User Signals settings in your organization.
User Signals allow Process designers to react to changes to user accounts. When a change occurs to a user account, a BPMN 2.0 Signal event triggers; any Process that subscribes to that Signal can react. The Signal includes a payload containing that user’s data as a data array.
Below is a description of each user-type event and the Signal ID value to use for its corresponding Signal.
When a User Signal event triggers, the following occurs:
That User Signal broadcasts the _user
Magic Variable containing the user account affected by that User Signal event. For example, the full name set in the affected user account is accessible with JSON dot notation as _user.fullname
. See the _user
Magic Variable to reference any JSON object within this Magic Variable.
The User Signal event broadcasts any User Enhanced Properties and the affected user account's corresponding values.
Learn about Collection Signals.
Follow these steps to view User Signals settings:
Ensure that you are logged on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
From the Settings panel on the left, expand the User Settings section.
Select User Signals to view the following details:
Setting: The Setting column displays the User Signals setting name.
Configuration: The Configuration column displays the setting value and how it is configured.
All User Signals are disabled by default and can be enabled using a toggle key in the Configuration column. If a User Signal's toggle key is disabled, that User Signal does not broadcast to listening Signal-type events when that user-type event occurs.
Follow these steps to enable or disable a User Signal:
​View your User Signals. The User Signals tab displays:
Click the toggle key in the Configuration column of each User Signal to enable or disable it.
A message The setting was updated
appears to confirm that the setting has been saved.
Configure properties that are available to all users.
As an Administrator, extend the users' attributes in Users section. The user profile setting contains most relevant information for users. However, the client can add more profile settings fields according his/her necessities.
User Extended Properties provide additional profile settings available to all user accounts. User Extended Properties setting allows Administrators to store additional information in user accounts. User Extended Properties display in the Additional Information section when editing a user account.
User Extended Properties are comprised of two parts: the JSON data variable name and the label. This JSON data variable becomes available as part of the user data object. The label displays in the Additional Information section.
To configure User Extended Properties, visit the Admin Settings page, and then select the Users section and click on the Edit icon to open the Extended Properties management modal.
For example, add User Extended Properties to attribute information for Human Resources, such as the hiring date, onboarding date, offboarding date, and office location for each user in the organization.
Configure User Extended Properties from the Users section in Settings. See View User Extended Properties.
Follow these steps to view the User Extended Properties:
Ensure that you are logged on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
From the Settings panel on the left, expand the User Settings section.
Select Users to view the following details:
Setting: The Setting column displays the Users setting name.
Configuration: The Configuration column displays the setting value and how it is configured.
Select the time zone for new users.
Follow these steps to select time zone:
View your User Extended Properties. The Users settings display.
From the Timezones setting, select a timezone for new users..
Follow these steps to add or edit a User Extended Property:
View your User Extended Properties. The Users settings display.
Click on the +Add button. A row displays below the existing User Extended Properties. Otherwise, edit a created Extended Property row.
In the Variable Name setting, enter the Variable Name to store the User Extended Property value. Reference the Variable Name to get the value for this User Extended Property. As a best practice, use PascalCase or camelCase style for the Variable Name setting value. This is a required setting.
In the Label setting, enter the text label that displays in the Additional Information section of each user account for Administrators to enter the value of that User Extended Property. Consider the following example that stores the hiring date as a User Extended Property:
Variable Name: gender
Label: Preferred Gender Identifications
This is a required setting.
Click Save. The User Extended Properties display in the Configuration column.
Copy to clipboard all added User Extended Properties as a JSON array. Paste the JSON array into any asset that either requires the User Extended Properties or for testing purposes.
Follow these steps to copy all added User Extended Properties:
View your User Extended Properties. The Users settings display.
Deleting a User Extended Property cannot be undone. No screen displays when deleting a User Extended Property to confirm its deletion. After saving changes, the deleted User Extended Property is no longer available to any user account: values configured in each user account for the deleted User Extended Property are removed.
Follow these steps to delete a User Extended Property:
View your User Extended Properties. The Users settings display.
Click Save. The remaining User Extended Properties display in the Configuration column.
Click the Settings icon from the left sidebar to view all settings.
Click the Search icon or press enter to view User Signal settings that match your entered text.
Click the Settings icon from the left sidebar to view all settings.
Click on the Edit icon for the Timezone setting. The Timezones setting displays UTC by default.
Click on the Edit icon for the Extended Properties setting. The Extended Properties screen displays your currently added User Extended Properties. If there are no User Extended Properties, only the Variable Name and Label columns display.
Click the Copy to Clipboard icon for the Extended Properties setting to copy all extended properties as a JSON array. Paste the JSON array into any asset that either requires the User Extended Properties or for testing purposes. The following message displays: The setting was copied to your clipboard.
Click on the Edit icon. The Extended Properties screen displays your currently added User Extended Properties.
Click on the Delete icon for the User Extended Property to delete.
User-Type Event
Description of Event
Signal ID
Create
user_create
Delete
user_update
Read
A user account is accessed in either of the following ways:
user_read
Update
user_delete