5.15.3 SMSService Properties

The following lists the contents of the SMSService.properties as they are shipped in a standard LANSA Integrator installation. These values are loaded as the defaults when the SERVICE_LOAD command is run.

The SMSService.properties file consists of 2 sets of key words - one set relevant to the HTTP transport, and another set relevant to the SMTP transport.

By default the HTTP transport will be used by the SMSService. To use the SMTP transport, comment out the transport=*http property to allow the transport=*smtp property to be active or add a transport=*smtp property after the transport=*http property. Alternatively, use the TRANSPORT command keyword to override the transport property value.

If you are using the HTTP or SMTP transport, then you should set up your default values in the SMSService.properties file according to the directives from your SMS gateway service provider. Alternatively, use the SET command in your application to set these values at runtime.

 

#!<studio-project id="20000000-000000" name="acme">

#

# SMSService resources ( Default )

#

transport=*smtp

port=25

server=nnn.nnn.nnn.nnn

subject=user+password

from.address=person@mycompany.com

mail.domain=mycompany.com

mobile.domain=smscompany.com

# charset=iso-8859-1

# encoding=ISO8859_1

#

transport=*http

provider=*streetdata

uri=/admin/msg.php

host=www.streetdata.com.au

secure=*yes

account.user=12345

account.password=abcde

# sender=identifier

#

#!</studio-project>

 

The following explains the keywords defined in the SMSServices.properties file.

Keywords

transport

This is used to nominate the transport mechanism you will use to send the SMS details to the SMS gateway service provider.

There are two options:

A value of *SMTP indicates that the SMS details is to be sent by email to the SMS gateway service provider.

A value of *HTTP indicates that the SMS details are to be sent using HTTP.

The transport you select will most likely be based on the service you subscribe to with the SMS gateway service provider.

This value can be overridden in the application using the TRANSPORT keyword on the SET command.

provider

This keyword is only used with the *HTTP transport. This value specifies which of the SMS providers to use.

This value can be overridden in the application using the PROVIDER keyword on the SET command.

uri

This keyword is only used with the *HTTP transport.

This is the HTTP resource supplied to you by the SMS gateway service provider.

This value can be overridden in the application using the URI keyword on the SET command.

host

This keyword is only used with the *HTTP transport.

This is the host value supplied to you by the SMS gateway service provider.

This value can be overridden in the application using this HOST keyword on the SET command.

sender

This keyword is only used with the *HTTP transport.

This identifies the sender of the SMS message. This feature is optional as some providers do not support it.

This value can be overridden in the application using this SENDER keyword on the SET command.

secure

This keyword is only used with the *HTTP transport.

You will need to set this value to *YES to indicate that you would like to send the details using SSL (encrypted HTTPS).

The default value at installation is *NO.

This value can be overridden in the application using the SECURE keyword on the SET command.

account.user

This keyword is only used with the *HTTP transport.

This is your account name supplied to you by your SMS gateway service provider.

This value can be overridden in the application using the ACCOUNT_USER keyword on the SET command.

account.password

This keyword is only used with the *HTTP transport.

This is the password for your account.

This value can be overridden in the application using the ACCOUNT_PASSWORD keyword on the SET command.

port

This keyword is only used with the *SMTP transport

This is the TCP/IP port that the SMTP mail server is running on.

The default value is 25.

This keyword is optional.

This value can be overridden in the application using the PORT keyword on the SET command.

server

This keyword is only used with the *SMTP transport

This is the address of the SMTP server you are using to send the email that contains the SMS details.

This value can be overridden in the application using the SERVER keyword on the SET command.

subject

This keyword is only used with the *SMTP transport.

It will contain the subject of the email.

Typically this would contain your user account and account password (in the format 'user+password') for the SMS gateway that you are using. Confirm the format with your provider as it may have its own format.

This value can be overridden in the application using the SUBJECT keyword on the SET command.

from.address

This keyword is only used with the *SMTP transport.

This is the address to which you want email responses from the SMS gateway service provider routed back to. Such responses might include SMS status information (such as a failed SMS).

This would normally be one of your company email addresses - perhaps one that is dedicated to receiving such responses. It should be a valid email address. Many providers will only accept addresses that are already registered with them.

This value can be overridden in the application using the FROM keyword on the SET command.

mail.domain

This keyword is only used with the *SMTP transport.

This is the mail domain as issued by the SMTP HELO command. This value tells the SMTP server that this is your mail domain.

This keyword is optional.

This value can be overridden in the application using the MAILDOMAIN keyword on the SET command.

mobile.domain

This keyword is only used with the *SMTP transport.

This is the mail domain to which you will send the email with the SMS details.

Normally the mobile phone number you are sending the SMS to will prefix this value. So for example, if you are sending the SMS to a number 12345678 and the mobile domain is streetdata.com.au, then the full email address that the message will be sent to is 12345678@streetdata.com.au.

This value can be overridden in the application using the MOBILEDOMAIN keyword on the SET command.

charset

This keyword is only used with the *SMTP transport.

This is the character set encoding of the body text and subject.

This keyword is optional.

This value can be overridden in the application using the CHARSET keyword on the SET command.

encoding

This keyword is only used with the *SMTP transport.

This is the body text encoding

This keyword is optional.

This value can be overridden in the application using the ENCODING keyword on the SET command.