Map a Canonical Business Object to a Custom Business Object

You can prepare your system for third-party integrations with a custom Business Object by mapping a canonical Business Object Schema to your custom Business Object Schema. You can then use the Canonical REST API to programmatically access CSM functions for your custom Business Object.

Perform the following steps to map the Business Object Schemas at the Object level:

1. Create a Blueprint.
2. Select a custom Business Object, then click Edit Business Object in the tasks pane.
   The Edit Business Object page appears.
3. Click Bus Ob Properties.
   The Business Object Properties dialog opens.
4. Click Advanced.
   The Advanced Options page appears.
5. In the Attributes section, expand General.
6. Add a canonical API attribute with a null value. The canonical API attribute references a canonical definition that is defined in the Canonical Definitions Manager.
   The format for canonical API attributes is CanonicalAPI.[Version].[BusinessObject]. For example, to map the custom Business Object to the version 1 canonical definition for Incident, type CanonicalAPI.V1.Incident.

   Note: The format for canonical API attributes is case-sensitive.
7. Click OK to return to the Edit Business Object page.

Perform the following steps to map the Fields at the Field level. For each Field in the canonical Business Object Schema, you must specify a mapping to a Field in the custom Business Object Schema:

8. Select the Field, then click Field Properties.
9. Click Advanced.
   The Advanced Options page appears.
10. In the Attributes section, expand General.
11. Add a canonical API attribute, following the case-sensitive format. Use the same canonical API attributes at the Object and Field levels.
12. Type the canonical Field name for the attribute value.
13. Click OK.
14. Repeat steps 8-12 for each Field in the canonical Business Object Schema.
15. Optional: If you are using a Canonical Business Object Schema that requires comments, follow the steps to Map Comments to a Custom Business Object.
16. Publish the Blueprint, then run a Health Check for canonical compliance to ensure your mapping was successful.