Segment definition and Segment folder to have identity in identity map

adobe · Sep 9, 2019 · 4fa6f78 · 4fa6f78
1 parent 74c7ebb
commit 4fa6f78
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 18 deletions.
diff --git a/extensions/adobe/experience/audiencemanager/segmentdefinition.example.1.json b/extensions/adobe/experience/audiencemanager/segmentdefinition.example.1.json
@@ -5,5 +5,11 @@
     "xdm:value": "c_contextdata.catname matchesregex \"\"^sony -.+\"\""
   },
   "xdm:segmentFolderId": "1123",
-  "xdm:segmentSubType": "SEGMENT"
+  "xdm:segmentSubType": "SEGMENT",
+  "https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity": {
+    "@id": "1123",
+    "xdm:namespace": {
+      "xdm:code": "AAMSegments"
+    }
+  }
 }
diff --git a/extensions/adobe/experience/audiencemanager/segmentdefinition.schema.json b/extensions/adobe/experience/audiencemanager/segmentdefinition.schema.json
@@ -21,7 +21,8 @@
         "xdm:segmentFolderId": {
           "title": "Folder Id",
           "type": "string",
-          "description": "id of parent folder if present"
+          "description": "id of parent folder if present",
+          "meta:status": "deprecated"
         },
         "xdm:segmentSubType": {
           "title": "Sub Type",
@@ -39,6 +40,11 @@
             "ALGO_TRAIT",
             "ON_BOARDED_TRAIT"
           ]
+        },
+        "https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity": {
+          "title": "Parent folder identity",
+          "$ref": "https://ns.adobe.com/xdm/context/segmentidentity",
+          "description": "Identity of the parent folder of current folder"
         }
       }
     }

diff --git a/extensions/adobe/experience/audiencemanager/segmentfolder.example.1.json b/extensions/adobe/experience/audiencemanager/segmentfolder.example.1.json
@@ -0,0 +1,18 @@
+{
+  "xdm:identityMap": {
+    "AAMSegments": [
+      {
+        "xdm:id": "id123",
+        "xdm:primary": true
+      }
+    ]
+  },
+  "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": "User Folder",
+  "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": "ACTIVE",
+  "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": {
+    "@id": "id1111",
+    "xdm:namespace": {
+      "xdm:code": "AAMSegments"
+    }
+  }
+}
diff --git a/extensions/adobe/experience/audiencemanager/segmentfolder.schema.json b/extensions/adobe/experience/audiencemanager/segmentfolder.schema.json
@@ -0,0 +1,58 @@
+{
+  "meta:license": [
+    "Copyright 2018 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/audiencemanager/segmentfolder",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "Adobe Audience Manager Segment Folder Class",
+  "type": "object",
+  "description": "Adobe Audience Manager Segment Folder Class to define folder structure for segment defintions. This will help in organizing segments in customer preferred hierarchy.",
+  "meta:extensible": true,
+  "meta:abstract": true,
+  "meta:extends": ["https://ns.adobe.com/xdm/data/record"],
+  "definitions": {
+    "segmentfolder": {
+      "properties": {
+        "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": {
+          "title": "Segment folder name",
+          "type": "string",
+          "description": "Name of the segment folder"
+        },
+        "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": {
+          "type": "string",
+          "title": "Segment folder status",
+          "description": "Current status of segment folder",
+          "meta:enum": {
+            "ACTIVE": "Active",
+            "INACTIVE": "Inactive",
+            "DELETED": "Deleted"
+          }
+        },
+        "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": {
+          "title": "Parent folder identity",
+          "$ref": "https://ns.adobe.com/xdm/context/segmentidentity",
+          "description": "Identity of the parent folder of current folder"
+        }
+      }
+    }
+  },
+  "required": [
+    "xdm:identityMap",
+    "https://ns.adobe.com/experience/audiencemanager/segmentFolderName"
+  ],
+  "allOf": [
+    {
+      "$ref": "#/definitions/segmentfolder"
+    },
+    {
+      "$ref": "https://ns.adobe.com/xdm/context/identitymap"
+    },
+    {
+      "$ref": "https://ns.adobe.com/xdm/data/record"
+    }
+  ],
+  "meta:status": "experimental"
+}
diff --git a/schemas/context/identitymap.schema.json b/schemas/context/identitymap.schema.json
@@ -10,7 +10,7 @@
   "title": "IdentityMap",
   "type": "object",
   "meta:extensible": true,
-  "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile", "https://ns.adobe.com/xdm/context/experienceevent"],
+  "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile", "https://ns.adobe.com/xdm/context/experienceevent", "https://ns.adobe.com/xdm/context/segmentdefinition", "https://ns.adobe.com/experience/audiencemanager/segmentfolder"],
   "description": "Defines a map containing a set of end-user identities, keyed on either namespace integration code or the namespace ID of the identity.  The values of the map are an array, meaning that more than one identity of each namespace may be carried.",
   "definitions": {
     "identitymap": {

diff --git a/schemas/context/segmentdefinition.example.1.json b/schemas/context/segmentdefinition.example.1.json
@@ -1,13 +1,15 @@
 {
-    "xdm:segmentIdentity": {
-        "@id": "id123",
-        "xdm:namespace": {
-            "xdm:code": "AAMSegments"
-        }
-    },
-    "xdm:segmentName": "Users with TV segment",
-    "xdm:description": "Segment is about users who have TV",
-    "xdm:segmentStatus": "ACTIVE",
-    "repo:createDate":"2018-10-23T12:00:00-06:00",
-    "repo:modifyDate":"2019-03-21T12:00:00-06:00"
-}
+  "xdm:identityMap": {
+    "AAMSegments": [
+      {
+        "xdm:id": "112233",
+        "xdm:primary": true
+      }
+    ]
+  },
+  "xdm:segmentName": "Users with TV segment",
+  "xdm:description": "Segment is about users who have TV",
+  "xdm:segmentStatus": "ACTIVE",
+  "repo:createDate":"2018-10-23T12:00:00-06:00",
+  "repo:modifyDate":"2019-03-21T12:00:00-06:00"
+}
diff --git a/schemas/context/segmentdefinition.schema.json b/schemas/context/segmentdefinition.schema.json
@@ -22,7 +22,8 @@
         "xdm:segmentIdentity": {
           "title": "Segment Identity",
           "$ref": "https://ns.adobe.com/xdm/context/segmentidentity",
-          "description": "Identity of the segment"
+          "description": "Identity of the segment",
+          "meta:status": "deprecated"
         },
         "xdm:segmentName": {
           "title": "Segment name",
@@ -53,13 +54,16 @@
     }
   },
   "required": [
-    "xdm:segmentIdentity",
+    "xdm:identityMap",
     "xdm:segmentName"
   ],
   "allOf": [
     {
       "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
     },
+    {
+      "$ref": "https://ns.adobe.com/xdm/context/identitymap"
+    },
     {
       "$ref": "https://ns.adobe.com/xdm/common/auditable"
     },
@@ -71,4 +75,4 @@
     }
   ],
   "meta:status": "experimental"
-}
+}