Copyright (C) 2008-2010, Cable Television Laboratories, Inc. SaFI Campaign Information Package Interface, XML Schema, Release Version 2.0.0. CIP root element Element for Read message. ContextId will be returned in the ReadResponse data that corresponds to this query. Response for Read message. ContextId matches ReadRequest. Distributes (pushes) one or more updates to campaign data. ContextId will be returned in UpdateResponse, provides transaction traceability. Response to the Campaign update identified contextId. Element for SetRegistration message. Identifies target URL, boolean Active sets as enabled or disabled (by Active value) for distributions. For both operations, if the syscode set is empty the entire set of syscodes predefined for the subscriber (via some out unspecified mechanism) is implied. Response for SetRegistration message. Note that if any syscode of an enabled registration is already registered to another Subscriber the registration fails. In this case a reponse of "NOTOK" with a reason of "Syscode not Unique" will be returned, and the text will contain a space-delimited list of the errored syscode(s). Element for GetRegistration message. Identifies target URL of query and requests the list of syscodes active at that URL. Response for GetRegistration message. Identifies target URL and a list of syscodes that are currently enabled. Contents of fault on Read Request. Use Metadata 3.0 asset identifier here

These pairs define metadata elements whose value must match that provided to enable placement of the asset

This supplies the detail of an asset that is part of the placement.

Note that an AssetReferenceType contains a RecordIdAttributeGroupOpt, but no RecordStatusAttributeGroup. Consequently an AssetReferenceType is a reportable CIP node, but is not an independent revision group. Rather it is a contained member of its parent revision. If no PEID is present in the AssetReferenceType it is inherited from the parent Placement. The Epsid is required always required.

The key-value sets may be used to describe any metadata that might be needed to be attached to the asset such as the PAID of the creative

The assetType identifies the family of the asset, which enables some interpretations of the asset structure without reference to the metadata

A boolean qualifier expression that is defined for a bundle and evaluated for each placement of the bundle. Multipe qualifiers represent enclosed expressions, and are combined with the condition operator.

Qualifier is an enclosed expression

Condition is the binary boolean operator used to combine the qualifiers

A guid is a general purpose UUID. Guids are always defined with this type, which provides an alternative meaningful human readable name

A container for campaign placement data for a single MSO. The container will contain placements for one or more campaigns.

The SysOrder list holds campaign placements by syscode within the MSO

The name is a standardized name of the MSO

The definition of a specific placement within a bundle.

The Placement is uniquely identified by the PEID+EPSID in the RecordIdAttributeGroupOpt. Note a missing PEID is defaulted to be that of the parent Bundle. Since Placement also has a RecordStatusAttributeGroup it is an updateable element. All Placements with a single PEID+EPSID comprise one revision group, of which only zero or one will be valid at any time. The document order will have them as adjacent elements in decreasing revision number order.

The AssetReference list is a list of the components of this placement.

The list of QualifierGroups define qualifier expressions that must be satisified for this specific placement. The multiple groups are always 'and'ed, so this placement occurs only if each group is individually true. If there are common qualifier groups defined for the placement's bundle, they are also and'ed with these groups.

The ProductFamily identifies the type of ad unit being expressed. The interpretation of this element is conditioned by the ProductFamily. This field is optional, and will be missing if the placement productFamily does not need further qualification.

If this element contains an ApplicationDefinitionAttributeGroup it describes an enhanced asset. If there is no associated placed media, it describes an application only, which enhances the target directly. If there are also AssetReferences to placed media, the enhancement applies to those media.

If this element contains an ApplicationDefinitionAttributeGroup and includes one or more CoDF or CoDF data AssetReferences, it is describing an application placement that is to be performed on the target asset, possibly in conjunction with a media placement. When there is no CoDF or CoDF data AssetReferences this is a description of an enhancement that has been made externally, and is only present to inform plant management and return data processing.

Category is an optional field that labels this placement's category with for the benefit of later placements

TrickMode can be used to describe the permitted trick modes during a VOD media playout

Priority is a placeholder for further business terms. In the mean time it is passed to the placement decision owner for interpretation.

This contains the definition of a set of placements in a specific campaign at an indicated MSO and syscode. The relation between the placements that forms the basis of a bundle is out of scope for this specification. Each placement of the bundle is evaluated independently except for the specifically defined interactions with attributes of the bundle or atomic groups within the bundle.

A Placement is uniquely identified by the PEID+EPSID in the RecordIdAttributeGroupReq. Since it also has a RecordStatusAttributeGroup it is an updateable element. All placements with the same PEID+EPSID define one revision group, of which only zero or one will be valid at any time. If the document has multiple revisions of one group, the document will contain them as adjacent elements in decreasing revision number order.

The list of CommonQualifierGroups define qualifier expressions that must be satisified for this placement. The multiple groups are always 'and'ed, so the placement occurs only if each group is individually true.

If the placement evalutes to true, each contained placement is inidividually evaluated and may or may not participate in the placement instance.

A boolean qualifier expression that is evaluated for a placement that is and'ed with the bundle's commonQualfier groups. Multiple qualifiers within the group are enclosed expressions, and are combined with the condition operator.

Qualifier supplies an enclosed expression

condition is the binary boolean operator used to combine the enclosed expressions

Set of one or more boolean terms that are always 'and'ed

An individual boolean qualifier term, which is a binary boolean operation. The qualifier and namespace select a data element known to the evaluation environment which compares the current value of that element with the value supplied in the expression. The comparison is subject to the semantics of the qualifier's datatype, and the comparison operation is defined by the operation.

namespace is a value from a predefined set of namespaces which have implementions in each execution environment.

qualifier is a predefined name within the identified namespace

operation is binary boolean operator describing a required relation for this qualifier. The current actual value of the qualifier name in the implementation environment is the right operand for that operator.

value is the left operand of the defined boolean operator.

The Contact list provides one or more contacts identified to provide operational assistance. Contact roles can help in selecting the correct contact.

A System Order provides a container for campaign placement data at a single syscode within one MSO.

The operational instructions are defined by an unordered series of bundles.

This identifies an application message template repository. AppMessageRuleSetType select specific rule sets in the repository. This identifies a completely defined set of application messages that may be issued by an application. It is a key to access the record set in the application message template repository. Defines the appplication of an asset reference.

Validate means insure a prflight that the asset is present as defined

place means this asset is part of the placement response data set, but does not get preflight validation

valAndPlace means the asset should be validate at preflight, and is also a part of the placement response data set.

This contains an XPath Reference into an asset-specific metadata document confroming to an approved schema This contains the value that must be matched by an asset-specific metadata document at the key's Xpath. This identifies the kind of asset defined in a reference. It enables some decisions about the asset structures prior to, or without requiring examination of, the metadata structures. An identifier that labels a set of placements. All placements in a CIP with the same label string are part of an atomic group. All the placements in the group must be evaluated when any one is, and all must evaluate to true for any of the placments to be true.

The domain of an atomic group label is the placement in which it occurs.

The time the initial revision of the Campaign Information Package was created. The time this revision of the Campaign Information Package was created.

Campaign version number. The version number is incremented once if the campaign is changed after publication. After an increment the revision number can be retained until the next publication.

CIP documents with the same revision number are guranteed to contain the same data for each (MSO, SysCode) present. However, CIP document preparation may qualify the contents of a document, so that not all (MSO, SysCode) combinations are necessarily present in every document.

Category value for an inserted ad unit, similar to current linear usage. Note the value of an exclusion for category collisions depends on all placements providing a meaningful category(s). A set of boolean binary operators defined on qualifier terms with a group. The name of a contact available for issues with a campaign. The role in the campaign workflow represented by a contact. Value supplied in a message and echoed in the response to identify matched message sets. In the case of CampaignUpdate the contextId may also provide traceability to the update that created the message. Use of a UUID or similar unique identifier is recommended. Identifies the owner of the placement decision. The time this revision of the element was created. A revision number of an element, incremented each time any data is modified. No data within an identified element is changed without a new revision number. For each element with an ElementRevisionNumber, only the record with the highest revision number currently applies. All others records are present to permit processing in the presence of the asynchronous application of update data, but may also be of value in reconciliation or continuity.

The current status of the data model of an Element.

Pending (Pnd)- Data is present, but not an operationally complete or consistent set.

Committed (Com)- Data is present that is an operationally complete and consistent set (although not necessarily final. Data may be modified, even when active.)

Active - (Act) The data present is intended to be operational and the line item should be executed according to the contained parameters. This is a statement of intent, not the result of operational feedback.

Pause - (Pse) No presentations should be made based on this element. This is expected to be a temporary state that will return to Active, but may instead go to Windup.

Windup (Wnd) - All presentations of the line item should have ceased, but post-processing functions may continue.

Closed - (Cls) All activity with respect to the line item should be terminated.

The email address of a stewardship contact. Generic owner identifier ID. Identifiers MUST be unique within the namespace of their Identifier Owner. All identifier owners MUST be set to a registered Internet domain name or a qualified domain name that is rooted in a registered internet domain name belonging to the provider of the identifier. A Url directly addressed from applications for app fulfillment and service metrics messages. May be distinct from summary level url(s). Url for delivering processed reporting received on the primary url. This will be empty if no intermediate processing is defined (e.g., the Primary Url directly addressed the final data campaign level data sink). A unqiue name assigned to an MSO and present in all the MSO orders or queries for that MSO. A predfined value for a qualifier namespace. Each namespace holds a set of predefined names, each of which has a datatype and semantic definition. Binary operator defined on quailifier name-value pairs. The sematics of the operations are defined by the datatype assigned to the name. Accepts a percent value from 0 to 100 A placeholder for general business terms applied to a placement. Priorities are defined by a decision owner and those definitions must be honored in all placement decision processing that represents that owner. This is a predefined set of known product families defined by the afflilate. It is primarily used for preflight, monitoring, or other stewardship functions rather than execution decisions. A predefined name string in one of the qualifier namespaces. An external definition of the namespaces is to be found at ??? True indicates the containing record is deprecated. A higher revision may exist with the flag false representing more current data. There will be no record with the flag false if the record is deleted.

Describes the beginning of an application reporting window as a signed offset with respect to the start of a placement that inculdes an application.

Describes the end of an application reporting window as a signed offset with respect to the end of a placement that inculdes an application.

Describes the interval between reports for a placement. A value of zero indicates immediate reporting on each IAM occurance.

This identifies a complete application. It is a key to access the application characterization in the application repository. This will be an enumerated list of defined trick mode options Human-readable name associated with every UUID to allow meaningful communication. Should be chosen to have a very low probability of duplication, but uniqueness is neither required nor testable. A value to be tested in a qualifier returning a boolean result. The specific test to perform is identified by the operation type. The attribute set for characterizing an application. The repositoryAppKey characterizes an application according to the specification format, and the OrgID,AppID,version identify a specific expression of that repository template held in the application repository. AppId/orgId/appVer are a set, all present or absent. Either that set or appDataReverence or both must be present for the applicationDefinition to be valid. Describes one operational contact. Note one of phone or email is required Attribute group for all GUIDs The set of attributes that identify a specific CIP element as an independently reportable unit or identifying elements of a revision set. This group requires both the PEID and the Epsid. The group is only identifying a revision set if it occurs in conjunction with the RecordStatusAttributeGroup. The set of attributes that identify a specific CIP element as an independently reportable unit or identifying elements of a revision set. This group requires only the Epsid; The PEID can be inherited from a parent. The group is only identifying a revision set if it occurs in conjunction with the RecordStatusAttributeGroup. Group describing the currency of a document element and it's children. Any element with a RecordStatusAttributeGroup must also have a RecordIdAttributeGroupOpt. The elements of the revision set will be present in document order, sorted by decreasing revision number. Attribute group for most message result status Accepted Rejected although content valid Rejected because content invalid Defines data for a Notice operation. Indicates the recipient should fetch the referenced Cip. Defines selection criteria for a ReadRequest. A specific campaign is identified by GUID or gname or orderId+orderOwner, while orderOwner alone is all campaigns of the owner. Date selects CreateFrom LT CipCreateDate and LEQ CreateTo. Version omitted or zero returns latest version, else specific version identified, version -1 is all. A specific bundle may be requested by PEID, otherwise all are implied.