Copyright (c)2008-2012, Cable Television Laboratories, Inc. XML Schema, Release Version 3.0.0 SaFI Campaign Information Package Interface. This schema is a normative component of CableLabs® Subscription and Fulfillment Interfaces, Campaign Information Package Specification, OC-SP-SaFI-CIPv3.0-xxxxxx
The Campaign Info Package is the root element of all new or updated campaign descriptions. It contains the following data units:
Posts a CIP document containing CIP state feedback elements from the CIP subscriber to the CIP publisher. FeedbackNotice contains zero or more CampInfoPkg elements, and zero or more Ext extension elements. The isRetry attribute signals that an exact duplicate of a prior message is being posted.
FeedbackResponse is a reply to a FeedbackNotice message. FeedbackResponse elements include a MsgResultAttributeGroup attribute group.
The optional Notes element can provide supplemental detail.
An InvaldRequest is sent in response to an errored Read Request.
An InvalidRequest element MUST contain a Reason element, containing one of the following fault indicators:
The Values (of type BundleSelectorGroup) attribute group repeats the received request.
The optional Notes element can provide supplemental detail.
contextId is an optional value that MUST be present if and only if it was supplied in the readRequest message to which this InvalidRequest message is the response.
A ReadRequest message provides a client the ability to request CIP data. The BundleSelectorGroup identifies the top-level bundles to be returned.
The contextId attribute is optional, but if it is present, it MUST be returned in the ReadResponse that satisifes this readRequest.
A ReadResponse message is sent in reponse to a successful ReadRequest. ReadResponse will contain a CampInfoPkg with zero or more Bundle elements that satisfy the criteria identified by a ReadRequest.
The optional Notes element can provide supplemental detail.
contextId is an optional value that MUST be present if and only if it was supplied in the readRequest message to which this ReadResponse message is the response.
A GetRegistration message enables the consumer site identified by the Subscriber URI to issue this message to a publisher site to query the current list of active syscodes for the given consumer site.
Response for GetRegistration message. Identifies the target URI and a list of currently-enabled syscodes for that URI.
The optional Notes element can provide supplemental detail.
The SetRegistrationRequest message MUST be issued by a CIP consumer site to a CIP publication site to add or remove the consumer site from the publication site’s subscription list, or to maintain the set of syscodes which the consumer site presents.
The Subscriber value defines both the identity and web service URL of the consumer site. The rest of the message conditions the information expected at that site.
Boolean Active applies to the syscode set of the message, and sets those syscodes as enabled or disabled (by Active value) for distributions. For both operations, an empty syscode set implies the entire set of syscodes predefined for the subscriber (via an unspecified mechanism). Any site with no active syscodes is not an active site; any site with one or more active syscodes is an active site.
The Syscodes set controls the scope of the operation. If a set of syscodes is supplied, the operation applies only to those syscodes. However, if the set is empty, the operation applies to all of the syscodes predefined (via an unspecified out-of-band mechanism) for the subscriber. Syscodes active for the site but not included in the syscode set are unaffected by the message.
Defines the response to a SetRegistrationRequest message.
The optional Notes element can provide supplemental detail.
Distributes (pushes) one or more unsolicited updates to campaign data from a CIP publisher to a CIP subscriber. The UpdateNotice message MUST be issued by a publication site to deliver to subscribers one or more revised top-level Bundles, contained in the CampInfoPkg. The isRetry attribute signals that an exact duplicate of a prior message is being distributed.
UpdateResponse is a reply to an UpdateNotice message. UpdateResponse elements require a MsgResultAttributeGroup attribute group.
The optional Notes element can provide supplemental detail.
Defines one application that may be associated with this placement.
Each AppMetadata element in the list is a container for one key/value pair, where:
The ContentMgmt element allows for content readiness checking, based on a delivery window and domain.
The StateFeedback element provides current statistics with respect to the execution of this application. This is a primary feedback element.
The optional Phase element provides application-level phase rules. These MUST be invoked only for phase events 'lost' and 'found', refering to the complete set of application components.
RecordIdAttributeGroupOpt carries the unique identity of a phase in PEID/Epsid.
AppType identifies the form of the application content
ApplicationDefinitionAttributeGroup characterizes the application, either with an AppId/orgId/appVer set or with an appDataReference.
The apply attribute indicates the form in which this asset applies to its parent placement.
Container for rule argument variable/value pair, with the variable name in the attribute and the value in the element body.
Supplies the detail of one (typically, but possibly more than one) asset that is part of the placement.
Each AssetMetadata element in the list is a container for one key/value pair, where:
The ContentMgmt element allows for content readiness checking, based on a delivery window and domain.
TrickModeRestriction defines type and viewing rate scale restrictions. In the absence of restrictions all stream controls are permitted.
The StateFeedback element provides current statistics with respect to the execution of this asset. This is a primary feedback element. The revision refers to the revision of the parent element.
The optional Phase element provides asset-level phase rules. These MUST be invoked only for phase events 'lost' and 'found'.
The assetType identifies the family of the asset, which enables some interpretations of the asset structure without reference to the metadata.
The apply attribute indicates the form in which this asset applies to its parent placement.
If a sequence attribute is present, it defines the position of this asset with respect to others during presentation timeline. If sequence is omitted, the asset's position in the presentation timeline is undefined. If a set of two or more asset references share a sequence value, each asset's position in the presentation timeline is undefined with respect to other members of that set.
Note that an AssetReferenceType contains a RecordIdAttributeGroupOpt (which carries the unique identity of the phase), but no RecordStatusAttributeGroup. This means that an AssetReferenceType is a reportable CIP node, but is not an independent revision set; 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 MUST always be present.
Bundle is a recursive element allowing representation of tree structures. These define a set of placements in a specific campaign, at an indicated MSO and syscode. The Placements of the bundle define specific presentation activities that fulfill the campaign. The relationship between the placements that forms the basis of a bundle, as well as the relations implied by a bundle tree structure, are both beyond the scope of this specification, but are typically characterized by the value of ProductFamily as an 'ad product' that has a definition external to this specification. Each placement of the bundle MUST be evaluated independently, except for the specifically defined interactions with attributes of the bundle.
CategoryExclusion optionally defines placed asset categories that are restricted with respect to placements of this Bundle.
The list of CommonQualifierGroups defines qualifier expressions that MUST be satisified for any placement that is a child of this bundle. Multiple groups are always ANDed, which means that such placements only occur if each group is individually true.
The implementation behavior MUST be such that the common qualifiers of a bundle are effectively projected to their placements and evaluated as additional qualifiers of each placement. However, recursive bundles with a concurrency other than 'any' require independent evaluation of their common qualifiers to determine if the concurrency condition is met.
The Bundle is uniquely identified by the PEID+EPSID in the RecordIdAttributeGroupReq. Since it also contains a RecordStatusAttributeGroup, it is an updateable element with the required PEID+EPSID identifying the revision set. Updates MUST be applied to a top-level Bundle and replicate the complete tree of active children of that Bundle. A CIP document that contains multiple revisions with the same idenity MUST have those revisions as adjacent elements in decreasing revision number order.
CampVer indicates the global revision number of the campaign data from which this Bundle is derived. Guid and CampVer uniquely identify a set of campaign data.
ChildConcurrency attribute identifies the relationship of child placements or bundles of this bundle. If the optional attribute is omitted the default value is 'any'.
Ext provides the standard extension mechanism.
The Flight provides the earliest and latest dates for this placement, as well as a mask for days and daypart periods within that interval. When multiple Flight entries are present, the Start is the earliest listed, the End is the latest listed, and the days and dayparts are ORed across entries.
The guid attribute provides a unique identifer for a campaign, as defined by the CIP owner.
The Phase provides bundle level phase rules. Phase in a bundle may use any phase events except 'decision'. If specified here the phase events 'defined', 'destroyed', 'flightBegin', and 'flightEnd', apply as primary events at the bundle level. Although they may also be transfer targets from descendent placement events, they MUST be primary events at the bundle level. If specified here, the placement-specific phase events 'lost', 'found', 'placed', 'placeIAM' and 'placePSN', apply as primary events at the bundle level. Although they may also be transfer targets from descendent placement events they MUST be primary events at the bundle level and be delivered at this Phase for the corresponding event within any descendent placement, asset, or application.
Priority serves to provide an ordering within which to select placements. When multiple placements are possible at any given opportunity, the highest-priority placement, or a member of the group of highest-priority placements when there are more than one with that same priority, MUST always be placed in preference to a lower priority. Note that a high priority is a lower numeric value. The priority specified at the Bundle level applies to all child Placements that do not have a priority specified individually.
The ProductFamily attribute identifies an 'ad product' associated with this Bundle. Supplemental external definitions for the product family guide the interpretation of the bundle and its children. This attribute is REQUIRED as of version 3.0 of the CIP specification.
SeparationConstraint determines if a placment can be shown more than once, either within a single placement opportunity, or within a single viewer session. When present at the Bundle level, the constraint applies to all Placements of the Bundle that do not include a separationConstraint.
The StateFeedback element provides current state and optionaly statistics with respect to the execution of this bundle and all descendants. This is a secondary feedback element.
The StwShpData element provides operational data to support the stewardship of the campaign of which this bundle is a component.
Updates can only be issued for a top level Bundle and MUST include all its components. The author of a revised version of a top-level Bundle MUST increment revision and revDat in any element that changed, and also in each level of containing elements to the top level Bundle. Authors must also maintain the recState and recRevoked elements.
Note that campOrderOwner and decisionOwner are often distinct. The decisionOwner is intended to be the owner ID for ADS selection purposes, not the ADS ID itself.
A control for enforcing product category separation within ad opportunities and viewer sessions.
The scope attribute indicates how broad the exclusion test needs to be.
A Boolean qualifier expression. Multiple qualifiers represent enclosed expressions, which are combined with the condition operator.
Qualifier is an enclosed expression.
Condition is the binary Boolean operator used to combine the qualifiers.
This element is used for content (media and data) readiness checking. It defines a content residence window which typically leads than the flight window. It may optionally supply a domain (normally, a network) as a hint for content server selection.
A container for the attribute group to contain potential attribute name conflicts if an element should require several such groups.
Container for a Metadata declaration/value pair, with the declaration's namespace and qualifier XPath in the attributes and the declared value in the element body.
A container for campaign data for a single MSO. This contains sets of bundles for one or more campaigns enclosed within a SysOrder element or an Orders element, but not both.
A SysOrder list holds bundles by syscode within the MSO. The SysOrder@syscode MUST be provided to identify the particular syscode.
An Orders list holds bundles that apply uniformly to all Syscodes of an MSO. The SysOrder@syscode MUST NOT be supplied.
The name is a standardized name of the MSO.
An Order provides a container for bundles at one or more syscodes within one MSO.
The phase type defines one or more sets of of rules to be processsed at the workflow point indicated by the 'event' attribute. When the event of the phase is triggered, each rule selector MUST be passed to the rules engine along with the phase identification.
The Phase is uniquely identified by the PEID+EPSID in the RecordIdAttributeGroupReq. This identity is passed as implicit arguments to processed rules to identify the context in which the rule is invoked. Since it also contains a RecordStatusAttributeGroup, it is an updateable element with the required PEID+EPSID identifying the revision set for this and all child elements. If multiple revisions of the same identifier are present, the document order MUST have them as adjacent elements in decreasing revision number order.
Any triggered phase element MUST be processed by invoking its own process rule selectors and then triggering its ancestor phase nodes. Ancestor phase nodes are recursively defined as phase elements contained in the parent element that are triggered by the same phase event.
Event identifies one of an enumerated set of events in the processing flow of the execution engine at which this phase is to be invoked.
ProcessRuleSelector is a set of elements that each supply a set of specific data-processing rule parameters under this phase. This set may be empty if the only desired effect is transfering the processing using the parentPeid and parentEpsid attributes
Phase permits the phase type to be defined recursively. This would be used, for example, to reflect the hierarchical structure of campaign functions (in a Bundle) or applications (in a Placement). The structure of any such recursion tree MUST be predefined for each product family and member.
The parentPhasePeid and parentPhaseEpsid attributes allow a trigger reference to some disjoint phase tree. Those values MUST identify a Phase element contained within the descendent tree of the current top-level bundle. The reference causes all processing references that either begin at the including element or arrive at that element from a child node to continue processing by transfering to the referenced parent node and then to its ancestors. The phase nodes are scanned up the descendent tree in document order executing only nodes with the same event. This mechanism permits a placement phase triggered from the execution environment to in turn trigger a specific bundle phase.
Defines a specific placement of one or more advanced advertising assets into an advertising placement opportunity.
The list of QualifierGroups defines qualifier expressions that must be satisified for this specific placement. Multiple groups MUST be ANDed, which means the placement occurs only if each group is individually true. If there are common qualifier groups defined for the placement's bundle, they MUST also be ANDed with these groups.
AssetReference is a list of audio and video components that are part of this placement.
AppReference is a list of application components that are part of this placement. Note that, at present, it is not useful to include more than one AppReference element. This may change in the future.
CategoryExclusion optionally defines placed asset categories that are restricted with respect to this placement. If a categoryExclusion is defined in a parent bundle and none is defined in this placement, that exclusion MUST apply as though provided here. The category or categories defined in the asset metadata of this placement MUST be considered in tests of related placements even if this placement does not define an exclusion.
The Flight provides the earliest and latest dates for this placement, as well as a mask for days and daypart periods within that interval. When multiple Flight entries are present, the Start is the earliest listed, the End is the latest listed, and the days and dayparts are ORed across entries.
The Phase provides placement level phase rules. Phase in a placement may use any phase events. If specified here, the asset and application-specific phase events 'lost' and 'found', apply as primary events at the placement level. Although they may also be transfer targets from descendent assets or applications, they MUST also be primary events at the placement level and be delivered at this Phase for the corresponding event within any descendent asset or application.
The StateFeedback element provides current state and optionally statistics with respect to the execution of this Placement and all descendants. This is a secondary feedback element.
Priority serves to provide an ordering within which to select placements. When multiple placements are possible at any given opportunity, the highest-priority placement, or a member of the group of highest-priority placements when there are more than one with that same priority, MUST always be placed in preference to a lower priority. Note that a high priority is a lower numeric value.
The Placement is uniquely identified by the PEID+EPSID in the RecordIdAttributeGroupReq. Since it also contains a RecordStatusAttributeGroup, it is an updateable element with the required PEID+EPSID identifying the revision set for this and all child elements. If multiple revisions of the same identifier are present, The document order MUST have them as adjacent elements in decreasing revision number order.
ProductMember optinally identifies role of the placement in the ad unit being expressed. There may be supplemental operational definitions under which the execution engine's expectation of the data structure and content of a placement may by conditioned by the ProductMember.
SeparationConstraint determines if a placment can be shown more than once, either within a single placement opportunity, or within a single viewer session. If absent no such constraint exists.
TrickModeRestriction defines type and viewing stream control restrictions. In the absence of restrictions, all stream controls are permitted. The Placement restrictions apply to all assets, unless the asset has a distinct restriction of its own.
ProcessRuleSelector defines one set of parameters for the aggregator and rules engine that selects and performs one data process associated with the phase and phase event.
Arg is an argument to be supplied to the aggregator or rules engine along with the process rule. Args have an actual name in the 'variable' attribute and a value in the mixed content body. The actual name is matched to a formal name in the rule definition and the value of the arg MUST be substituted for that formal name in the rule invocation.
RuleRepository is the URL of the repository that contains the rule to be invoked.
RuleId is the repository-specific ID for the rule to be invoked. (This field was named epType in versions D03 to 1.1.)
RuleVersion is the version number of the identified rule. If omitted or supplied as "0", the lastest version MUST be used.
The complete and unique rule identifier is formed from as a composite URL consisting of the concatenation of ruleRepository URL, "/", the RuleId, "." and the version number. If the version is supplied or defaulted as "0", the execution engine MUST subsitute the highest version of the rule that is defined.
The StateFeedback element provides current state and statistics with respect to the ability to execute this process rule. This is a primary feedback element.
Sequence holds an optional ordinal value (one or greater) that defines rule evaluation order within a Phase or other multi-rule container. All rules that have a sequence value SHALL be processed in ascending sequence order, followed by the set of remaining rules that do not have a sequence value processed in any order.
Ext is supplied to allow attributes to be added in the same form as those currently defined.
A Boolean qualifier expression that is evaluated for a placement and ANDed with the bundle's commonQualfier groups. Multiple qualifiers within the group are enclosed expressions, and MUST be combined with the condition operator.
Qualifier supplies an enclosed expression.
condition is the binary Boolean operator used to combine the enclosed expressions.
A container for a set of one or more Boolean terms. If the container holds more than one term, the value of the container MUST be the AND of all the contained terms.
Provides a request for (when published) or actual current (when returned) statistics with respect to the execution of this placement or bundle and all descendants. The statistics are typically issued only when non-empty, and not repeated in subseqeuent reports unless the set of contained values has changed.
The sequence of Statistic elements conveys the set of feedback statistics. When published each Statistic element MUST have a valid, defined, datamap and variable reference in an empty element. The runtime implementation is responsible for evaluating that variable and inserting the result in the body of the statistic element.
When included in a published CIP, this type explicitly requests feedback on the operational and execution state of the parent CIP element. This does not preclude alternate, external methods of making such requests and providing similar controls.
When this type is included in a CIP returned to the publisher it supplies feedback on the state of CIP operations with respect to a single Syscode, a specific element, and a specific revision of that element.
StateFeedback may be a primary or secondary element. Primary elements report on specific readiness of actions. Secondary elements summarize the readiness of their primary or secondary children.
For any summary state element that is reported, all primary and secondary state feedback that contributes to that summary MUST be collected or evaluated, whether or not it is reported.
revision is the revision number of the parent element whose status is requested or reported. Multiple feedback elements MAY be included for a parent element, provided each is for a distinct revision.
There are four cases that trigger reporting of a StateFeedback element, as follows.
reportAsOf is used by the CIP publisher to control state feedback reporting for this CIP version. See the reporting trigger definitions, above for details.
reportEndTime is used by the CIP publisher to control state feedback reporting for this CIP version. See the reporting trigger definitions, above for details.
reportInterval is used by the CIP publisher to control state feedback reporting for this CIP version. See the reporting trigger definitions, above for details.
recState is PROHIBITED in a published CIP, and REQUIRED in a state-feedback CIP. recState conveys the CIP subscriber's current status with respect to this bundle or placement. In contrast to a recState published in a Bundle or Placement, which reflects a desired or intended state, the recState returned here represents an actual, current state.
mediaState summarizes the state of all content management that applies, using the conditions of the content's ContentMgmt element. For a placement, it is a summary of all the AssetReference and AppReference elements in the placement. For a bundle, it is a summary of the mediaState of all the bundles and placements contained in the bundle.
executionState summarizes the state of the set of all system components that are required to implement this bundle or placement, inclusive of that state for all bundle or placement children. The definition of the set of components is all and only those components upon which the complete and successful execution of this specific bundle or placement depends. Examples might include the decision system, aggregator, and subscriber information system.
In a published CIP, Statistics contains a list of requested statistics, whose body values are empty. In a returned CIP, Statistics contains that same list with each Statistic's body value supplied.
The optional Notes element can provide supplemental detail.
The Contact list provides one or more contacts for operational assistance. Contact roles can help in selecting the correct contact.
An individual Boolean qualifier term which is part of a Boolean expression. The term provides a Boolean result from an operation on two values; an lvalue and an rvalue. The lvalue is the contents of either a rule datamap variable reference or a document field reference. A rule reference MUST consist of a datamap and a variable. A document reference MUST consist of a source, a namespace, and an xpath.
The evaluation environment constructs the lvalue by fetching the value identified by the reference. It then compares that with the rvalue, which is contained in the body of the element. The comparison is subject to the semantics of the qualifier's datatype, and the comparison function is defined by the operation. The result is a Boolean value representing the value of the term in the expression.
source is an optional identification of the source document to reference or identifies the source as a rule data source. If omitted, the default is a placed asset. If used in a context where a single placed asset reference is not implicit, an appropriate value is required.
namespace is either a value from a predefined set of namespaces in Annex A of the CIP specification (which have implementations in each execution environment), a document source, or a specific data store name for a data source.
xpath is a legal xpath within the identified namespace to a data element that exists in the metadata document identified by the source.
datamap is the name of a defined, persistent, rule datamap known to the execution environment.
variable is the name of a name/value pair that currently exists in the identified datamap.
operation is binary Boolean operator describing a required relation for this qualifier. The semantics of the comparison are those normal to XML for the datatype of the qualifer.
Defines one particular trick mode exclusion composed of a type and, for type="trick", a speed scaling factor or range of factors. The scale factor is the ratio of the play speed to normal play speed; forward speeds are positive, and backward speeds are negative.
Normal is forward at an implied scale of 1.0, and that combination is always explicit (i.e., normal play is never an implied part of a trick range).
Trick is a multiple of normal play speed, signed for forward or reverse. Trick 0.0 describes no play (i.e., pause).
Jump is a navigational notation used for transitions such as "digital rewind" or "go to chapter". It does not have a speed.
All is all trick modes, but excludes normal play.
If present, lowertest and uppertest are applied when evaluating the scale value. The default tests are "ge" for lowertest and "le" for uppertest.
Trick Mode Restriction Type defines type and viewing rate scale restrictions. Note that, for each Trick Mode Restriction, all trick modes are initially permitted, less those explicitly excluded below. Restrictions on placements are applied to all AssetRefs. If restrictions are specified on both the placement and AssetRef, they are combined.
Optional trick mode restriction rule. If we are within the effective period as defined by EffectiveDatesDayTimeAttributeGroup, any rule that is present is evaluated, with the PEID and Epsid of the parent Asset or Placement supplied as implicit arguments. The rule will set the reserved variable 'datamap = "cablelabs.safi" variable="PEID.EPSID.trickmode.apply"' to true if the trick mode restriction is to be applied and false otherwise. This variable MUST be tested by the execution environement to determine if the restriction to be applied. Note that the PEID and EPSID strings in the reserved variable name represent the actual PEID and Epsid of the parent Asset or Placement.
Identifies the form of the applicaiton defined in a reference. This enables some decisions to be made about the application structures prior to placement, and without requiring reference to the associated metadata.
Defines how an application or asset applies to its parent placement.
validate means to ensure at preflight that the content is present as defined.
place means that this content is part of the placement response data set, but it does not get preflight validation.
valAndPlace means that the content should be validated at preflight, and is also a part of the placement response data set.
Identifies the kind of asset defined in a reference. This enables some decisions to be made about the asset structures prior to placement, and without requiring reference to the associated metadata.
The date and time the initial revision of the Campaign Information Package was created.
The date and time the specified revision of the Campaign Information Package was created.
Campaign version number. The version number is incremented as the campaign definition data is changed after publication. After any increment, the revision number MAY be retained until the next publication.
Campaign references with the same revision number MUST contain the same data.
Defines a constraint on child placements or bundles of the bundle in which this attribute appears. A placement MUST be defined as effective if its qualifiers are true. A bundle MUST be defined as effective if any of its placements or bundles are effective. Then:
A set of Boolean binary operators defined on qualifier terms with a group.
The name of a contact available for resolving 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. Use of a UUID or similar unique identifier is recommended.
A name string for a datamap in the current rule environment. The CIP only contains external datamap references, so the named map must exist out of rule-scope.
Identifies the owner of the placement decision. The value MUST be either: a) a valid URL as defined in IdentifierOwnerType, or b) one of the following two reserved text strings which reflect SCTE-35 signaling options:
The date and time this revision of the element was created.
A revision number of an element. Implementations MUST increment the revision number whenever any data within an identified element (other than revision group data) is changed. For each element with an ElementRevisionNumber, only the record with the highest revision number currently applies, and normally only that record is distributed. Any other records need to be requested.
The current status of an Element's data model. This MUST be one of the following enumerated values:
The email address of a stewardship contact.
Indicates whether an exclusion rule should be enforced within a group of opportunities, such as defined in the ADI 3.0 Placement Opportunity by group index, within a single break, or within the entire viewer session.
Identifies the summary state of all execution resources necessary for this element.
Generic owner identifier. Identifiers MUST be unique within the namespace of their owner identifier. The CipOrder attribute, derived from this, identifies the order from which this CIP is derived.
This value is strictly an identifier and has meaning only in the environment of the CIP publisher.
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.
Identifies the readiness state of a media reference.
A unique name assigned to an MSO and present in all the MSO orders or queries for that MSO.
One of the predefined values for a qualifier namespace as listed in Annex A of the CIP specification. Each namespace identifies a data model with a set of predefined xpaths, each of which has a known datatype and semantic definition.
Binary operator defined on two operands, a left and a right, and a datatype. The specific semantics of the operations are defined by the datatype.
Identifies the point in the CIP execution environment processing flow that a phase is to be invoked. The points are as follows:
A value defining an ordering for placements. Lower numeric values represent higher priorities, with 1 being the highest.
This is one of set of known product families defined in external implementation guidelines. It is used for stewardship functions, and can also condition the required structure and content of the CIP in ways that can be relied upon by the execution environment.
This is one of a predefined set of known members for a specific product family defined in external implementation guidelines. It is used for stewardship functions, and can also condition the required structure and content of the CIP in ways that can be relied upon by the exeuction environment.
An XPath string or a specific predefined name string selecting a data element of an identified namespace.
Identifies a document source for a qualifier reference. Current options are:
True indicates the containing record is deprecated. A higher revision might exist, with the flag false representing more current data. There MUST NOT be any higher revision with the flag false if the record is deleted. At least one update MUST be issued with the flag false when a record is deleted rather than revised; the record MAY then be omitted from further distributions.
Identifies a complete application. This is a key to access the application characterization in the application repository.
Constrains a placement to be separated (i.e, precludes it from being shown more than once) either within within a group of opportunities, such as defined in the ADI 3.0 Placement Opportunity by group index, a single placement opportunity, or within a single viewer session. If omitted, the default behavior is to preclude adjacent placement in the same opportunity.
One optionally-signed decimal number with two optional decimal places representing transport speed, with the normal play transport speed defined being 1.0. It is optionally followed by a comma and a second value to indicate a range of speeds. The minimum absolute value is zero, the maximum absolute value is 100, and the resolution is 0.01.
Container for a statisics variable reference/name pair, with the reference's datamap and variable in the attributes and the value, if present, in the body.
Trick-mode type identifier. Play is always used with a scale or scale range. Key
use cases are:
1) enter in normal play, where the viewer can pause or
"rewind", meaning reverse play; and
2) once entered, the viewer can only
watch at normal play, or pause. The play modes are as follows:
Trick type examples:
TYPE SCALE trick 0.0,100 refers to all forward play except normal play (never implies pause) trick 0.01,100 refers to all forward play except normal play trick 2.01,100 refers to forward play greater than 2x trick -100,100 refers to all foward and reverse play except normal play and pause trick -100,-1.01 and trick -0.99,100 refer to all foward and reverse play except explicitly omitted reverse normal play and implicitly omitted normal play and pause.
Human-readable name associated with every UUID to allow meaningful communication. This should be chosen to have a very low probability of duplication, but uniqueness is not testable, so is not required.
A name string for one of the actual arguments of a rule invocation.
The attribute set for characterizing an application. The repositoryAppKey characterizes an application according to the specification format, and the OrgID, AppID, and 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 appDataReference, or both, MUST be present for the applicationDefinition to be valid.
Defines selection criteria for Bundle data to be returned in a ReadRequest. The ReadResponse returns zero or more top-level Bundles that satisfy all the supplied selection criteria. Omitted criteria do not restrict the returned set, except as specifically noted. All child components are included for each top-level Bundle selected.
A specific campaign can be selected by one of a guid or gname or order number + orderOwner; otherwise, orderOwner alone selects all campaigns associated with the owner.
revision refers to the Bundle revision. If omitted or zero, revision selects the latest version; a specific version may be identified, and a version of -1 selects all versions.
revDateFrom and revDateTo select a window of revision dates for the Bundle.
A specific top-level Bundle can be requested by PEID+EPSID.
Describes one operational contact. Note that one of phone or email MUST be present. ContactAttributeGroup has the following attributes:
If present, the date/time this reference is active. startDateTime and endDateTime are optional values; however, if they are present, the startDateTime and endDateTime MUST be evaluated prior to evaluating any other attribute in this section. This attribute group can take several forms:
If present, the date/time this reference becomes inactive.
Effective days of the week. Each day of the week is represented by an independent Boolean value. By default, all days are active; set a day to false to make the entry inactive for that day.
Start time of day for being active. For example, 09:00:00 represents 9:00am local time; 09:00:00Z represents 9:00 am UTC; and 09:00:00-06:00 applies an offset. If startTime is omitted, the entry is effective for the entire days listed based on local time. If you wish to use UTC time to represent the entire day, specify a start time of 00:00:00Z with a duration of 23:59:59.
Effective duration of time from the start time. If duration is supplied and startTime is omitted, duration MUST be ignored. Note that duration can extend into the next day. If an end date/time is specified, it MUST be observed when calculating the actual end time based on startTime and duration, and supersedes the duration attribute.
Attribute group for all GUIDs. This includes the unique UUID and also a human-readable name.
Attribute group for most message result status.
Accepted
Rejected, but with no information about content validity.
Rejected because the content is invalid.
Group describing a revision set and the currency of the document element and its children. Any element with a RecordStatusAttributeGroup MUST also have a RecordIdAttributeGroupReq whose PEID+EPSID are the unique identifier for the revision set.
In a document, multiple elements of the revision set MUST be ordered by decreasing revision number.
recstate indicates the expected processing state of the revision set.
The recRevoked flag indicates whether the revision set is effectively part of the current document.
The revision number is a unique ID and also a total ordering for versions of the revision set.
creDat indicates the date and time the original revision was created.
revDat indicates the date and time the current revision was created.
The set of attributes that identify a specific CIP element as an independently-reportable unit. This group requires only the EPSID; the PEID can be inherited from a parent. The group cannot identify a revision set, as it is not a self-contained unique identifier when the PEID is omitted.
The rname is an optional human-readable name for the specific PEID-EPSID pair.
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 only identifies a revision set if it occurs in conjunction with the RecordStatusAttributeGroup.
The rname is an optional human-readable name for the specific PEID-EPSID pair.