Upgrade from Auron SMS Server 2018 to Auron SMS Server 2020
Before upgrading please make a backup of the existing server as well as the production database.
There are two main ways to upgrade from the Auron SMS Server 2018 to the Auron SMS Server 2020.
- In-place upgrade
If the server operating system is Windows Server 2008R2 or higher and the SQL Server version is 2008 or higher an in-place upgrade is possible.
In this case running the latest version of the setup will run you through the steps of an automatic upgrade.
- Upgrade by importing the old configuration
If the old server is decommissioned or when adding a new server it is possible to export a configuration and import it into the new SMS Server.
In both cases, depending on your configuration, some things may not be upgraded automatically. Please read the following to help you upgrade the parts of your configuration that could not be upgraded automatically.
In the SMS Server 2018 a message was simultaneously an SMS, E-mail and a File message. In SMS Server 2020 a message is either an SMS, E-mail or a File.
This means that in the trigger scripts everywhere a new message is created it should specify whether this message is an SMS, E-mail or File.
Set objMessage = g_objMessageDB.Create() objMessage.Body = "Hello, World"
Set objMessage = CreateObject("AxMmServer.Message") objMessage.Body = "Hello, World"
Set objMessage = g_objMessageDB.Create("SMS") objMessage.Body = "Hello, World"
Where “SMS” can be either: “SMS”, “EMAIL” or “FILE” depending on the type of message that should be created.
The SMS, E-mail and File message types have all been extended to contain more properties for more fine-grained control over the content of these messages. Please have a look at the API documentation to find out more.
The most important changes are:
- E-mail messages no longer have a ‘Body’ property but instead have: ‘BodyPlainText’ as well as ‘BodyHtml’
- File messages to longer have the ‘FromAddress’ for path information but instead use the ‘Path’ property for path information
- Channel ID’s are now string values.
Status and Status Details
Instead of the message status and status details properties every message now has these properties:
Common StatusID / StatusDetailsID combinations can be translated like this:
|SMS Server 2018||SMS Server 2020|
|PENDING (1)||UNDEFINED (0) or
|‘SCHEDULED’||Scheduled for send|
|SUCCESS (2)||OUT_SUCCESS_SENT (220)||‘SENT’||Sent success|
|SUCCESS (2)||OUT_SUCCESS_DELIVERED (221)||‘DELIVERED’||Delivered|
|FAILED (3)||OUT_FAILED_GENERICFAILURE (210)||‘FAILED’||Send failed|
Trigger related status / status details combinations:
|SMS Server 2018||SMS Server 2020|
|PENDING (1)||IN_PENDING_QUEUED (100)||‘RECEIVED’||”|
|SUCCESS (2)||IN_SUCCESS_PROCESSED (101)||‘RECEIVED’||‘PROCESSED’|
|FAILED (3)||IN_FAILED_PROCESSINGFAILURE (110)||‘RECEIVED’||‘FAILED’|
Routing and blocking rules
Routing and blocking rules now require which message is being routed or blocked.
The automatic upgrade tries to determine this from the properties that are part of the routing / blocking condition.
Please verify if this is still correct after the upgrade.
Advanced channel settings
Advanced channel settings that where configured in the registry such as SMPP TLS settings are now configurable in the SMS Server Manager application. They are not included in an automatic upgrade so please set them manually after upgrading.
SMPP Server Bind scripts
The SMPP Server bind script is not automatically converted. In version 2020 an SMPP Server bind is handled as an incoming message of the type SmppServerBind.
The trigger wizard in the SMS Server Manager 2020 has an option to generate SMPP Server bind scripts.
If you need any additional help upgrading an existing SMS Server configuration to version 2020. Please contact us.