Attivio v5.6 Documentation
Page tree
Skip to end of metadata
Go to start of metadata

Quick Start

The following exercise builds on the Attivio Quick Start tutorial to walk through some common configuration changes that can be made to Search UI. We'll configure fields, add facets and make a number of other cosmetic changes and deploy those changes to the Factbook project.

1. Deploy the Attivio Factbook Project

Open the Attivio Quick Start Tutorial in a new tab in your browser, follow the instructions to deploy the Factbook project, and return to this page when complete.

2. Copy the configuration.properties.js file to the project directory

By default, the configuration.properties.js file used by Search UI is placed in the <INSTALL_DIR>/resources/searchui directory. Instead of editing the file in this location, it is recommended that you copy the file to the same relative path under your project's home directory. The file in the project directory will be used in preference to the file in the installation directory, leaving the original version intact.

Attivio project directories include a <PROJECT_DIR>/resources directory by default, but you will need to create the <PROJECT_DIR>/resources/searchui sub-directory. Once you have done so, copy the file found at

<INSTALL_DIR>/resources/searchui/configuration.properties.js

to the new sub-directory:

<PROJECT_DIR>/resources/searchui/configuration.properties.js

3. Edit configuration.properties.js

Open the <PROJECT_DIR>/resources/searchui.configuration.properties.js file in a text editor.

    Remove the comments from the following lines in the file:

          // spokenLanguage: 'Spoken Languages',
      // resource: 'Resources',
      // climate: 'Climate',
      // ethnicity: 'Ethnicities',
      // country: 'Country', 

    Locate the following block of code:

        facets: [
      'position',
      'keyphrases(maxbuckets=15)',
      'table',
      'tags',
      'company',
      'people',
      'location',
      'date(sortby=VALUE,maxbuckets=60,dateIntervals=auto)',
    ], 

    Modify the above block of code to match the following:

        facets: [
      'position',
      'keyphrases(maxbuckets=15)',
      'table',
      'tags',
      'company',
      'people',
      'location',
      'date(sortby=VALUE,maxbuckets=60,dateIntervals=auto)',
	  'spokenLanguage',
	  'resource',
	  'climate',
	  'ethnicity',
	  'country',
      'table(childFacet=country(childFacet=language))',  //adding multi level discrete facets
	//'table(childFacet=.fields(childFacet=size(filter=small(\"size:>120\"))))', //adding schema at level 2 and filter at level 3
    //'size(range=(\"< 150 \",0,150), range = (\"> 150 \",150,600),sortBy=COUNT, primarySort=ASC, minBucketCount=10, childFacet=table)', //range facet with sort and minBucketCount defined.
    ],

    (The childFacet functionality is available in Attivio Platform 5.6.2 and later releases; omit the final three entries above if you are using Attivio Platform 5.6.1.)

    Locate the line of code that begins with:

      SearchUIInsightsPage: {

    Edit the lines of code below this line to match the following:

         pieChartFacets: [ // The facet field names that should be displayed as pie charts
	  'table',
    ],
    barChartFacets: [ // The facet field names that should be displayed as bar charts
	  'company',
	  'people',
	  'location',
	  'spokenLanguage',
	  'ethnicity',
	  'country',
    ],
    columnChartFacets: [ // The facet field names that should be displayed as column charts
	  'resource',
	  'climate',
	  'language',
	  'languages',
    ],

    Remove the comments from the following lines in the file:

        insightGraphLinkingFields: [
...
      // 'country',
      // 'spokenlanguage',
      // 'resource',
      // 'climate',
      // 'ethnicity',
    ],

    Save and close the file.

    4. Deploy the changes

    We've made several changes to the Search UI configuration. We must open the CLI and deploy these changes and restart our project to apply these changes.

      Open the AIE-CLI

      <install-dir>/bin/aie-cli -p C:\attivio\projects\Factbook 

      Deploy our changes and trigger a restart of the node. Type the deploy command and hit Enter.

      Once the CLI reports the node as RUNNING again, move onto the next step. You can monitor the project by executing the status command.

      5. View the changes in Search UI

      • Navigate to http://localhost:17000/searchui/ (or click the Administrator UI's Query > Search UI menu link) in your web browser to open the Search UI web application.
      • Log in with username  aieadmin  and password  attivio  when prompted.
      • On the left hand side, Multi level facets can be seen for table facet. Click on the child facets and we can see how the documents are filtered further.






      •     Click the Insights button in the header to access the Insights page. You should see multiple bar and column charts, including those which display the additional fields we exposed such as country, spokenlanguage, resource, climate, and ethnicity.


      •    Click the Results button, then select the country value of the Table facet. Notice the additional fields are displayed to the right of each result:

              

      •  Click the Show 360° View link under one of the country results. You can see the eefect our changes had on the Knowledge Graph, linking documents which share values for the additional fields we configured.


            

      What Next?

       

       

      • No labels