Copyright (C) 2008-2009, Cable Television Laboratories, Inc. MSO Campaign Information Package Interface XML Schema Version I01. 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. 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, in most usage the current version is implied when omitted. 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 for reconciliation or continuity, but are not expected to be operable. 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. 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 time a broadcast Programming Event is schedule to start. For VOD products this is the time they become available on the server. The time a broadcast Programming Event is schedule to end. For VOD products this is the time they cease to be available on the server. The time domains related to a Programming Event 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. Generic owner identifier ID. Identifiers MUST be unique within the namespace of their Identifier Owner. 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). Human-readable contact phone, so may have extension, etc. Not expected to be machine processable Placeholder for business terms used by SCTE ADS or equivilent to choose amoung conflicting potential placements. This is a predefined set of known and approved enhanced product families. The family is used to direct the interpretation of CIP the data model for a specific placement directive. True indicates this record is deprecated. A higher revision will exist with the flag false. This identifies a complete application. It is a key to access the application characterization in the application repository. Row number is a unique identifier for a specific element in the hierarchy. For elements with a Row Number, revisions of the row will be issued, but once assigned the row number is never changed. If such a row is totally removed from the business context, but later is reinstated, the reinstatement will be assigned a new Line Item Number that is unrelated to the original, terminated number. [DVB - unreferenced!] Expression string appropriate for parent data domain and associated rule engine. Was an xs:string attributed named apRulAtr or smRulAtr in D01. The software engine that will be responsible for processing a rule set. Was named MsgProcessingEngineType and specific to message processing in D01. The "Undef" type generally cannot be processed in the absence of propritetary extensions to this specification. SyscodeListType is a white-space delimited list of syscodes A code for the timezone plan of the national feed. Values are: NATL - Aired simultaneously in all timezones from national feed, EMP - Aired with no delay in Eastern, local delay in Mountain, and Pacific zones, Central shares Eastern LCL - Aired with local delay in all time zones. 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. Global asset identifiers. Needs work to span all expected identifier domains Provider identification. For example, CableLabs ADI. Asset identification and may be scoped by Provider identification. For example, CableLabs ADI. The attribute set for characterizing an application. The repositoryAppKey characterized 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. Defines data for a Notice operation. Indicates the recipient should fetch the referenced Cip. Defines selection criteria for WDSL ReadOp. Must includeCreateFrom+CreateTo or GUID or gname or orderId+orderOwner. Date selects CreateFrom LT CipCreateDate and LEQ CreateTo so an interval is scanned by repeatedly setting CreateFrom = last returned CipCreateDate. Version omitted or zero returns latest version, else specific version identified. Attributes of application message processing rules. Describes one operational contact. Note one of phone or email is required Attributes applied to one Flight. Describes the window in which the presentation is scheduled as a begin/end, and also the window in which responses are accepted as a begin/end. Also a TimeZoneCode that indicates what flexibility exists in the flight times. Attribute group for all GUIDs Attribute group for most message result status Accepted Rejected although content valid Rejected because content invalid Group defining identifiers targeted by an upstream message. Note a peid is a Uuid and uses the same Gname semantics as a GuidAttributeGroup (which is an untargetable declaration). If no peid is supplied, the value is inherited from the parent. Valid documents must have a peid attribute present at or above the level of every element that includes a MessageTargetAttributeGroup. Group describing the currency of a document element and it's children. This defines the application that implements this placement directive, if any Placeholder for TBD processing rules. ApMsgRul from App Messaging Rule Identification for an arbitrary AV asset. When there is more than one placement asset, the asset selection filter is a filter expression for selecting the asset to use in a given placement. It references a specific set of externally defined data elements created this purpose. It includes elements such as impression counts for the asset or rotation or episode-based selection from a set of assets. If any Filter rule tests daypart then a DaypartXml element must be present to define the daypart test. If more than one AssetSelectFilter is present they are processed in document order and combined using the TermOperatorType in each term. General information for the Campaign Information Package. Holds data to permit an SCTE 130 ADS or equivilent to choose between conficiting placements based on the best business decision. This defines the location in the underlying content in which this element occurs or is presented. The body of this type supplies an expression for a specified expression engine This is a container for one explicit target, with an ident and possible specific POs The complete description of one flight of a Programmed event and all its enhanced content. Guids are always defined with this type, which provides an alternative meaningful human readable name The definition of a single MSO order. The definition of a single enhanced package Instance within the Programmed Event. Both placement directives and package elements are optional since one one of either is required. The definition of a single package Instance within the Programmed Event. A package element may override the definitions found in the Package. This is a container for all properties of one specific placement directive Hold the set of placement directives for a Programmed Event, Package, or Package Element This is a container for the set of audio-visual asset or assets that are requirement by a specific placement directive. The PlaceFilter contains an expression to be applied to a proposed placement opportinuity in terms of elements from PO or POIS metadata that will qualify the placement of this specific placement directive. If more than one PlaceFilter is present they are processed in document order and combined using the TermOperatorType in each term. This holds controls that are to be applied during any occurance of this product instance. This element defines an instance of a specific product and makes its parent directly referencable by an upstream STB message, based on Peid+Epsid, and the resultant node processed based on its EpType. It also holds rules qualifying occurances of the product instance and controls to be applied The ProdFilter element defines filter expressions that apply to the product placement as a whole, and that are generally specific to the Product Family. The domain of data elements is defined independently. For a VOD insertion product they might be expected to include impression limits, frequency limits, and daypart or other context tests. If more than one ProdFilter is present they are processed in document order and combined using the TermOperatorType in each term. Creates or modifies the definition of one Programming Event. Node Ref and status are required in each instance, and Schematron will be used to enforce the existence of other critical elements at least once across all levels of defaults. This identifies the status of one record, a revision of an element instance. This is a time relative to a context-specific event, typically Flight begin time. The precision is implicitly to the millisecond to permit frame sync. The complete definition of return data for one EpType. Stewardship references to the data that generated this campaign. Placeholder for TBD processing rules. SmMsgRul from Service Metrics Messaging Rule The definition of a single system order. This is a container for all information defining or qualifying a set of target assets of a placement directive. It includes qualification rules, expected placments, and specific asset identifications. Qualifications and explicit are optional since either can occur alone. However at least one placment is required. The body of this type supplies an expression for testing whether the campaign applies to a specific target using a specified expression engine. If more than one FilterRule is present they are processed in document order and combined using the TermOperatorType in each term. The PoFilter element defines a string expression for a specified expression engine that filters or qualifies the set of placement opportunities required by this placement directive. The expression is in terms of PlacementOpportunity and descendants in the PlacementRequest, or POIS data obtained for a placement opportunity. If more than one PoFilter is present they are processed in document order and combined using the TermOperatorType in each term. The complete definition of MSO-level processing for app messages related to one Epsid. This may include expression strings to be processed by a specified expression engine that are applied to app messages. Arbitrary placement opportunity in the underlying content defined as either a DVS 629 placement or as a relative time to the actual start of flight. A relative time without an interval implies the actual duration of the flight. The DVS 629 SegmentationUpid element's value is of type xs:hexBinary and contains the SCTE 35 segmentation_upid bit field. The value should not be empty. The value is specific to the @type attribute and shall meet the requirements as specified in SCTE 35. The complete definition of MSO-level processing for Service Metrics messages related to one Epsid. This may include expression strings to be processed by a specified expression engine that are applied to sm messages. Advanced Advertising MSO Campaign Information Package document root element Element for Notify message Response for Notify message Element for Read message Response for Read message Element for SetRegistration message. Identifies target URL,boolean sets as enabled or disabled for distributions. If enabled, syscode list is required, exclusive registration for each Response for SetRegistration message. Note that if any syscode of an enabled registration is already registered to another Subscriber the registration fails. In tis 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). Contents of fault on Read Request.