Add Keywords to KPs/Service Offerings in bulk via ETM?

There is functionality to create both keywords for Knowledge Procedures and Service Offerings.

These are known as knowledgeProcedureEntities and serviceOfferingEntities in the REST API:

/assystREST/v2/knowledgeProcedureEntities/raml/1.0/?showDetail=true  

/assystREST/v2/serviceOfferingEntities/raml/1.0/?showDetail=true

However, when performing data mapping, you have to specify both the entity ID (the primary ID of the specific entity you want to add) and the entityType, an integer value that represents the type of resource the application tries to resolve the entity ID against.

This is a bit tricky, as I’ve found no way to extract the name of the resource using field expansion in the API. The only method I’ve found so far is to add an entity of a type using the GUI, and then use the REST API to check what entityType this new knowledgeProcedureEntity has.

I’ve compiled a list of entityType values and their corresponding resources as uncovered in our Assyst 24R2 installation:

0: "Free Text"
3: "Section"
4: "Department"
5: "Building"
6: "Room"
7: "Product Class"
8: "Product"
9: "Item"
10: "Category"
14: "Service Department"
17: "Site"
18: "Site Area"
19: "Territory"
20: "Branch"
21: "Division"
22: "Company"
23: "Generic Class"

During my exploration i also made an iterative channel that create one of each of knowledgeProcedureEntity type on a target Knowledge Procedure. The initialization datamapper contains the same list, and sets the entity id to be added to be the first (id 1) from each type. 

I ‘havent tested serviceOfferingEntities but the process seems to be the same based on the REST API. 

Hope this can be of some use

Hi, ​@jyork 

There is functionality to create both keywords for Knowledge Procedures and Service Offerings.

These are known as knowledgeProcedureEntities and serviceOfferingEntities in the REST API:

/assystREST/v2/knowledgeProcedureEntities/raml/1.0/?showDetail=true

/assystREST/v2/serviceOfferingEntities/raml/1.0/?showDetail=true

I’m by no means an expert in this field, but i can share what i now know after some tests from this weekend. 

When performing data mapping, you have to specify both the entity ID (the primary ID of the specific entity you want to add) and the entityType, an integer value that represents the type of resource the application tries to resolve the entity ID against.

This is a bit tricky, as I’ve found no way to extract this entityType information from the entity resource using field expansion in the API. The only reason I’ve gotten this far was by adding an entity of a given type using the GUI, and then use the REST API to check what entityType this new knowledgeProcedureEntity was given.

I’ve compiled a list of entityType values and their corresponding resources as uncovered by tests in our Assyst 24R2 installation:

1: "Free Text"
3: "Section"
4: "Department"
5: "Building"
6: "Room"
7: "Product Class"
8: "Product"
9: "Item"
10: "Category"
14: "Service Department"
17: "Site"
18: "Site Area"
19: "Territory"
20: "Branch"
21: "Division"
22: "Company"
23: "Generic Class"

Datamapping:

I’ve tried to get this to work with KP and ServOff keywords, and they both seem to use the same integers in entityType mapping.

While I’ve been able to actualy add KP Keywords using ETM I’ve had some issues doing the same for ServOff as there are some differences in the available ETM fields between KP and ServOff (This is at least the case in IPaas 1.8).

• KP has most of the usual ETM fields. In creation of a keyword you need the following.
  • Knowledge Procedure (ID of the knowledge procedure to add keywords to)
  • Entity Type (Integer). The value as supplied in the list above.
  • Entity Id (Integer). The primary id of the resource you want to be linked as  a keyword.
    • During testing this was set to 1 as to just get the first entry of each resource type. Dynamicaly adding the correct id based on type should be possible but I’ve not spent time further testing that.
    • Free text Keywords always have an entityId=0 and setting a different value, or not including for these has both no affect on the resulting Keyword. 
  • Free Text (String). freeText in the API.
    • No inference is attempted for Entity Type if Free text field is included in datamapping. Entity Type must be explicity set to entityType=1. 
    • While it is only relevant if adding Keywords of type Free Text, the inclusion of it has no effect on other entity types.
• ServOff has a field type i’ve no experience using, and I’ve so far not been able to test this adding other Keywords than Free Text to Service Offerings. 
  • Service Offering. (ID of serviceOffering the keywords are added to). 
  • Entity Type (Integer). Same as above. 
  • Entity (assystBase) There is no Entity Id field available in ETM. 
    • Entity has an additional message in the GUI: “Search not supported by assyst. An expression must be used.”  and I haven’t gotten the hang of what syntax this ETM datamapping field expects. 
  • Free Text (String). Free Text can be added without using the entity datamapper field, and works just the same as for KP.  

I hope this can be of some use