XMS Parameters Feature Nodes

Alphabet Branching

The Alphabet Branching node determines if the message text is using the alphabet specified in this node and branches accordingly.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Match	The message uses the current alphabet specified.
2	No Match	The message does not use the current alphabet specified.

Configuring the node

Follow these steps to configure the node.

Select the alphabet to compare the message against from the Alphabet drop down list.
Click Save.

Content Size Branching

The Content Size Branching node branches depending on the size of the short message (in bytes). It takes the threshold entered into the node and chooses either the small or large branch.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Small Message	The message is smaller than the specified number of bytes.
2	Large Message	The message is equal to, or larger than the specified number of bytes.

Configuring the node

Follow these steps to edit the node.

Specify the message size threshold, in number of bytes.
If you select the Include Header check box, then the length of the user data header is included in the message length.
Click Save.

Message Attribute Branching

Branches on the value of a message attribute. Branching is based on the result of a logical comparison between a value and the value in the corresponding message attribute.

Node exits

This node has one entry and four exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Less Than	The value in the message is lower than the value configured in the node.
2	Equals	The value in the message is the same as the value configured in the node.
3	Greater Than	The value in the message is greater than the value configured in the node.
4	Not Found	An error occurred during the comparison.

Note: Strings are evaluated against ASCII order, on a character-by-character basis starting with the left-hand character.

Configuring the node

Follow these steps to configure the node.

Configure this record by entering data in the fields on the Configure Set Message Attribute screen.

For more information about the fields on this screen, see Configuration fields.
Click Save.

Configuration fields

This table describes the function of each field.

Field	Description
Attribute	The message attribute to compare.
Value Type	The type of value the attribute will be compared with.
Fixed	The value the message attribute will be compared with. Note: This field is only available if the Value Type field is set to `Fixed`.
Enumerated	The value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Enum`. The drop list is populated by the application. The available options cannot be changed. For more information about the available values, see Enumerated fields.
Source Location	The profile block which stores the value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Profile`. The drop down list is populated by the records on the Profile Tag Details tab of the ACS Configuration screen.
Source Field	The profile field which stores the value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Profile`. The drop down list is populated by the records on the Profile Tag Details tab of the ACS Configuration screen. The available profile fields are dependant on the profile selected in the Source Location drop down list.

Enumerated fields

This table describes the list of enumerated values which are available to the Message Attribute nodes.

Group Name	Value	Description
ATTRIBUTE	SRR	Status report (delivery receipt) request
ATTRIBUTE	RRR	Read-reply report request
ATTRIBUTE	SMS_CLASS	SMS Message class
ATTRIBUTE	MW_TYPE	Message waiting type
ATTRIBUTE	MW_SENSE	Message waiting sense
ATTRIBUTE	MW_GROUP	Message waiting group
ATTRIBUTE	PRIORITY	NA
ATTRIBUTE	SINGLE_SHOT	Single-shot
ATTRIBUTE	RECIPIENTS	Number of recipients
ATTRIBUTE	RECIPIENT	Current recipient
ATTRIBUTE	SIZE	Message size
ATTRIBUTE	MMS_CLASS	MMS message class
ATTRIBUTE	ADAPTATION	Content adaptation
ATTRIBUTE	TIME_ZONE	NA
ATTRIBUTE	SERVICE_CODE	NA
ATTRIBUTE	BILLING_INFO	Billing Identifier
ATTRIBUTE	VP_TYPE	Validity Period Type
ATTRIBUTE	VALIDITY	Validity Period
ATTRIBUTE	MESSAGE_TYPE	NA
ATTRIBUTE	CHARGED_PARTY	NA
ATTRIBUTE	VAS_ID	NA
ATTRIBUTE	VASP_ID	NA
SRR	0	None requested
SRR	1	SME requested
SRR	2	MMX requested
SRR	3	Both requested
RRR	0	Not requested
RRR	1	Requested
SMS_CLASS	0	None
SMS_CLASS	1	Display (GSM 0)
SMS_CLASS	2	Mobile Equipment (GSM 1)
SMS_CLASS	3	SIM (GSM 2)
SMS_CLASS	4	External (GSM 3)
MW_TYPE	0	None
MW_TYPE	1	Voicemail
MW_TYPE	2	Fax
MW_TYPE	3	Email
MW_TYPE	4	Other
MW_SENSE	0	Inactive
MW_SENSE	1	Active
MW_GROUP	0	None
MW_GROUP	1	Discard
MW_GROUP	2	Store
PRIORITY	0	Normal
PRIORITY	1	Interactive
PRIORITY	2	Urgent
PRIORITY	3	Emergency
SINGLE_SHOT	0	False
SINGLE_SHOT	1	True
MMS_CLASS	0	None
MMS_CLASS	1	Personal
MMS_CLASS	2	Advert
MMS_CLASS	3	Info
MMS_CLASS	4	Auto
ADAPTATION	0	False
ADAPTATION	1	True
VP_TYPE	0	Relative
VP_TYPE	1	Absolute
MESSAGE_TYPE	0	Submit
CHARGED_PARTY	0	Neither
CHARGED_PARTY	1	Sender
CHARGED_PARTY	2	Recipient
CHARGED_PARTY	3	Both
CHARGED_PARTY	0	`/`
CHARGED_PARTY	1	`text/*`
CHARGED_PARTY	...	NA

Segment Number Branching

The Segment Number Branching node branches, depending on if the current message is the last (or only) component in a concatenated, multi-part, message. It compares the current segment number with the total number of segments and takes the appropriate exit.

Node exits

This node has one entry and four exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Only Segment	The message contains only one segment.
2	First Segment	There is more than one segment in the message and the segment number is one.
3	Middle Segment	There is more than one segment in the message and the segment number does not match the number of segments.
4	Last Segment	There is more than one segment in the message and the segment number matches the number of segments.

Configuring the node

This node requires no configuration data. You may change the Node name, if required.

Set Data Coding

The Set Data Coding node sets the character set of the message to be used when the ACS Control Plan passes the message on to Messaging Manager for delivery.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Success	The configured alphabet has been successfully selected. Note: The Set Data Coding node does not change the data coding in ACS, but it does define the data coding used when the message is returned to Messaging Manager. This occurs when the message is actually ready to be sent. Consequently, the TP-DCS known to ACS in the Control Plan is still the original TP-DCS, and its value does not change when leaving this node through the Success branch.
2	Failure	General error occurred.

Exit

Cause

Description

1

Success

The configured alphabet has been successfully selected.

Note: The Set Data Coding node does not change the data coding in ACS, but it does define the data coding used when the message is returned to Messaging Manager. This occurs when the message is actually ready to be sent. Consequently, the TP-DCS known to ACS in the Control Plan is still the original TP-DCS, and its value does not change when leaving this node through the Success branch.

2

Failure

General error occurred.

Configuring the node

Follow these steps to edit the node configuration.

Select the message alphabet from the Alphabet drop down list.
Click Save.

Set Message Attribute

Allows the modification various attributes of the message data by overriding the options requested by a caller.

To set a message's time zone to the time zone of the user, see Set Time Zone Message Attribute.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Success	The specified attribute was set successfully.
2	Failure	The node failed to change the specified attribute.

Configuring the node

Follow these steps to configure the node.

Configure this record by entering data in the fields on the Configure Set Message Attribute screen.

For more information about the fields on this screen, see Configuration fields.
Click Save.

Configuration fields

This table describes the function of each field.

Field	Description
Attribute	The message attribute to compare.
Value Type	The type of value the attribute will be compared with.
Fixed	The value the message attribute will be compared with. Note: This field is only available if the Value Type field is set to `Fixed`.
Enumerated	The value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Enum`. The drop list is populated by the application. The available options cannot be changed. For more information about the available values, see Enumerated fields.
Source Location	The profile block which stores the value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Profile`. The drop down list is populated by the records on the Profile Tag Details tab of the ACS Configuration screen.
Source Field	The profile field which stores the value the message attribute will be compared with. Notes: This field is only available if the Value Type field is set to `Profile`. The drop down list is populated by the records on the Profile Tag Details tab of the ACS Configuration screen. The available profile fields are dependant on the profile selected in the Source Location drop down list.

Set Time Zone Message Attribute

Sets the message time zone attribute to the user's time zone.

To set other message attributes, see Set Message Attribute.

To branch on message attributes (including time zone), see Message Attribute Branching.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Success	The time zone was set successfully.
2	Failure	An error occurred and the time zone was not set.

Configuring the node

Follow these steps to configure the node.

Configure this record by entering data in the fields on the Configure Set Time Zone Message Attribute screen.

For more information about the fields on this screen, see Configuration fields.
Click Save.

Configuration fields

This table describes the function of each field.

Field Description

Timezone Type The source of the timezone value.

Unix Timezone

Field	Description
Timezone Type	The source of the timezone value.
Unix Timezone	The timezone to use from the standard unix timezone set. Note: This field is only available if Timezone Type is set to `Explicit Unix TZ`.

The timezone to use from the standard unix timezone set.

Note: This field is only available if Timezone Type is set to Explicit Unix TZ.

Test Data Coding

The Test Data Coding node checks the message for compatibility with the specified (in this node) destination alphabet.

This node is used to determine if the message can be converted to the specified alphabet. If not then the control plan can be set to compare against another alphabet in another instance of this mode.

Node exits

This node has one entry and two exits. The number of exits cannot be changed.

Exit	Cause	Description
1	Pass	The message will be convertible to the destination alphabet with less than or equal to the allowed character conversion failures.
2	Fail	The message will not be converted to the destination alphabet without incurring more than the allowed character conversion failures.

Configuring the node

Follow these steps to edit the node configuration.

Select the destination alphabet for the message to be converted to from the Alphabet drop down list.
Enter the maximum number of characters that cannot be converted to the destination alphabet before failing the conversion test in the Misses Allowed field.
Click Save.