Sei sulla pagina 1di 25

Premiere Connect

Common Elements API


Manual
Premiere Global Services

Description of the data use with Premiere Connect functions.

Last Modified: 09/17/2009

V1.0 – Premiere Connect 2.3

Premiere Global Services Confidential & Proprietary 1


Table of Contents

1 COMMON ELEMENT DESCRIPTIONS ................................................................................................ 3


1.1 STATUS .................................................................................................................................................. 3
1.2 RECSTATUS ........................................................................................................................................... 3
1.3 LISTID ................................................................................................................................................... 4
1.4 JOBID ..................................................................................................................................................... 4
1.5 CHARACTER SETS AND ENCODABLE STRINGS ..................................................................................... 5
1.5.1 Document Character Sets .............................................................................................................. 5
1.5.2 Field Character Sets ...................................................................................................................... 5
1.5.3 Table Data ..................................................................................................................................... 6
1.5.4 List and Object Names ................................................................................................................... 7
1.6 DOCUMENT AND DOCDATA .................................................................................................................. 8
1.7 DESTINATIONTYPE ............................................................................................................................. 10
1.8 DELIVERYITEM ................................................................................................................................... 11
1.8.1 Fax ............................................................................................................................................... 12
1.8.2 Internet......................................................................................................................................... 13
1.8.3 Voice ............................................................................................................................................ 13
1.8.4 DeliveryItemGeneric.................................................................................................................... 14
1.8.5 Mbox ............................................................................................................................................ 14
1.8.6 Telex............................................................................................................................................. 15
1.8.7 Fod ............................................................................................................................................... 15
1.8.8 Sms ............................................................................................................................................... 15
1.8.9 List ............................................................................................................................................... 16
1.8.10 SmQuery ...................................................................................................................................... 16
1.8.11 Table ............................................................................................................................................ 17
1.8.12 Alternate ...................................................................................................................................... 18
1.8.13 InsertList ...................................................................................................................................... 19
1.8.14 Extension ..................................................................................................................................... 19
1.9 STORED OBJECTS ................................................................................................................................ 20
1.9.1 StoredObjectId ............................................................................................................................. 20
1.9.2 Stored Object Functions .............................................................................................................. 21
1.10 DOCUMENTINFO ................................................................................................................................. 22
1.11 BRANCHING ......................................................................................................................................... 23
1.12 BLOCKADDRESSRECSTATUSTYPE ..................................................................................................... 23
1.13 BLOCKDESTINATIONTYPE ................................................................................................................. 24
1.14 RULESTYPE ......................................................................................................................................... 24
1.15 TRANSACTIONINFO ............................................................................................................................. 25
1.16 DOCUMENTINFORMATION .................................................................................................................. 25

Date Author Comments


March 20, 2009 Ashima Gupta Initial revision
September 14, 2009 Garet Cammer Revised for publication

Premiere Global Services Confidential & Proprietary 2


Common Element Descriptions

1 Common Element Descriptions


1.1 Status
The Status element is returned in most Premiere Connect result messages.

Tag Name # Description


Status
StatusCode 1 Contents will be an integer value. The value 0 indicates successful processing of the
message, and any non-zero value indicates something less than complete successful
processing.
Requests that contain multiple parts (for example, a JobSubmitRequest with
multiple Message requests) may return an overall Status for the request, and a
more specific Status (or RecStatus) for each part.
A success (0) StatusCode in the overall Status may merely mean that the
request was processable, not that all of the parts were successfully executed – the
individual status of each part should be examined.
In general, a value of 1 will indicate a failure or problem, and 2 may indicate partial
success – although again the status of each part must be examined.
StatusMessage 0-1 If present, this will contain a text message associated with the StatusCode. This
is intended as an aid only – users should rely only on the StatusCode, and should
not count on any particular text string or pattern in StatusMessage.
ErrorList 0-1 If present, this will contain one or more Error elements with more information
about errors that were encountered.
Error 1- Contains error information

ErrorCode 1 An integer value associated with the particular error.

ErrorMessage 1 Text relating to the error.

SubmissionTime 1 The time the request (or part of the request) was received for processing.

CompletionTime 1 The time that processing of the request (or part of the request was completed. Note
that there may be a delay in communicating the result of the task back to the user.

1.2 RecStatus
The RecStatus element is used by some Premiere Connect result messages to indicate the status of a
particular part of a multi-part request. It is a bit less verbose than the Status element.

Tag Name # Description


RecStatus The contents of the RecStatus element, if any, will be text associated with the
status or error.
attribute code 1 A numeric status/error code.

Premiere Global Services Confidential & Proprietary 3


Common Element Descriptions

1.3 ListId
ListId: This represents the data necessary to identify a particular stored list.

Tag Name # Description


ListId The contents of the ListId element is the list name.
attribute ownership 0-1 This indicates the level of ownership (and therefore the visibility) of this list.
Values are:
user
group
customer
system
attribute liststore 1 Indicates which service contains the stored list. Values are:
XDDS
MR

1.4 JobId
JobId: This represents the data necessary to identify a job, or job group. It has the following immediate child
elements:

Tag Name # Description


JobId
XDN 1 The domain name (XDN = Premiere Global Domain Name)
MRN 1 The job number (MRN = Message Reference Number)

Premiere Global Services Confidential & Proprietary 4


Common Element Descriptions

1.5 Character Sets and Encodable Strings


Premiere Connect uses XML documents to transmit information for use in jobs. Within an XML document, a
single character encoding applies – most commonly UTF-8. PGS systems permit some data – documents and
certain fields – to contain data using a different character encoding. There are also some fields which may
contain data which may be in a different character encoding, but for which the character set information is not
recorded
Character sets should be specified using ISO standard names, or names in the following list. Note that PGS
support for character sets is evolving and may vary depending on the particular systems a customer uses -
testing is recommended to verify support for any particular application’s use of any of these (including UTF-8).
US-ASCII
ISO-8859-1
SHIFT-JIS
EUC-JP
EUC-KR
US-ASCII
ISO-8859-1
ISO-8859-1
BIG5
GB2312
KS_C_5601-1987
UTF-8
ISO-2022-JP
ISO-2022-KR
ISO-2022-CN
ISO-8859-2
ISO-8859-3
ISO-8859-4
ISO-8859-5
ISO-8859-6
ISO-8859-7
ISO-8859-8
ISO-8859-9
ISO-8859-10
ISO-8859-13
ISO-8859-14
ISO-8859-15

1.5.1 Document Character Sets


The Document element (see 1.5.4) allows a character set to be specified for the document. When it also
contains the actual document (using a DocData element) the document may appear in ‘text’ or ‘base64’ format.
If it appears as ‘text’, it must conform to the character encoding used for the whole XML document. If a
different character set is specified, Premiere Connect will attempt to convert the document to the specified
character set. If it appears as ‘base64’, or if the document is specified using one of the alternatives to DocData,
it will be assumed to already be in the specified character set.

1.5.2 Field Character Sets


Certain PGS data fields (FAXTO, FAXFROM, ATT, INSERTn) associated with jobs and destinations may be
represented in specific character sets, and have that character set information stored with them These fields are
now accessible as EncodableStringType in the schema, which includes an attribute “b64charset”. The value
of the field must be supplied in base64-encoded form, and the b64charset attribute specifies the character set the
data is actually in. A special b64charset value “binary” simply specifies that no character set or conversion is to
be used on the data – after being decoded from base64, the data is used as is.

Premiere Global Services Confidential & Proprietary 5


Common Element Descriptions

In fact, due to its generality, the schema allows other fields to be specified with character set information, but
for all but those mentioned above; the Premiere Connect will store them as supplied in their indicated
character set. The character set information may not be available during later processing, which may lead to
some conversion inconsistencies.
Some fields (REF, BILLCODE, CREF) have historically been used to hold data in special character sets,
although the character set information is not stored with them. If values for these fields are supplied with the
“binary” value for the b64charset, the data will be stored as is after decoding from base64. If an actual
character set is specified, they will be stored in the supplied character set, although the character set information
will not be available later.
REF is a little different from the other fields since it is generally an attribute. For this field, the alternative
“refb64” attribute has been added to permit entry of arbitrary data – the value must be base64 encoded, and
(after decoding from base64) it will be passed to the system without further conversion.
The value of the b64charset attribute must be a “standard name” (as described above) or value “binary”. These
values are not enforced by the schema, and testing is advised to confirm support for any particular application.
Examples on how to encapsulate encoding and character-set support with the given fields are given below:-
Examples:

Remarks

<To>abcde</To> stored as UTF-8

<To b64charset=”SHIFT-JIS”>YWJjZGU=</To> b64-decoded, ^A encoded

<To b64charset=”binary”>YWJjZGU=</To> b64-decoded, stored without conversion or


^A-encoding
<BillingCode b64charset=”SHIFT-JIS”>YWJjZGU=</BillingCode> b64-decoded, stored without conversion

<BillingCode b64charset=”binary”>YWJjZGU=</BillingCode> b64-decoded, stored without conversion or


^A-encoding
<Property name=”Phone” b64charset=”SHIFT-JIS”>YWJjZGU=</Property> stored without conversion (Phone not ^A-
able)
<Property name=”Phone” b64charset=”binary”>YWJjZGU=</Property> b64-decoded, stored without conversion or
^A-encoding

Note that “ref” is currently an attribute on various destination types. In order to permit the use of arbitrary ref
values, an alternative “refb64” attribute is available which will contain base64-encoded data, equivalent to the
values using a “binary” b64charset. If both “ref” and “refb64” are present, the “refb64” value will be used.

1.5.3 Table Data


Destination data may be submitted as a Table for list create and job submit functions. A Table is essentially a
Document containing a CSV or Excel file. No special provision for character sets has been implemented for
Excel files, but the CharacterSet may be significant for CSV files. The data will be read from the file assuming
that it is in the specified character set. The default behavior is to store the data without conversion from the
indicated character set. Some fields, (FAXTO, FAXFROM, ATT, INSERTn), will be stored along with the
character set information. To accommodate the fields (REF, BILLCODE, CREF) which have been historically
used to hold other data, the Table/FieldMapping/Map element can specify, with the IsBase64Encoded tag, that a

Premiere Global Services Confidential & Proprietary 6


Common Element Descriptions

column contains base64-encoded data (written in the Document’s character set), which will be base64-decoded
and used without further conversion – this is analogous to the ‘b64charset=”binary”’ behavior for the XML
representation of destinations.

1.5.4 List and Object Names


Due to legacy considerations, list and object names may be stored on PGS systems in various character sets, and
the character set information is not available. This may present some issues for both input and output when
using PremiereConnect, especially if PremiereConnect is not the only access method used, or if legacy data
must be accessed.
Ordinary text data in an XML document is normally in Unicode (UTF-8, typically). When names are received
this way by PremiereConnect, an attempt is made to locate a corresponding object with a name that matches the
input value, taking into consideration the switch, domain settings, and the user’s profile character set.
For output, an attempt is made to interpret names found and represent them with an accurate conversion in the
result XML.
In both of the above cases, there may be rare cases where data is misinterpreted, or cannot be represented in the
result.
In many cases, the PremiereConnect schema allows for base-64 encoded representations of names, and when
these are available, this is used as a last resort in order to transmit the information. When this is not available,
data that cannot be converted may be altered (the Unicode character 0xFFFD being substituted for
unrecognizable data).

Premiere Global Services Confidential & Proprietary 7


Common Element Descriptions

1.6 Document and DocData


A Document represents a single document, along with information about the document. It does not indicate
how the document is to be used. Note that the DocData element is actually a type that is used in other
situations where a document is transferred. Also note that most kinds of documents will need to be base64-
encoded for inclusion in the XML requests.

Tag Name # Description


Document
attribute ref 0-1 This is an arbitrary string that may be used to identify and refer to the
document in other parts of a request, for example, a Message element in a
JobSubmitRequest may use a Document in a DocumentSet via a
DocRef child element. To be used in this way, the ref attribute must be
present and must be unique within a Premiere Connect request body
DocType 1 Indicates the format of the document. There are a limited number of legal
values. The Service Request Processor (SRP) will determine if the
document indicated for any particular use is of an appropriate type, and
generate an error response (at the message level) if it is not. Legal types
currently are:
Value Description
Text data to be treated as text

XMF XMF input

TIFF Tagged Image File Format input

XAR Standard UNIX ar archive

PS PostScript

PCL HP Printer Control Language

PDF Adobe Portable Document Format

MSW Microsoft Word

WAV WAV/RIFF audio data

RTF Rich Text Format

XLS Microsoft Excel Spreadsheet

HTML Hyper Text Markup Language

HTMLLITE The simplified version of Hyper Text Markup


Language (aimed at AOL recipients)
Unspec In some cases the file format is unimportant, e.g.
for e-mail attachments.
GIF GIF image file (available with Premiere Connect
1.2)
JPEG JPEG image file (available with Premiere Connect
1.2)
PPT PowerPoint document

BMP .bmp image

VSD Visio document

Premiere Global Services Confidential & Proprietary 8


Common Element Descriptions

PUB Microsoft Publisher document

MPP Microsoft Project file

Empty document with no content

Filename 0-1 This contains a string to be used wherever the filename of the document may
be required. It is not necessarily the actual name of any file that contains the
document. In general, the document type will be determined by the
DocType value, but for some email processing, the extension part of the
Filename value may be used to determine MIME types.
c DocData 1 This choice is used to contain the actual document contents.
h attribute format 1 Indicates the format of the data in the XML and may have one of these
o values:

i text if the document is present as plain text, or


base64 if it is present as base-64 encoded data
c
(base64 is likely to be the most common)
e
DocCfs 1 This choice is used to refer to a document in the Customer File Store that is
to be the source of the document. Premiere Connect will be responsible for
retrieving the document from the CFS in order to submit it with a job.
DocUrl 1 This choice is used to refer to a document via a URL which Premiere
Connect should use to retrieve the actual document. Premiere Connect will
be responsible for retrieving the document in order to submit it with a job.
(Beware of possible access difficulties.)
SosObject 1 This choice is used to refer to a document stored as a Stored Object

attribute sosType 1 Indicates the stored object type. Currently supported stored object types are:
tts Text-to-Speech template
vcs Voice Control Script
attribute ownershipLevel 0-1 Optional attribute indicating the ownership level of the stored object.
Currently supported levels are:
user the stored object belongs to the user
customer the stored object belongs to the customer;
group the stored object belongs to the group
system the stored object is available to everyone.
CharacterSet 0-1 The ISO name of the character set used by the document

Premiere Global Services Confidential & Proprietary 9


Common Element Descriptions

1.7 DestinationType
Elements of type DestinationType describe a simple delivery destination, and are used where most of the
extensions and auxiliary information available for primary deliveries (as in the DeliveryItem types) are not
applicable. Not all of the defined destination types may be actually supported for any particular element of type
DestinationType.

Name # Description
type DestinationType The value of an element of this type is the actual address, for
example, the phone number when the type attribute is fax.
attribute type 1 Specifies the type of destination and must be one of the following:
fax
internet
mbox
x400
telex
cablegram
mailgram
ddd
dedLine
softswitch
voice
sms
fod
list
smQuery

Premiere Global Services Confidential & Proprietary 10


Common Element Descriptions

1.8 DeliveryItem
The schema representing the destination address for delivery of messages or reports is somewhat convoluted,
and represents a hierarchy of types which introduce certain additional elements with each layer. This diagram
illustrates this hierarchy of types.

DeliveryItemType
adds attribute ref
attribute refb64

DeliveryItemSimpleType
adds child Alternate

DeliveryItemComplexType
adds child InsertList
child Extension

FaxType
InternetType
VoiceType
DeliveryItemGenericType

MboxType
TelexType
FodType
SmsType

DeliveryItemContainerType

ListType
SmQueryType
TableType

Then, a catch-all type is defined DeliveryItemListType, which represents one or more elements of any
of the 11 final types of destination, and is used in several places where a set of destinations is required. Note
that DeliveryItemListType designates a set of destinations, not necessarily just one. Also note that

Premiere Global Services Confidential & Proprietary 11


Common Element Descriptions

DeliveryItemListType is a type, and therefore does not itself directly appear in an XML document –
there would instead be one or more of the final destination types described in this section.
There are some restrictions on destinations appearing in Alternate elements, due to the internal
representation of lists. Alternates cannot contain InsertList elements or Extension elements that
include segments other than the default segment.
It should be noted that the XML representation of destinations is not used by PGS systems internally. Since the
XML supports, in most cases, a variety of ways to represent the data, a destination retrieved from the system
may not match exactly the XML format that was originally supplied.
Each of the 11 final types is described here as they appear in their final form.

1.8.1 Fax
The Fax destination represents a fax number, and is suitable for a Message with FaxOptions.

Tag Name # Description


Fax
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

InsertList 0-1 Insert values. See 1.8.13

Extension 0-1 Generic destination extensions. See 1.8.14

Phone 1 Fax phone number

Att 0-1 Attention – maps to the $ATT macro on a fax coversheet or bannerfx.
(EncodableStringType; see Section 1.5.2)
From 0-1 Sender identification – maps to the $FROM macro on a fax coversheet or
bannerfx. (EncodableStringType; see Section 1.5.2)
To 0-1 Recipient identification – maps to the $TO macro on a fax coversheet or
bannerfx. (EncodableStringType; see Section 1.5.2)
Salutation 0-1 Salutation – maps to the $SALUTATION_TEXT macro on a fax coversheet or
bannerfx

Premiere Global Services Confidential & Proprietary 12


Common Element Descriptions

1.8.2 Internet
The Internet destination represents an email address, and is suitable for a Message with EmailOptions
or EnhancedEmailOptions.

Tag Name # Description


Internet
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

InsertList 0-1 Insert values. See 1.8.13

Extension 0-1 Generic destination extensions. See 1.8.14

Email 1 Email address

Subject 0-1 Message subject. (EncodableStringType; see Section 1.5.2)

From 0-1 Sender identification. (EncodableStringType; see Section 1.5.2)

Eformat 0-1 Indicates data format this recipient prefers for email messages. Valid values
are:
text
html
htmllite (for AOL)
default
Password 0-1 Password recipient must use to obtain access to the pull attachments. Only
applicable for EnhancedEmail.

1.8.3 Voice
The Voice destination represents a phone number for delivery of a voice message, and is suitable for a
Message with VoiceOptions.

Tag Name # Description


Voice
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

InsertList 0-1 Insert values. See 1.8.13

Extension 0-1 Generic destination extensions. See 1.8.14

Phone 1 Phone number

Premiere Global Services Confidential & Proprietary 13


Common Element Descriptions

1.8.4 DeliveryItemGeneric
The DeliveryItemGeneric destination may be used to represent any kind of destination, including those
types for which a more specific XML type is not defined. Using this element allows for a uniform structure, but
reduces the ability to automatically validate the XML and requires greater care when specifying auxiliary data,
since the Extension element must be used, and a knowledge of the legal destination header keywords is
required.

Tag Name # Description


DeliveryItemGeneric
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
attribute type 1 Required attribute indicates the type of address. Legal values are:
internet mbox x400
telex cablegram mailgram
ddd dedLine softswitch
voice sms fod
list smQuery fax
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

InsertList 0-1 Insert values. See 1.8.13

Extension 0-1 Generic destination extensions. See 1.8.14

Address 1 The address itself, e.g. phone number or email address. This should be
consistent with the address type specified in the type attribute.

1.8.5 Mbox
The Mbox destination represents a switch-supported mailbox address. This type of destination is most likely to
be useful for report addresses.

Tag Name # Description


Mbox
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

UserId 1 The user id to whom the destination mailbox belongs.

Premiere Global Services Confidential & Proprietary 14


Common Element Descriptions

1.8.6 Telex
The Telex destination represents a telex destination.

Tag Name # Description


Telex
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

Number 1 The telex number.

1.8.7 Fod
The Fod destination represents a delivery to a Fax-On-Demand repository in the switch.

Tag Name # Description


Fod
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

Address 1 The FOD destination.

1.8.8 Sms
The Sms destination represents a delivery to a SMS (text message) destination. Note that the availability of
SMS delivery through your Premiere system should be checked before attempting to use this.

Tag Name # Description


Sms
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
Alternate 0-1 Alternate destination if this one fails. See 1.8.12

Phone 1 The destination phone number.

Premiere Global Services Confidential & Proprietary 15


Common Element Descriptions

1.8.9 List
The List destination represents a list stored on the switch. Note that there are multiple list stores, and which
one is used will be determined by the switch handling the specific message. This is determined by which option
set is specified in JobOptions (FaxOptions, EmailOptions, VoiceOptions, MailMergeFaxOptions indicate the
use of an XDDS switch (faxREACH®); EnhancedEmailOptions and SmsOptions indicate the use of a MR
switch (messageREACH®).)

Tag Name # Description


List
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
attribute 0-1 Indicates the ownership level of the list, which may be necessary to
ownershipLevel disambiguate the name. Legal values are:
user
customer
group
system
This attribute is required if the Name does not indicate the ownership level.
Name 1 The name of the list.

1.8.10 SmQuery
The SmQuery destination represents a prepared query of Subscription Management data. Arrangements for the
use of Subscription Management and definition of the query must be made in advance.

Tag Name # Description


SmQuery
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
attribute 0-1 Indicates the ownership level of the query, which is generally required. Legal
ownershipLevel values are:
user
customer
group
system
Name 1 The name of the query.

Premiere Global Services Confidential & Proprietary 16


Common Element Descriptions

1.8.11 Table
A Table destination allows a set of destinations to be specified in the form of Comma Separated Value (CSV)
data, or an Excel (XLS) file. The table data must contain a first row of column names, and the column names
can be mapped to specific destination values.

Tag Name # Description


Table
attribute ref 0-1 Identifier for this destination. This can appear on reports, and should generally
be kept short.
attribute refb64 0-1 Attribute defining the characteristic of Character-set of the contained data/value,
and the way it will be handled in the system. For more detail See Section 1.5.2
FieldMapping 0-1 This element allows an explicit mapping to be made between the columns in the
table data and properties (keywords) in the address data.
If this element is omitted, the default mapping shown below is used.
Map 1- This element maps one column label to a specific address keyword. There
should be one Map element for each mapped column.
Columns with labels not found in the mapping will be added to a segment
“CSV”, with keywords corresponding to the column name.
FieldName 1 The column label or name in the table data that is to be mapped to an address
property
SegmentName 0-1 The segment of the address information (header) that will contain the property
being mapped to. If not specified, the default “USER” segment will be used.
PropertyName 1 The property (keyword) name of the address that will contain the values found
in this column.
Property names must be compatible with PGS “hdr” format. They may not
contain spaces, quotes, or colons. In general, hdr keywords are not excessively
long, and consist of ASCII letters, digits, and underscore. Certain special uses
allow a “[n]” suffix. Please consult with PGS before using Property, especially
in the “USER” segment.
IsBase64Encoded 0-1 Boolean Value. Defines the way data will be handled in the system. For more
detail See Section 1.5.2.
c DocRef can be used to refer to a Document present elsewhere in the request.
DocRef 1
h A Document will be looked for whose ref attributes matches the value of this
o element. See below for rules concerning the content and type of the
i Document.
c
Document 1 This is used to embed the table data directly in the Table element. See 1.5 for
e details of the Document structure.
If the document is a CSV file, the DocType must have the value text. If the
document is an Excel file, the DocType must have the value XLS.

If no FieldMapping is present, the following table shows the mapping that will be applied. Columns with
labels not found in the mapping will be added to a segment “CSV”, with property keywords corresponding to
the column name. The effective property keyword (whether determined through FieldMapping/PropertyName
or through this default “CSV” segment) should be compatible with internal PGS “hdr” format described above.
A non-compliant name will not necessarily generate an error, but the data may not be subsequently accessible.
(Some provision exists to allow non-compliant names in a Table used for a JobSubmit request specifying
MailMergeOptions.)

Premiere Global Services Confidential & Proprietary 17


Common Element Descriptions

Field Segment Keyword Description


(Column)
name
Delivery address
ADDR USER TO
Address type. Legal values are:
TYPE USER ADDR_TYPE
internet mbox x400
telex cablegram mailgram
ddd dedLine
softswitch
voice sms fod
list smQuery fax

Fax pilot line text.


HEADER USER FAXHDR
Customer reference. Must be unique within the table.
REF USER REF
Replaces $TO macro on the fax cover page.
TO USER FAXTO
Replaces the $FROM macro on the fax cover page.
FROM USER FAXFROM
Message subject for this recipient.
SUBJECT USER ATT
Recipient-specific password for the messageREACH® pull
PASSWORD USER PASSWORD
attachments.
The email format to use when sending email to this recipient.
EFORMAT USER EFORMAT
Currently recognized values are: html, htmllite, text.
Alternate delivery address.
ALTADDR ALT TO
The type of the alternate delivery address.
ALTTYPE ALT ADDR_TYPE
Inserts used for the message customization.
INS_N INSERTS INSERT[N]

A Table must always have a mapping to the USER:TO keyword. If no column is mapped to the keyword
USER:ADDR_TYPE, then the value “fax” will be assumed.
Multiple columns should not be mapped to the same keyword.
Certain keyword values (such as FAXFROM and ATT) exist as single elements, which may contain multi-line
values. Some PGS interfaces might accept and return these multi-line values as separate CSV fields, but
PremiereConnect does not support this format in order to maintain internally consistent handling of all fields.
This should not be confused with fields (like the INSERT fields) that exist as multiple separate elements.
PremiereConnect accepts and returns these as separate fields.

1.8.12 Alternate
The Alternate element is an optional child of several of the above destination types. It contains another
destination, to which delivery may be attempted if delivery to the parent destination is unsuccessful. Note that
the destination in the Alternate may in turn have an Alternate, creating a series of backup destinations
(maximum depth 16). In general, an Alternate should be of the same type of destination as the parent (e.g.
fax alternate for a fax destination), since document types and options for different sorts of destinations are
unlikely to be compatible. An Alternate address is somewhat restricted, due to the internal representation of
address data, in that it may not contain insert data, or properties in any segment other than the default (“USER”)
segment

Tag Name # Description


Alternate
c Fax 1 A Fax destination – see 1.8.1

h Internet 1 An Internet destination – see 0

Premiere Global Services Confidential & Proprietary 18


Common Element Descriptions

o Voice 1 A Voice destination – see 1.8.3

i Fod 1 A Fod destination – see 1.8.7

c Mbox 1 A Mbox destination – see 1.8.5


e Sms 1 A Sms destination – see 1.8.8

Telex 1 A Telex destination – see 1.8.6

DeliveryItemGeneric 1 A DeliveryItemGeneric destination – see 1.8.4

1.8.13 InsertList
The InsertList element is an optional child of several of the above destination types. It contains one or
more Insert elements, whose values are treated as text strings that may be used by certain switch features to
personalize documents.
Tag Name # Description
InsertList
Insert 1- The content of this element is the string value used as the insert

attribute number 1 Each Insert should have a unique number, usually starting with 1. The
document features that call on these values refers to them by this number.
attribute 0-1 Attribute defining the characteristic of Character-set of the contained
b64charset data/value, and the way it will be handled in the system. For more detail See
Section 1.5.2.

1.8.14 Extension
The Extension element is an optional child of several of the above destination types. Its purpose is to
provide a general mechanism to insert additional keywords in the destination as represented in the service,
which may be useful if a user requires non-standard features. The Extension element should ONLY use
values that have been discussed with and approved by Premiere Global Services’ organization.

Tag Name # Description


Extension
Segment 1- Each property exists in a “segment”

attribute name 0-1 The name of the segment for this property. If name is not specified, the
default “USER” segment is used.
Property 1- The value of this element will be the value stored in the property (keyword)

attribute name 0-1 This attribute specifies the property name (keyword). Although the schema
shows this as optional, in practice it will be required.
Property names must be compatible with PGS “hdr” format. They may not
contain spaces, quotes, or colons. In general, hdr keywords are not
excessively long, and consist of ASCII letters, digits, and underscore. Certain
special uses allow a “[n]” suffix. Please consult with PGS before using
Property, especially in the “USER” segment.
attribute 0-1 Attribute defining the characteristic of Character-set of the contained
b64charset data/value, and the way it will be handled in the system. For more detail See
Section 1.5.2

Premiere Global Services Confidential & Proprietary 19


Common Element Descriptions

1.9 Stored Objects


1.9.1 StoredObjectId
A variety of data objects are stored in the PGS system as “stored objects”. A StoredObjectId represents
the data necessary to identify a particular stored object.

Tag Name # Description


StoredObjectId
attribute objKind 1 The type of object. These are not case-sensitive. Legal values are:
textBlock
rmBlock
emailBody
emailSubject
cancellationNotice
letterhead
bannerfx
logo
rpttmplt_col
sos_tts
vscript
mmcover
emailDisclaimerBlock
systemData
attribute ownership 0-1 This indicates the level of ownership (and therefore the visibility) of the stored
objects. Values are:
user
group
customer
domain
If not specified it would generally mean user ownership.
attribute groupName 0-1 Specifies the user’s primary Fax2Mail “group name”.
attribute groupNo 0-1 Specifies the user’s primary Fax2Mail group number.
attribute b64charset 0-1 Attribute defining the characteristic of Character-set of the contained data/value, and
the way it will be handled in the system. For more detail See Section 1.5.2.

Premiere Global Services Confidential & Proprietary 20


Common Element Descriptions

1.9.2 Stored Object Functions


PremiereConnect currently supports these operations on stored objects, subject in some cases to ownership level
restrictions:

Stored Object PremiereConnect Functions


Type
Create List Retrieve Delete
TextBlock TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

RmBlock TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

EmailBody TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

EmailSubject TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

CancellationNotice TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

Letterhead StoredObjectList

BannerFx StoredObjectList

Logo StoredObjectList

Report Templates StoredObjectList

Text-to-speech TTSObjectCreate StoredObjectList TTSRetrieve StoredObjectDelete


templates
VoiceScripts VoiceScriptCreate StoredObjectList VoiceScriptRetrieve StoredObjectDelete

MailMerge cover MMCoverSheetCreate StoredObjectList MMCoverSheetRetriev StoredObjectDelete


sheets e

EmailDisclaimer TextBlockCreate StoredObjectList TextBlockRetrieve StoredObjectDelete

F2M Email Filtering F2MFilteringRulesCre F2MFilteringRulesRe StoredObjectDelete


Rules ate trieve

In addition, TTSObjectPreview and MMCoverSheetPreview functions allow for the generation of a


preview of text-to-speech templates or mailmerge coversheets – either stored in the system or based on data in
the request.

Premiere Global Services Confidential & Proprietary 21


Common Element Descriptions

1.10 DocumentInfo
Used in the VoiceScript functions, this is used to represent a wave file stored either as a SOS object or as a file.

Tag Name # Description


DocumentInfo
DocType 1 This should be of type WAV only, else an application level error would be
returned back.
c SosObject 1 This choice is used to refer to a document stored as a Stored Object.
h
o attribute sosType 1 Indicates the stored object type. Currently supported stored object types
i are:

c tts Text-to-Speech template


vcs Voice Control Script
e
attribute ownershipLevel 0-1 Optional attribute indicating the ownership level of the stored object.
Currently supported levels are:
user the stored object belongs to the user
customer the stored object belongs to the customer;
group the stored object belongs to the group
domain the stored object is available to everyone.
Filename 1 Filename of the wave file.

Premiere Global Services Confidential & Proprietary 22


Common Element Descriptions

1.11 Branching
Used in the VoiceScript functions, this is one of the elements that may appear inside any of the Transaction
elements. This element is used to provide a condition based on input from the user. Branching determines the
next transaction to present to the user based on the recipient's input. Branching is used to create complex scripts.
It allows for different paths through the script based upon a recipient response or interaction with the call flow.
Branching can be directed, based upon a parameter, (such as a pressed key, or some value), to go to a specific
transaction.
For a simple, linear script, the Branching element would not be used.

Tag Name # Description


Branching
Condition 0-1 This is a string specifying the condition to be applied for this branch.
Legal values are: equals, notequals, lessthan, greaterthan.
InputKey 0-1 This is the user input key to which the condition will be applied to, while
taking the branch decision.

c GoToTransactionID 1 This choice gives the transaction ID that will be presented to the
user when this branch condition is satisfied.
h
o GoToTransaction 1 This choice gives the transaction name to which the call will flow
i when this branch condition is satisfied.

c
e
e

1.12 BlockAddressRecStatusType
An AddressBlockAdd/AddressBlockDelete request can contain multiple addresses to block/unblock. The
AddressBlockRecStatustype element contains the status of each addressblocks specified in Add/Delete request.

Tag Name # Description


AddressBlockRecStatusType
RecStatus 1 The status of this particular record. See 1.2.

C BlockAddress 1 The address that was requested to be blocked/ unblocked. See 1.13
h DomainBlockAddress 1 The domain name which needs to be blocked. This is only applicable to
internet domain names only. E.g abc.com. so any internet address going to
o this domain will be blocked.
i
c
e

Premiere Global Services Confidential & Proprietary 23


Common Element Descriptions

1.13 BlockDestinationType
This element specifies the address to be blocked/ unblocked.
TagName # Description
BlockDestinationType The Address to be blocked or unblocked.

attribute type 0-1 The type of address. The possible values are
fax
internet
mbox
x400
telex
cablegram
mailgram
ddd
dedLine
softswitch
voice
sms
fod
list (not currently supported)
smQuery (not currently supported)
ANI
Though all the aforementioned values are “legal” as a part of XML request, but
the highlighted address types (list and SmQuery) are not supported as of now.
attribute 0-1 Whether the address given in the request is already normalized or not. If this
normalized attribute is false, the service will normalize the address before putting it to the
database.

1.14 RulesType
F2M Email Filtering Rules are stored in the PGS system as “F2M_ADMIN_MAIL_FILTERING_RULE”
stored object. The RulesType represent the data that will form the content of this stored object.

Tag Name # Description


RulesType
Rule 1- This represents a Rule to be applied to filter the emails received by an F2M admin.

Conditional 1- This represents a Condition of the Rule.

Attribute 1 What the condition is applied to. These are case-sensitive. Legal values are:
MatchAgainst Subject
From
True
When “True” the “Condition” and “MatchCase” attributes have no
significance and if provided would be simply ignored when the rules are applied.
Attribute 0-1 How the condition is applied. These are case-sensitive. Legal values are:
Condition IsEqualTo
IsNotEqualTo
Contains
DoesNotContain
StartsWith
DoesNotStartWith
EndsWith
DoesNotEndtWith
IsMissingOrBlank

Premiere Global Services Confidential & Proprietary 24


Common Element Descriptions

IsNotMissingOrBlank

Attribute 0-1 Boolean value indicating whether the case of the “Conditional” value should be
MatchCase considered or no when the rules are applied.
Action 1 This represents the Action that should be taken if all the conditional statements are
met. Legal values are:
forward
delete
EmailAddress 0- When the “Action” value is forward, these are the email addresses that the mails
will be forwarded to.

1.15 TransactionInfo
This element will provide the Transaction Information of a job.

Tag Name # Description


TransactionInfo 0 Transaction Information.
0 %FAXIN_LOG:ETIME value from job header.
Etime
0 %FAXIN_LOG:CONNECT_TIME value from job header.
Connect_Time
0 %FAXIN_LOG:BAUD_RATE value from job header.
Baud_Rate
0 %FAXIN_LOG:PAGE_COUNT value from job header.
Page_Count
0 %FAXIN_LOG:FAXIN_ID value from job header.
Faxin_Id
0 %FAXIN_LOG:FAX_ID value from job header.
FaxId
0 %FAXIN_LOG:ANI value from job header.
Ani
Dnis 0 %FAXIN_LOG:DNIS value from job header.

1.16 DocumentInformation
This element will provide the actual information of the document of a job..

Tag Name # Description


DocumentInfo
JobDocumentType 0 This element will represent the type of Document.
DocumentNumber 0 Document number and domain.
XDN 1 Domain from which document is being retrieved.
DocNo 1 Document Number.
Filename 0 Filename of the document.
CharacterSet 0 CharacterSet of Document.
DocType 0 Format of Document(i.e Pdf, xar, html….)
DocumentInfoExtension 0 More information about document if asked by user. See section 1.8.14
FileData 1 Actual data of document.

Premiere Global Services Confidential & Proprietary 25

Potrebbero piacerti anche