• The Clearly Anywhere Token
• Access to the CLI to add the Clearly Anywhere firewall rules
• The External IP address or the FQDN of the ComXchange server
• Set Max Contacts for the extension to allow more than one connection
• Permissions setup for the user that will be using the Clearly Anywhere Application

• Log into the device manager at https://devices.clearlyip.com/
• look for the Clearly Anywhere tab and locate the token for the site may be named for the Sales Order that was used to purchase it
• Look under the token field to copy it to be used when setting up the Clearly Anywhere module

• Connect to the ComXchange CLI and edit the iptables file /etc/sysconfig/iptables
• Add the following lines to the top of the rules.  Must be above the Drop rules.

• Restart iptables by entering the command "service iptables restart"

• Enter the token into the Registration Token field and click on Submit

• API Connection URL - This is IP address or the Full URL and port number that the Clearly Anywhere app will connect to for receiving provisioning information 
  • EX: https://CXP-6XXX.clearlyip.me:2267
• PBX Domain - This is the IP address or FQDN that the mobile app will use to register the extension
  • EX: cxp-6XXX.clearlyip.me

• PBX Domain - This is the Domain or IP Address you provide to ClearlyIP. This is the Domain the users will login to Clearly Anywhere app with and this is the Domain we will connect to asterisk to register to. If you need to change this domain you will need to contact Clearly IP Support to update this domain for you.
• API Connection URL - This is what URL our provisioning system will redirect your clients when they log in.  Please note the Port at the end of the URL of 2267 is the default port you need to open on your firewall for provisioning. You can change this API URl and Port as defined below 
• API Connection Status - If this shows contact support as shown below this means our API servers that are used when a user logs into the Clearly Anywhere app can not reach your PBX on the API Connection URL as defined above.  Before you contact support verify the URL is reachable from the outside world.
• API Port Matches - Will show Good as long as the Port you have defined for the API is the same port that you have in the API Connection URL.
• Mobile Location ID or Location ID - This is the unique Location ID for your PBX and used when purchasing add on licenses or opening a support ticket with us so we know which license you are referencing.
• Subscription Active - This shows if your license for Clearly Anywhere is active.
• Service Through - Shows when you license for Clearly Anywhere expires.
• Total Clients - Is how many clients your PBX is licensed for
• Assigned Clients - Is how many of your users are setup in User Manager with direct permissions for Clearly Anywhere
• Inherited Clients - Is how many of your users are setup in User Manager with permissions for Clearly Anywhere that are inherited from the Group Permissions.
• Total Used Clients - This shows how many clients of your Total Clients you are currently using.

Updating the Token

Set Extension Max Contacts

User Setup and Permissions

• Click on the Edit Icon of the User with the linked extension that will be using the Clearly Anywhere App

Enable the Softphone

• Click on the Clearly Anywhere Tab and select Enable for the Soft phone

• Set the Emergency Rules to Custom
• Click Add a rule

• Add 911 to the emergency number rule and select Cell Network

Clearly Anywhere User Information

Sending User Login emails

Provisioning token

Sometimes when there are issues with Clearly Anywhere or changes are made to the module such as External IP changes you may need to regenerate the users provisioning tokens.  These can also be viewed as a QR code  that you can send as a screen shot for the user if the email is not going through.

• While in the Clearly Anywhere Module click on the fly out menu on the right side of the screen
• Click on Settings

• Click on the Provisioning Token Tab

•  You can then regenerate or see the QR Code for the user
• *** Note: Once the QR code is regenerated you will need to reload the webpage for the new qr code to be available.  If the page is not reloaded the old qr code will still be displayed.

Push Tokens

Here we will show you the Push Token each device and user is currently registered to your PBX with.

• A Push Token is used to push new calls to the phone anytime a new inbound call is received for the extension of the User
  • A Push Token is also used to notify a phone when it has a new SMS or MMS message. 

Video Setup

• Navigate to your Asterisk SIP Settings module in your PBX and verify you have both H264 and VP8 enabled and that Video Support is also enabled.

• The Clearly Anywhere mobile app communications with your PBX for provisioning information by default on port 2267 (TCP) as shown in the module in. the API Connection URL field.  You can change this as outlined above in the Settings section of this guide.  This port must be opened to the outside world to allow the app to get provisioning data and login.
  • By default when your Clearly Anywhere App goes to pull provisioning data the first request will come from our API server with a IP Address of 66.185.18.42, 66.185.18.43 or 66.185.18.44 and all request after will come direct from the Clearly Anywhere App. We do have the ability to set a toggle on a Token by Token basis to force all Provisioning data to proxy through us so that you can open 2267 only to our IPs of 66.185.18.42, 66.185.18.43 and 66.185.18.44.  Contact support if you want us to enable this for you.
• Once the user is logged in and receives the provisioning data, it will register to your PBX using the domain name set in the module under the PBX Domain field.  If you want to change the Domain or IP address the phones registered to at this time, you need to open a ticket with Clearly IP to change it on our backend.  Soon, you can control this from within the module yourself.  
• The phone will register to asterisk using whatever you have defined in the PJSIP channel driver for the port so if your phones are remote you will need to make sure that port is allowed through your firewall and if using the built in FreePBX firewall, make sure you have the responsive firewall enabled for PJSIP or the PJSIP ports opened as well as ports RTP ports which by default are 10000-20000 but can be changed inside the FreePBX SIP Settings module.
  
• The app will first scan to see if you have UDP enabled and use that. If UDP is not enabled, it will look to TCP next and use that Port, and lastly, it will look to TLS based on your Global SIP Settings.
• If you want to restrict a specific user to use a specific protocol like TLS, you would go into the extension settings of that user and restrict their "Transport" setting from Auto to whatever protocol you wanted to use for that user.
• Since inbound calls by default are sent from Push Servers all over the world, the Push Servers have to register to your PBX for inbound calls to work.  Below is a list of all the Push Servers that calls can come from that you need to make sure are able to connect to your PBX on the SIP port.

Signalling UDP TCP and TLS

• By default the Clearly Anywhere Module attempts to use the following signaling in this order

• UDP
• TCP
• TLS
  
  

• When the Clearly Anywhere module on your PBX sets up configurations for your Clearly Anywhere app for each user it follows this logic.

• It looks to see what you have enabled in your Asterisk SIP Settings module under the PJSIP Section
• It eliminates any of the protocols listed above if they are not enabled in your SIP Settings module.
  
  

• Finally it looks into the extension of each user and if the extension on the PBX is restricted to a certain protocol type such as UCP, TCP or TLS it will use that. 
  
  
• If the extension is set to Auto for Transport (which is the default behavior in FreePBX on new Extensions) it will use the protocol based on the Order in Step 1 after it has eliminated anything that was not enabled in Step 2 above
  
  
• Example 1
  1. I have in SIP Settings both UDP and TCP enabled
  2. The extension 101 is set to Auto for Transport
  3. 101 will be provisioned with UDP since you have UDP and TCP enabled and our App prefers to use UDP over TCP and you have the extension set to auto
     
     
• Example 2
  1. I have in SIP Settings both UDP, TCP and TLS enabled
  2. The extension 101 is set to TCP for Transport
  3. 101 will be provisioned with TCP since you have the extension in the PBX hard set to use TCP and not auto.

Codec Setup and Flow

By default, the Clearly Anywhere Module attempts to use the following codecs in this order.  The order depends if you are making a call on Wi-Fi or Cellular Data.  These are hardcoded orders based on sound quality and bandwidth requirements.

• Wifi
  • opus
  • G722
  • ulaw
  • alaw
  • g729
  • ilbc
  • gsm
• Cellular Data
  • opus
  • g729
  • gsm
  • ulaw
  • alaw
  • ilbc
  • g722
  When the Clearly Anywhere module on your PBX sets up configurations for your Clearly Anywhere app for each user, it follows this logic.
  
  • It looks to discover what you have enabled in your Asterisk SIP Settings module under the PJSIP Section.
    • It eliminates any of the codecs listed above if they are not enabled in your SIP settings module.

Module Debugging Tools

fwconsole commands

• The following are a list of fwconsole commands you can use with the Clearly Anywhere module.  You can also add a --json at the end of the commands below to have it export everything as json.

1. fwconsole clearlysp --info
   • Will return back Module Token, Domain Name and Licensed Total users and currently used licenses
2. fwconsole clearlysp --refresh
   • Will refresh its license information from our license server.  Normally used after purchasing more seats or extending the expiration date
3. fwconsole clearlysp --listusers
   • Will list all the users that are setup with Clearly Anywhere
4. fwconsole clearlysp --uncap XXX
   • Replace XXX with a user name and when run it will set that userback to inherit instead of yes for Clearly Anywhere enabled for that user.
5. fwconsole clearlysp --remove
   
   • Will remove the token on this PBX so that you can reuse the token with a different PBX

API Connection Status error in Module

• If you see the following error in the module this means that our redirect server that redirects the Clearly Anywhere mobile users on login to your PBXs API URL is not reachable.

• This is usually caused by 1 of the following reasons.
  • The port you have us redirecting to is not open on your firewall.  This default port is 2267 and can be seen in the "API Connection URL" field in the Clearly Anywhere module main page.  Verify you have this port opened on your Corporate Firewall and if enabled the FreePBX Firewall.
    
  • The node.js application that the phones connect to on the above port is not running.  See below on how to debug the node.js application
  • The FQDN or IP address you provided to us is not resolvable or reachable.
    • If using a IP address in the API Connection URL verify the IP address is correct.
    • If using a FQDN verify the FQDN resolves to the correct IP Address.

node.js application

• The Clearly Anywhere mobile app receives its provisioning on login and when it updates from your PBX direct on the API URL that is shown in the module.  The default for this is http://XXX:2267 with XXX being your IP or FQDN.
  
• If the node.js application is not running the phones will not be able to receive provisioning data or let you login and our API server would not be able to relay clients to your PBX
  
• You can verify this is by looking in Dashboard of your PBX and locating the Clearly Anywhere Daemon and verify it has a Green Checkmark.

• You can also verify this by running the following command from your PBX Linux CLI.

fwconsole pm2 --list

• Verify the process clearlysp is online

• If the process is not running you can start it with the following command

fwconsole restart clearlysp

Mobile App Showing Expired

• If you see a Red Box that says Expired when viewing your mobile app this means the license on your PBX for Clearly Anywhere has expired and you need to renew your license.