Configuring CUE

To make CUE use CUE Semantic:

1. Log in as root.

2. Copy the example file included with the distribution of CUE located in /etc/escenic/cue-web/public/Semantic.yml and uncomment all the lines. The example file has this content:

   enrichmentServices:
     - href: "http://semantic-service-host/"
       name: "Extract Semantic Entities"
       title: "Extract Semantic Entities"
       triggers:
         - name: editor-recurring
           properties:
             interval: 10
             timeout: 20
   editors:
     metadata:
       - name: 'cue-semantic-metadata-panel'
         directive: 'cue-semantic-metadata-panel'
         cssClass: 'semantic'
         title: 'Semantic Analysis' #translate
         mimeTypes: ['x-ece/story', 'x-ece/new-content; type=story']
         args: "[content]='ngModel.resource.data' [content-values]='ngModel.resource.data.values' [lock-helper]='ngModel.lockHelper' [locks]='ngModel.lockHelper.locks'"
         requires: ['escenic']
         order: 850
         isAngular: true
         capability: 'cue.metadata.semantic'
   semanticEntityTypes:
     - name: PER
       tagScheme: tag:person@escenic.com,2017
       title: Persons
     - name: LOC
       tagScheme: tag:location@escenic.com,2017
       title: Locations
     - name: ORG
       tagScheme: tag:organization@escenic.com,2017
       title: Organizations
     - name: TTL
       tagScheme: tag:title@escenic.com,2017
       title: Titles
     - name: FAC
       tagScheme: tag:facility@escenic.com,2017
       title: Facilities
     - name: REL
       tagScheme: tag:religion@escenic.com,2017
       title: Religion
     - name: NAT
       tagScheme: tag:nationality@escenic.com,2017
       title: Nationalities
     - name: CON
       tagScheme: tag:concept@escenic.com,2017
       title: Concepts

   Replace semantic-service-host with the host name or IP address of the host on which you installed CUE Semantic.

3. You may then want to modify the entries highlighted in bold:

   interval

   This property determines how frequently CUE Semantic requests new tag suggestions from the external service, specified in seconds.

   timeout

   This property determines how long CUE Semantic waits for a response from the external service before a "can't connect" message is displayed in the CUE Notification Center.

   semanticEntityTypes

   This entry contains an array of name / tagScheme / title properties that map the suggestions returned by the external service to Content Store tag schemes. Atilika concepts/DC categories are returned under the name CON. Atilika/DC entities are returned under the following names:

   • PER (persons such as Nelson Mandela, Donald Trump, etc.)

   • LOC (locations such as Africa, Spain, New York, Chelsea)

   • ORG (organizations such as companies, charities, political parties and so on)

   • TTL (titles such as Mr, Dr, Sir etc. – from Atilika only)

   • FAC (facilities such as hotels, sports grounds, theatres, universities, shopping malls – from Atilika only)

   • REL (religions – from Atilika only)

   • NAT (nationalities such as Irish, Indian, Australian – from Atilika only)

   You can map each of these categories onto a separate tag scheme, or map multiple categories onto the same tag scheme if you wish, as is the case for TTL, FAC, REL and NAT in the example shown above. You can also choose to ignore a category by omitting a mapping for it. If, for example, you remove:

   - name: TTL
     tagScheme: tag:entity@escenic.com,2017
     title: Titles

   from the example given above, then the TTL category will be ignored and no title tag suggestions will appear in CUE.

   When using an Atilika back end, concepts (CON) (if used) should always be mapped to their own tag scheme that is not used for any other purpose. This is because tags in this tag scheme are the ones returned to Atilika as feedback.

   The tag schemes you reference in this section must already exist in the Content Store. For information on how to create tag schemes, see Manage Tag Structures.

4. Save your changes.

You will also probably want to change where the Semantic Analysis section appears in the metadata panel. You can control what sections appear in the metadata panel and the order in which they appear on a per-content type basis. For information on how to do this, see Metadata Panel Sections. The name to use for the Semantic Analysis section is cue-semantic-metadata-panel, as defined in /etc/escenic/cue-web/public/Semantic.yml (above).