Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
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.
1.3 ListId
ListId: This represents the data necessary to identify a particular stored list.
1.4 JobId
JobId: This represents the data necessary to identify a job, or job group. It has the following immediate child
elements:
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
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.
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.
PS PostScript
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:
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
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
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
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.
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
1.8.2 Internet
The Internet destination represents an email address, and is suitable for a Message with EmailOptions
or EnhancedEmailOptions.
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.
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.
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.
1.8.6 Telex
The Telex destination represents a telex destination.
1.8.7 Fod
The Fod destination represents a delivery to a Fax-On-Demand repository in the switch.
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.
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®).)
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.
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.
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.)
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
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.
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
Letterhead StoredObjectList
BannerFx StoredObjectList
Logo StoredObjectList
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.
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.
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.
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
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.
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
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.
1.16 DocumentInformation
This element will provide the actual information of the document of a job..