Returning Persistent ID in the CA NIM UM Response for Fields of Type CA SDM SREL
CA NIM UM for CA SDM was designed to return the Persistent ID (instead of the ID) of the fields that are of type CA SDM SREL. By default CA SDM does not always return the values for these fields using the Persistent ID, and so the CA SDM concept known as Dot Notation is being used to return the Persistent ID.
nimum20
CA NIM UM for CA SDM was designed to return the Persistent ID (instead of the ID) of the fields that are of type CA SDM SREL. By default CA SDM does not always return the values for these fields using the Persistent ID, and so the CA SDM concept known as Dot Notation is being used to return the Persistent ID.
In CA NIM UM user interface, the mappings have been defined between the CA NIM UM field, and the CA SDM field found within the user object. CA NIM UM actually uses Dot Notation behind the scenes for several of these fields, and the list of fields, with how to use Dot Notation for each field, have been defined within two properties files:
- ...ca-nim-UM/WEB-INF/config/casdm/SDMDotNotationPrefix.properties (Going forward, this file will be referred as Prefiix.properties)
- ...ca-nim-UM/WEB-INF/config/casdm/SDMDotNotationSuffix.properties (Going forward, this file will be referred as Suffix.properties)
Prefix.properties and Suffix.properties help define which CA SDM fields for which objects (user, comment, or attachment), Dot Notation will be used. The only difference between the two files is that Prefix.properties defines the Dot Notation that is used at the start the CA SDM field, and Suffix.properties defines the Dot Notation that should be used at the end of the CA SDM field. If you open up either of the files, you will see a list of lines, with each line being in the following format:
<CA SDM Factory/Object>
|<CA SDM Field that is Mapped>=<Dot Notation To Be Used>
- <CA SDM Factory/Object> -Refers to the CA SDM Factory/object that contains the mapped CA SDM field (example in = user, alg = comment, attmnt = attachment, cnt = contact)
- <CA SDM Field that is Mapped> -Refers to the CA SDM field that is mapped within the CA NIM UM user interface for users, or defined within ..ca-nim-UM/WEB-INF/fieldMappings/casdm-FieldMappings.xml for comments and attachments.
- <Dot Notation To Be Used> -Refers to the CA SDM factory/object or CA SDM field that should be used in the dot notation. Depending on which properties file you open, this dot notation will precede, or will proceed the CA SDM Field that is mapped.
For example,
in Suffix.properties you see the following line:
cnt|location=persistent_id
This means that whenever a request is sent to CA NIM UM to retrieve the value of the CA SDM field cnt|location for the user object, CA NIM UM will tell CA SDM to return the Persistent ID, by using the following Dot Notation:
cnt|location
Similarly,
in Prefix.properties you see the following line:
attmnt|persistent_id=attmnt
This means that whenever a request is sent to CA NIM UM to retrieve the value of the CA SDM field
persistent_id,
for the attachment object, CA NIM UM will tell CA SDM to return the Persistent ID of the attachment object, by using the following Dot Notation:attmnt.persistent_id
This may look redundant, but CA NIM UM starts out looking in the CA SDM factory/object
lrel_attachments_requests
for attachments, so that CA NIM UM understands which attachments belong to which requests.Returning Persistent IDs for Custom CA SDM Fields
If custom CA SDM fields have been added to the user schema, and they are of CA SDM type SREL, then you may add additional fields to either of these properties files to ensure that CA NIM UM returns the Persistent ID for these custom fields. Just use the same format as mentioned above. You may define the same field within both the Suffix.properties and Prefix.properties files, but you may not define the same field more than once within the same file.