Messages and IMR

Gateways

Gateways serve as a means in FrontStage to receive and send messages.

Displayed name	AttributeName	Description
ID	GatewayId	Primary Key.
Name	DisplayName	Name for an administrator or agent. Also used as a DispalyName e.g. for emails. For some types of gateways, it can appear as the sender’s name.
Address	PilotAddress	Address, in the format it is understood by the gateway device (email, GSM gateway phone number). The recommended to write in lowercase.
Description	Description	Description for administrator.
Channel	Channel	Asynchronous message channel type: e.g. Email, SMS, Fax, SocialMsg, and SocialWall.
Direction	Direction	Direction of use: I-in, O-out, B-bidirectional
Input device	InDevice	Determines the external message transfer device for inbound messages and it’s configuration: DropFolder - central folder for EML files. Pop3Host - prefix, after which the URI POP3 follows. EWSHost - connector for Exchange Web Services MaternaConnect - to receive SMS The value is a valid JSON object, which describes the settings of the input device. For more info see gateway selection.
Output device	OutDevice	Determines the external message transfer mechanism for outgoing messages and it’s configuration: SmtpDirect - direct sending SmtpHost BridgeConnect EWSHost - connector for Exchange Web Services The input value is a valid JSON object which desbribes the chosen outgoing device. For more details see gateway selection.
Language	LanguageId	Default language when a message arrives via this pilot. Set only if the gateway is for a specific language.
Superior gate	MasterGatewayId	Parent Gateway. If a message is received by a gateway that has a parent gateway configured, the message appears as received by the parent gateway. It does not work recursively (one step only).
Editor function (JSON)	EditorFunctionJson	JSON object for a particular gateway with local parameters. It determines the specific gateway behaviour, global parameters (settings in section Configuration ) are supressed if this settings is present. For emails: OriginalEmailSeparator FinalizeEmailBeforeSend BodyHtmlEmailWrapperMultiLine ImrReplyFormat

IMR scripts

An overview of all existing automatic message processing scripts.

Displayed name	AttributeName	Description
ID	ImrScriptId	Primary Key.
Name	DisplayName	Name for administrator.
Description	Description	Description for administrator.
Form	ScenarioId	Automatically generated scenario.

IMR steps

It describes the individual script steps for processing the messages to be performed.

Displayed name	AttributeName	Description
ID	ImrStepId	Primary Key.
Name	DisplayName	Name for administrator.
IMR script	ImrScriptId	Specifies which script this step belongs to.
Order	Rank	The order in which the steps will be performed. Numbers don’t have to be in sequence or unique.
Command	Action	The script engine command in the step.
Parameters	Parameters	Command parameters.
Target values	Targets	Command parameter, usually target numbers, result value, or target lines.
Target ID	TargetId	Command parameter, usually the target object ID (eg, project, language, or output pilot).
Reference number	Reference	Reference number.
Reference ID	ReferenceId	Auxiliary Reference.
Reference text	ReferenceText	Help text.
Comparison rule set	TextMatchId	Text match condition to use. NULL - not evaluated.
Jump target after success	TargetOnSuccess	Line number for rebound when step is correct. Otherwise, the script continues normally with the next line.
Jump target after failure	TargetOnFailure	Line number for step failure. Otherwise, the script continues normally with the next line.
Calendar mode	TimeMode	How to Interpret TimeFrom / TimeTo Fields. If it is NULL, time is not checked.
From	TimeFrom	Date and time of the time condition. YearInYear is ignored, DayInWeek is extracted only the day of the week. May be NULL only if TimeMode is also NULL. Local time.
To	TimeTo	Date and time end of time condition. YearInYear is ignored, DayInWeek is extracted only the day of the week. May be NULL only if TimeMode is also NULL. Local time.
Language	LanguageId	Language condition. NULL without checking.

Text matches

A table of comparison rule sets. First, you need to create individual comparison rules, then set up a set of comparison rules that determine how they are applied.

Displayed name	AttributeName	Description
ID	TextMatchId	Primary Key.
Name	DisplayName	Name for administrator.
Field type	TextType	Type of text: Email, Fax, SMS, Chat.
Processing method	MatchType	How to handle rules in a set. “And”, “Or”
Description	Description	Description for administrator.

Text match rules

Table of specific rules for text comparison.

Displayed name	AttributeName	Description
ID	TextMatchRuleId	Primary Key.
Rule set	TextMatchId	To which set of text matchs this rule belongs.
Field type	FieldType	The type of field to which the rule applies. “From”, “To”, “Subject”, “Body”, “HeaderField”.
Field name	FieldName	Field name for comparison purposes, complementary to FieldType for HeaderField.
Rule type	RuleType	Type of rule. “Exact”, “Like”, “NotExact”, “NotLike”, “Sensitive”, “KeyValue”, “RegEx”
Parameter	Content	Rule parameter

Next   Previous