SMS Service and Approval AgileConnector

The SMS AgileConnector enables you to send messages from an app via SMS. Optionally, you can use a third-party SMS listening service in order to receive SMS messages for responses such as approvals.

Background and Setup

Prerequisites

Good to Know

  • The Configuring the SMS Service and Approval AgileConnector supports two types of actions using SMS:
    • Sending notifications based on events - SMS notifications are set up in the AgileWorks within a process model. Sending SMS notifications does not require a listener service account.
    • Listening for incoming responses for process input - This is typically used for simple responses such as approve/reject. This requires a listener service account.
  • If the SMS Service and Approval AgileConnector is configured, but the SMS Approval is deselected, and an app designer configures an app to use SMS approval, the app will send an SMS message requesting a message. However, when an approver submits their approval via SMS, nothing will happen. The approval will not complete in the app, the approver will not see an error message, and no error messages will be written in the log files. In this case, the approval function is turned off, so approval messages are not monitored, even though an app can send a message requesting approval.

How to Start

  1. On the AgilePoint Server machine, in Windows Explorer, right-click the file (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\WCFConfigurationUtility.exe, and click Run as Administrator.

    Configuration Utility Run As Administrator Screen
  2. On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.

    Select AgilePoint Server Intance
  3. Click Open Server Configuration Open Server Configuration icon.

    Click Open Server Configuration
  4. On the AgilePoint Server Configuration screen, click the Integrations tab.

    Click Integrations Tab

Enabling the SMS Service and Approval AgileConnector

To enable the SMS Service and Approval AgileConnector, ​do the procedure in this topic.

How to Start

  1. On the AgilePoint Server Configuration screen, in the Integrations tab, click Add.

    Click Add

Procedure

  1. In the Impersonator field, enter the AgilePoint user name that is used to connect to your e-mail server.

    By default, this is the AgilePoint Service Account.

  2. Browse to the assembly (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\AgilePoint.AgileConnector.SMSService.dll.
  3. Click OK.

Configure SMS Service AgileConnector screen

Specifies the configuration details of the SMS Service AgileConnector.

Figure: Configure SMS Service AgileConnector Twilio screen
Configure SMS Service AgileConnector Twlio screen
Figure: Configure SMS Service AgileConnector StrikeIron screen
Configure SMS Service AgileConnector StrikeIron screen

Prerequisites

How to Start

  1. On the AgilePoint Server Configuration screen, in the Integrations tab, select SMSService.
  2. Click Configure.

Fields

Field NameDefinition

Application Filter
Function:
Filters the processes based on their application names.

The messaging service is enabled on the process templates identified in this field.

Accepted Values:
One or more valid application names.

Multiple application names must be separated with a semicolon (;).

Default Value:
None

SMS Service Type
Function:
Specifies the name of the SMS service provider used by AgilePoint NX.
Accepted Values:
  • Twilio
  • StrikIron

If you want to use a different SMS listener vendor, contact AgilePoint Professional Services to request a custom AgileConnector

Default Value:
Twilio

Account SID
Function:
Specifies 34 character ID from Twilio that identifies your Twilio account.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select Twilio.
Accepted Values:
A 34 character ID from Twilio.
Default Value:
None

AuthToken
Function:
Specifies the authorization token for your Twilio account.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select Twilio.
Accepted Values:
An authorization token from Twilio.
Default Value:
None

Twilio Number
Function:
Specifies the Twilio phone number that sends an SMS message.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select Twilio.
Accepted Values:
A Twilio phone number with plus sign (+) and your country code.
Default Value:
None
Example:
+16175551212

User ID (e-mail ID)
Function:
Specifies the user ID or e-mail ID for the StrikeIron service account.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select StrikeIron.
Accepted Values:
A StrikeIron user ID or e-mail ID.
Default Value:
None
Accepts Process Data Variables:
No

Password
Function:
Specifies the password for your StrikeIron account.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select StrikeIron.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None

From Name in SMS Text
Function:
Specifies the name displayed in an SMS text message.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select StrikeIron.
Accepted Values:
One line of text (a string).
Default Value:
None

Send SMS Notification to Users about Task Assignment
Function:
Specifies that the SMS Service AgileConnector sends an SMS notification to the participants about the task assignments.
Accepted Values:
  • Selected - Sends an SMS notification to the participants.
  • Deselected - No SMS notification is sent.
Default Value:
Deselected

Enable SMS Approval
Function:
Specifies whether the SMS Service AgileConnector lets runtime app users complete approvals with SMS messages.
Accepted Values:
  • Selected - Runtime app users can approve tasks with SMS messages.
  • Deselected - Approvals can not be completed with SMS messages.

If the SMS Service and Approval AgileConnector is configured, but the SMS Approval is deselected, and an app designer configures an app to use SMS approval, the app will send an SMS message requesting a message. However, when an approver submits their approval via SMS, nothing will happen. The approval will not complete in the app, the approver will not see an error message, and no error messages will be written in the log files. In this case, the approval function is turned off, so approval messages are not monitored, even though an app can send a message requesting approval

Default Value:
Selected

Is Sandbox
Function:
Specifies that a Twilio sandbox environment is used to send an SMS.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select Twilio.
Accepted Values:
  • Selected - A Twilio aandbox environment is used to send SMS messages.
  • Deselected - A Twilio production environment is used to send SMS messages.
Default Value:
Selected

Delete SMS After Processing
Function:
Specifies whether to delete an SMS message after the message is used for task approval.
To Open this Field:
  1. On the Configure SMS Service AgileConnector screen, in the SMS Service Type list, select Twilio.
Accepted Values:
  • Selected - Deletes an SMS message after it is used for task approval.
  • Deselected - Stores the SMS message.
Default Value:
Deselected

Schedule Interval
Function:
Specifies the number of minutes for the AgileConnector to wait before checking whether the task has been approved.
Accepted Values:
An integer.
Default Value:
1

Verify Task Ownership
Function:
Specifies whether the SMS Service AgileConnector verifies the participant for the task.
Accepted Values:
  • Selected - Checks the phone number of the task participant in the participant's profile to make sure the participant is configured for the task.
  • Deselected - Does not verify the participant of the task.
Default Value:
Deselected