Setup of Preferences
There are specific preferences that need to be set for the activation of email and SMS communication to clients.
| Warning | ||
|---|---|---|
| ||
The following sites will need to be accessible by ALL users running Framework. This will typically be implemented by a network administrator. AU EAST http://gatewaysmsapi.pstpf.com.au/api/metadata AU WEST http://production-eros-gateway-api-email-wa.azurewebsites.net/api/metadata http://production-eros-gateway-api-sms-wa.azurewebsites.net/api/metadata You can then proceed to send a test email or SMS using a non job specific email or SMS. You can do this by setting the job specific flag to no in the communication dialog. |
Email Service Preferences (Perspective Platform\Communications\Email Service)
Preference ID | Preference Name | Value |
|---|---|---|
| -50289 | Email Service Enabled? | Yes |
-50290 | Email Service URL AU EAST | http://gatewayemailapi.pstpf.com.au/api |
| -50290 | Email Service URL AU WEST | http://production-eros-gateway-api-email-wa.azurewebsites.net/api |
| -50291 | Email Service Appliance | EE6CDE78-EF5F-4D23-87D1-41AA6FE51066 |
-50292 | Email Service Provider | credentials |
-50293 | Email Service Username | Contact Insula to setup |
-50294 | Email Service Password | Contact Insula to setup |
| -50334 | Sent Email Audit? | Yes |
| -50335 | Sent Email Audit address | This can be blank or an email address can be created to have all emails sent from Framework copied to |
There is also another email setup preference (Framework ECM\Email/SMS Configuration\Master Email Settings)
| Preference ID | Preference Name | Value | Preference Level |
|---|---|---|---|
| -50004 | Email From Address | framework@yourcompanyname.com.au | Default or Context or Group |
| -50004 | Email From Address | user@yourcompanyname.com.au | User |
Setting a User Specific Email Address
It's important to note here that it is possible to utilise a specific send from address, eg. jsmith@insulahomes.com.au. Specific default preferences should be set where users may send from a specific address, e.g. an admin account where the user changes but the email is the same.Users who wish to have a send from address different to their default or context level preference, should do so by setting a user specific preference.
To have a user's own email address as the send from ie. user@yourcompanyname.com.au, the address must be exist for the user's Staff Member entity (Administration > Entity > Staff Member). This is the entity linked to the logged in user (Security > User).
You can navigate between from addresses from within the communication dialog, which will be discussed in the later parts of this article.
SMS SMS Service Preferences (Perspective Platform\Communications\SMS Service)
Preference ID | Preference Name | Value |
|---|---|---|
-50102 | SMS Service Enabled? | Yes |
-50284 | SMS Service URL AU EAST | |
| -50284 | SMS Service URL AU WEST | http://production-eros-gateway-api-sms-wa.azurewebsites.net/api |
-50285 | SMS Service Appliance | B64CF8CA-919C-4A0B-BF04-2F4AC701C269 |
-50286 | SMS Service Provider | ''credentials'' |
-50287 | SMS Service Username | Contact Insula to setup |
-50288 | SMS Service Password | Contact Insula to setup |
-50103 | SMS Server Status Check Interval (Minutes) | 3 |
-50248 | SMS Service ‘From’ Number | 0400 000 000 |
-50249 | SMS Message Expiry (Minutes) | 720 |
As the final part of setup, ensure that you are able to browse to the following API URLs located below in IE
http://gatewaysmsapi.pstpf.com.au/api/metadata
http://gatewayemailapi.pstpf.com.au/api/metadata
...