addCategoryAdminSysKey
- Description
- This transaction adds an administration system key, also referred to as a native key, for a given category. The system can receive category updates from external administration systems that are the system of record for category information. When a category is added, the system assigns it a unique number, or key. This transaction provides the facility to associate the CategoryId, or key, used by the external administration system to the unique number (key) assigned by the system. Note that you can also use the addCategory coarse-grained transaction to add administration system keys for a given category.
- Web Services
- Operation name: addCategoryAdminSysKey
- Example
- A category is added to the system using the addCategory transaction and assigned the CategoryId 123456. Using the addCategoryAdminSysKey transaction, you can assign the back office administration system's Term Category number, IT1234, with this category.
- Usage information
- The administration system key can be entered using one or more
partial keys. All partial keys are case sensitive.
A category may have administration system keys from more than one external system, but within a category hierarchy, it can only have one administration system key for each external administration system.
A given native key in an external system must correspond to only one category, as identified by the CategoryId, within a category hierarchy.
For example, the native key 2233 in the organization's external legacy system corresponds to the category named "Savings" with the CategoryId 98765 in the Product Category Hierarchy. This native key cannot correspond to any other category in the same hierarchy, including those that have the same category name.
The same native key can only be added to another category if that category belongs to a different category hierarchy.
- Preconditions
- A category must exist in a category hierarchy.
Administration system type must exist.
- Mandatory input
-
- CategoryId
- AdminSystemType
- CategoryAdminSysKeyPartOne
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- Not applicable
- Request message
<TCRMTxType> addCategoryAdminSysKey
<TCRMTxObject> CategoryAdminSysKeyBObj
<TCRMObject> CategoryAdminSysKeyBObj
- Response objects
- CategoryAdminSysKeyBObj
- Special note
- Not applicable