Skip to content

Commit ed066aa

Browse files
Jordan HeasmanGitHub Enterprise
authored andcommitted
Merge pull request #6576 from AdobeDocs/PLAT-244714-XDM-Schema-API-Tutorial-UI-Validation-Section
[PLAT-244714] Add UI Validation Section to XDM Schema API Tutorial[READY]
2 parents 1edd2bc + e4cf91d commit ed066aa

File tree

5 files changed

+46
-0
lines changed

5 files changed

+46
-0
lines changed
257 KB
Loading
249 KB
Loading
260 KB
Loading
146 KB
Loading

help/xdm/tutorials/create-schema-api.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1362,6 +1362,52 @@ The response is a filtered list of schemas, containing only those that satisfy b
13621362
}
13631363
```
13641364

1365+
## Use the UI to validate your schema {#validate-in-ui}
1366+
1367+
Use the Experience Platform UI to validate that the schema you created through the [!DNL Schema Registry] API has the correct structure, properties, and identity configuration. Follow these steps:
1368+
1369+
### Locate your schema
1370+
1371+
To begin, navigate to **[!UICONTROL Schemas]** > **[!UICONTROL Browse]**. Use the text input field to search for the schema name (for example,`Campaign Member`) and select the schema name from the table.
1372+
1373+
![Schemas browse view with the text input field highlighted to search for and select your schema.](../images/tutorials/create-schema/schemas-browse.png)
1374+
1375+
### Confirm the schema structure
1376+
1377+
The schema canvas displays the full structure of your schema. Verify that:
1378+
1379+
* All standard field groups that you added appear in the canvas.
1380+
* Your custom field group appears in the structure and is expanded to show its fields.
1381+
1382+
![The schema canvas displaying the full schema structure with standard and custom field groups expanded.](../images/tutorials/create-schema/schema-canvas.png)
1383+
1384+
### Review schema properties
1385+
1386+
Next, select the schema root node to open the **[!UICONTROL Schema properties]** panel and confirm the key metadata:
1387+
1388+
* Schema `$id`
1389+
* Display name
1390+
* Profile enablement status
1391+
1392+
The `$id` should match the value returned in your API response.
1393+
1394+
>[!NOTE]
1395+
>
1396+
>The assigned class (**[!UICONTROL XDM Business Campaign Members]** in this example) is displayed in the left **[!UICONTROL Composition]** panel.
1397+
1398+
![The Schema Editor view with the schema root selected and the Schema properties panel open to review key metadata.](../images/tutorials/create-schema/review-schema-properties.png)
1399+
1400+
### Validate identity fields
1401+
1402+
Each identity field added to the schema is listed in the **[!UICONTROL Identities]** section of the **[!UICONTROL Composition]** panel. Select an identity field to display its properties in the right panel. For each identity field, confirm:
1403+
1404+
* The identity namespace is correct.
1405+
* The field is marked as the primary identity when applicable.
1406+
1407+
![Composition panel Identities section with an identity field selected and its identity properties shown in the right panel.](../images/tutorials/create-schema/identitiy-confirmation.png)
1408+
1409+
If the structure, properties, and identity configuration match your API configuration, you have successfully created and configured the schema through the [!DNL Schema Registry] API.
1410+
13651411
## Next steps
13661412

13671413
By following this tutorial, you have successfully composed a schema using both standard field groups and a field group that you defined. You can now use this schema to create a dataset and ingest record data into Adobe Experience Platform.

0 commit comments

Comments
 (0)