Manage Signals in your organization and view which Processes and Collections subscribe to each Signal.
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new Signal to which any Process may subscribe for use.
Your user account or group membership must have the following permissions to create a Signal unless your user account has the Make this user a Super Admin setting selected:
Signals: View Signals
Signals: Create Signals
See the Signals permissions or ask your Administrator for assistance.
Follow these steps to create a new Signal:
View your Signals. The Signals page displays.
Click the +Signal button. The New Signal screen displays.
In the Signal Name setting, enter a name for the Signal. The Signal name setting displays to the Process designers when configuring Signal-type events in Process Modeler. Therefore, provide a concise name for the Signal so Process designers understand its function. This is a required setting.
In the Signal ID setting, enter a unique ID for the Signal. ProcessMaker Platform uses the Signal ID to internally identify this Signal. Signals associated with Collection record events derive their Signal ID values with a prefix containing that Collection's name. Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
A Signal that corresponds with a User Signal must have the Signal ID value that corresponds with that User Signal's event. See What is a User Signal?. Ensure that the User Signal is enabled for use.
This is a required setting.
Optionally, in the Additional Details setting, enter a description for the Signal.
Click Save. The Signals page displays the new Signal in the list of all Signals.
Delete a Signal from being used by any subscribing Process or Collection in your organization.
When a Signal is deleted, it can no longer be referenced from other Process model elements throughout your ProcessMaker Platform instance. If a Process model element is already subscribing to a Signal, that Signal can not be deleted.
Your user account or group membership must have the following permissions to delete a Signal unless your user account has the Make this user a Super Admin setting selected:
Signals: Delete Signals
Signals: View Signals
See the Signals permissions or ask your Administrator for assistance.
Deleting a Signal from the Signals page cannot be undone.
Follow these steps to delete a Signal:
View your Signals. The Signals page displays.
Click Confirm. The following message displays: The Signal was deleted.
Click the Delete iconfor the Signal to delete. The Caution screen displays to confirm the deletion of the Signal.
View the Signals designed for Processes as well as those automatically created for Collections. View which assets subscribe to each Signal via its catch events.
ProcessMaker Platform displays all Signals in one location. This makes it easy to manage these Signals.
Your user account or group membership must have the "Signals: View Signals" permission to view the list of Signals unless your user account has the Make this user a Super Admin setting selected.
See the Signals permissions or ask your Administrator for assistance.
Follow these steps to view all Signals in your organization:
Ensure that you are logged on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
The Signals page displays the following information in tabular format about Signals:
ID: The ID column displays the Signal ID used to internally identify this Signal. ProcessMaker Platform uses the Signal ID to internally identify this Signal. Signals associated with Collection record events derive their Signal ID values with a prefix containing that Collection's name.
Name: The Name column displays the Signal name as it appears to a Process designers when designing Processes.
Click the +Signal button. See Create a New Signal.
Use the Search setting to filter Signals that display.
Click the Signals iconfrom the left sidebar. The Signals page displays all Signals.
Click the Edit icon. See Edit a Signal.
Click the Delete icon. See Delete a Signal.
Edit general information about a Signal.
Your user account or group membership must have the following permissions to edit details of a Signal unless your user account has the Make this user a Super Admin setting selected:
Signals: Edit Signals
Signals: View Signals
See the Signals permissions or ask your Administrator for assistance.
Follow these steps to edit details of a Signal:
View your Signals. The Signals page displays.
In the Signal Name setting, edit the name for the Signal. The Signal name setting displays to the Process designers when configuring Signal-type events in Process Modeler. Therefore, provide a concise name for the Signal so Process designers understand its function. This is a required setting.
In the Signal ID setting, edit the unique ID for the Signal. ProcessMaker Platform uses the Signal ID to internally identify this Signal. Signals associated with Collection record events derive their Signal ID values with a prefix containing that Collection's name. Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
A Signal that corresponds with a User Signal must have the Signal ID value that corresponds with that User Signal's event. See What is a User Signal?. Ensure that the User Signal is enabled for use.
This is a required setting.
Optionally, in the Additional Details setting, edit the description for the Signal.
Optionally, configure this Signal with webhook access if the Data Connector package is installed. See Enable Webhook Access.
Click Confirm and Save to save Signal details.
A Signal can optionally be enabled with webhook access.
A webhook automates the receiving of data from another application or third-party service when an event occurs. The data is sent or received via a unique URL that ProcessMaker Platform and that application or service can parse. Through the use of webhooks, users and other services can subscribe to events happening in your system by registering a URL to be called whenever the event occurs.
To send data to a Signal's webhook, ensure that the sender's header contains JSON content type:
content-type = application/json
To configure a webhook for a Signal, the Data Connector package must be installed.
Your user account or group membership must have the following permissions to configure a webhook for a Signal unless your user account has the Make this user a Super Admin setting selected:
Webhook: Disable Webhooks
Webhook: Enable Webhooks
Webhook: Read Webhooks
Webhook: Update Webhooks
See the Webhooks permissions or ask your Administrator for assistance.
Follow these steps to configure webhook access for a Signal:
View your Signals. The Signals page displays.
Use the Copy to Clipboard option to copy the webhook URL for use in other ProcessMaker Platform assets or third-party applications.
In the Authentication section, enter security details for accessing the webhook linked to this Signal. Follow these guidelines:
Restrict form fields
Use the Accepted Form Fields setting to optionally restrict form fields that can be used in a call to this Signal. If there are no form fields specified, the entire data from a third-party call will be sent to the Signal. Follow these guidelines:
In the Field setting, enter the name of the form field to allow in a call to this Signal.
Optionally, select the Required checkbox to make this a mandatory field. If the call to the Signal does not contain this field, the call will fail.
Repeat steps 1 to 3 to add additional form fields.
Select the connecting method
From the Accepted Method setting, select the method to use when connecting to this Signal. Select one of the following options:
GET/ Query String: The GET / Query String method retrieves data from the Signal using parameters passed in the URL of a call to the Signal.
POST: The POST method sends JSON data in the body of a call to the Signal.
Select authentication
Follow these steps to configure basic authentication settings when selecting the Basic Authentication option from the Authentication section:
In the Username setting, enter or edit the user name that authenticates an incoming call to the webhook linked to this Signal.
In the Password setting, enter or edit the password that authenticates an incoming call to the webhook linked to this Signal.
Restrict URLs from accessing the webhook
In the Restrict Access From setting, optionally provide a list of URLs from which to restrict any attempts to access the webhook linked to this Signal. Follow these guidelines:
Enter the URL from which to restrict access to this Signal's webhook.
Click Save to save the changes.
Repeat steps 1 to 3 to restrict additional URLs.
Click Save to save webhook settings.
View the Signal Start Event elements, Intermediate Signal Catch Event elements, and/or Boundary Signal Event elements that currently subscribe to a Signal, also called a catch event.
Follow these steps to view the elements that currently subscribe to a Signal:
View your Signals. The Signals page displays.
Filter all Signals in your organization to find that one you need.
Your user account or group membership must have the "Signals: View Signals" permission to search for Signals unless your user account has the Make this user a Super Admin setting selected.
Follow these steps to search for a Signal:
Enter in the Search setting the text to filter Signals using any of the following criteria:
ID: Filter by the Signal ID that displays in the ID column.
Name: Filter by the Signal name that displays in the Name column.
As you enter text into the Search setting, Signals display that match your entered text.
Click the Edit iconnext to the Signal to edit. The Details tab displays.
Click the Edit iconnext to the Signal to enable its webhook. The Details tab displays.
Enable the Enable Webhook Access toggle key to activate a webhook for this Signal if that toggle key is not enabled. A webhook URL is automatically generated for the Signal.
Click the +Field button. The Add Field Security screen appears.
From the Authentication drop-down menu, select either None or Basic Authentication as the authentication method.
Click the +URL button. The Add URL Restriction screen displays:
Click the Edit iconnext to the Signal to view its catch events. The Details tab displays.
Click on the Catch Events tab. The Catch Events tab displays showing the assets that are currently subscribing to this Signal. This is a view-only list for informational purposes.
Use the Search function to filter all from the Signals page based on your entered text.
See the permissions or ask your Administrator for assistance.
. The Signals tab displays.