5.25.1 SERVICE_LOAD

Loads and initializes the service.

Syntax:

Command

Keyword

Value

Developer notes

SERVICE_LOAD

SERVICE

SMSService

 

TRACE

 

Refer to Service Load Tracing for value details.

TRACE_NAME

 

TRACE_GROUP

 

 

Associated Service Properties File

Properties that affect the operation of service are loaded from the SMSService.properties file.

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, you can 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

[email protected]

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>

 

SMTP transport properties

All values can be overridden in the application using the corresponding keyword in the SET command.

transport

This is used to nominate the transport mechanism you will use to send the SMS details to the SMS gateway service provider.
*SMTP indicates that the SMS details is to be sent by email to the SMS gateway service provider.
*HTTP indicates that the SMS details are to be sent using HTTP.

port

This is the TCP/IP port that the SMTP mail server is running on.
The default value is 25.

server

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

subject

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.

from.address

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.

mail.domain

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

mobile.domain

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 [email protected]

charset

The character set of the Content-Type property.
Default is iso-8859-1.

encoding

The encoding of the SMTP protocol and message.
Default is ISO8859_1.

HTTP transport properties

All values can be overridden in the application using the corresponding keyword in the SET command.

transport

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

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

provider

Specifies which of the HTTP SMS providers to use.

uri

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

host

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

sender

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

secure

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.

account.user

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

account.password

The password for your account.

Example

SERVICE_LOAD SERVICE(SMSService) TRACE(*YES)