activity.schema.json

{
    "meta:license": [
        "Copyright 2021 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/decisioning/activity",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/record"
    ],
    "title": "Decision Activity",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": false,
    "description": "Controls a decisioning process and describes some form of action that is planned to happen, is currently happening, or has already happened. The purpose of the activity is to execute a number of steps to return an ordered selection of best options that qualify in a given context (time-bound, profile-bound, option-bound, context data) or return or a default option (fallback). A decision activity can be thought of as a kind of https://www.w3.org/ns/activitystreams#Activity or https://schema.org/Action. Those entities imply an actor/agent which is a software construct (service).",
    "definitions": {
        "activity-details": {
            "type": "object",
            "properties": {
                "repo:etag": {
                    "title": "Activity ETag",
                    "type": "string",
                    "description": "The revision that the decision activity object was at when the snapshot was taken.",
                    "meta:titleId": "activity##repo:etag##title##18491",
                    "meta:descriptionId": "activity##repo:etag##description##28161"
                },
                "https://ns.adobe.com/experience/decisioning/name": {
                    "title": "Activity Name",
                    "type": "string",
                    "description": "Activity name. The name is displayed in various user interfaces.",
                    "meta:titleId": "activity##https://ns.adobe.com/experience/decisioning/name##title##89441",
                    "meta:descriptionId": "activity##https://ns.adobe.com/experience/decisioning/name##description##29001"
                },
                "https://ns.adobe.com/experience/decisioning/startTime": {
                    "title": "Activity Start Date and Time",
                    "type": "string",
                    "format": "date-time",
                    "description": "Activity start date and end time. Property has the semantic of schema.org's 'startTime' property defined on http://schema.org/Action",
                    "meta:titleId": "activity##https://ns.adobe.com/experience/decisioning/startTime##title##14601",
                    "meta:descriptionId": "activity##https://ns.adobe.com/experience/decisioning/startTime##description##5721"
                },
                "https://ns.adobe.com/experience/decisioning/endTime": {
                    "title": "Activity End Date and Time",
                    "type": "string",
                    "format": "date-time",
                    "description": "Activity end date and end time. Property has the semantic of schema.org's 'endTime' property defined on http://schema.org/Action",
                    "meta:titleId": "activity##https://ns.adobe.com/experience/decisioning/endTime##title##31021",
                    "meta:descriptionId": "activity##https://ns.adobe.com/experience/decisioning/endTime##description##14761"
                },
                "https://ns.adobe.com/experience/decisioning/fallback": {
                    "title": "Fallback Option",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "The reference to a fallback option that is used when decisioning in the context of this activity does not qualify any of the regular options (this typically happens when hard constraints are applied). The value is the URI (@id) of the fallback option that is referenced.",
                    "meta:titleId": "activity##https://ns.adobe.com/experience/decisioning/fallback##title##22951",
                    "meta:descriptionId": "activity##https://ns.adobe.com/experience/decisioning/fallback##description##6401"
                }
            }
        },
        "activity-snapshot-identifier": {
            "type": "object",
            "properties": {
                "https://ns.adobe.com/experience/decisioning/activityID": {
                    "title": "Activity Identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "A unique, immutable identifier for the decision activity.",
                    "meta:titleId": "activity##https://ns.adobe.com/experience/decisioning/activityID##title##24741",
                    "meta:descriptionId": "activity##https://ns.adobe.com/experience/decisioning/activityID##description##64161"
                },
                "repo:etag": {
                    "title": "Activity ETag",
                    "type": "string",
                    "description": "The revision that the decision activity object was at when the snapshot was taken.",
                    "meta:titleId": "activity##repo:etag##title##88321",
                    "meta:descriptionId": "activity##repo:etag##description##17531"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/record"
        },
        {
            "$ref": "#/definitions/activity-details"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "activity##title##64091",
    "meta:descriptionId": "activity##description##26151",
    "examples": [
        {
            "@id": "xcore:offer-activity:fd55d033fea4b82",
            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
            "https://ns.adobe.com/experience/decisioning/status": "draft"
        },
        {
            "@id": "xcore:offer-activity:fd55d033fea4b82",
            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
            "https://ns.adobe.com/experience/decisioning/status": "live",
            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
            "https://ns.adobe.com/experience/decisioning/criteria": [
                {
                    "xdm:placements": [
                        "xcore:offer-placement:c652463157c2aa1"
                    ],
                    "xdm:optionSelection": {
                        "xdm:filter": "xcore:offer-filter:f6998eb62ed6f15"
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Pilot = Y",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:e5244c22eff29e8"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 0
                    }
                },
                {
                    "xdm:placements": [
                        "xcore:offer-placement:c652463157c2aa2"
                    ],
                    "xdm:optionSelection": {
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f15"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0ba3"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 0
                    }
                },
                {
                    "xdm:description": "S1:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Charge_Elite_30 Offer",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f15"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (ClassicKC, MVC) AND Pilot = Y AND Discount(Reserve1) = 30",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b01"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 8
                    }
                },
                {
                    "xdm:description": "S2:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Charge_Elite_Generic",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f16"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (ClassicKC, MVC) AND Pilot = Y AND Discount(Reserve1) != 30",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b02"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 7
                    }
                },
                {
                    "xdm:description": "S3:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Members_15",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f17"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (NonKC) AND Pilot = Y AND Discount(Reserve1) = 15",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b03"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 6
                    }
                },
                {
                    "xdm:description": "S4:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Members_20",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f18"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (NonKC) AND Pilot = Y AND Discount(Reserve1) = 20",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b04"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 5
                    }
                },
                {
                    "xdm:description": "S5:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Members_30",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f19"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (NonKC) AND Pilot = Y AND Discount(Reserve1) = 30",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b05"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 4
                    }
                },
                {
                    "xdm:description": "S6:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "NONKC",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f20"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (NonKC) AND Pilot != Y",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b06"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 3
                    }
                },
                {
                    "xdm:description": "S7:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Credit_30",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f21"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group in (ClassicKC, MVC, Unmatched) AND Pilot != Y AND Discount(Reserve1) = 30",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b07"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 2
                    }
                },
                {
                    "xdm:description": "S8:",
                    "xdm:placements": [
                        "xcore:offer-placement:6111463157c2221"
                    ],
                    "xdm:optionSelection": {
                        "xdm:description": "Credit_Generic",
                        "xdm:options": [
                            "xcore:offer:f6998eb62ed6f22"
                        ]
                    },
                    "xdm:profileConstraints": {
                        "xdm:description": "Tender Group = ClassicKC OR MVC OR NULL OR Unmatched AND Pilot != Y AND Discount(Reserve1) !=30",
                        "xdm:eligibilityRule": "xcore:eligibility-rule:f65212b6b3c0b09"
                    },
                    "xdm:ranking": {
                        "xdm:priority": 1
                    }
                }
            ]
        }
    ]
}