Use Smart Analytics Assistant

User Role: Administrator

Smart Analytics Assistant is a build-in tool that enable administrators to interactively perform IDOL administrative actions in Smart Analytics. For example, you can use this tool for content server maintenance, system status checking, and troubleshooting.

In the interface, there is a command line to enable the administrator to send IDOL actions to IDOL components. The most frequently used actions have been included in the drop-down list. You can get more actions and information from IDOL reference guides.

Service Manager provides five blocks to fulfill different functionality. For each component in all blocks, you can click the underlined name to get detail status.

Block	Description
Main Proxy	Top level proxy status that shows component name, host, port, and status. If any component is down, you need further investigation.
Smart Ticket and Hot Topic content	By default, one content store is used for Smart Ticket and Hot Topic Analytics. It must always be online. If you need more content store to host more databases, you can click the “Add” link. The content store to be added to the system has to be installed and running in another machine.
Smart Search Proxy	The second level proxy that is dedicated to Smart Search. Only DAH and DIH are included in this proxy.
Smart Search Content	By default, two content stores are used for Smart Search. You can add more content stores by clicking the “Add” link. The content store to be added to the system has to be installed and running in another machine.
Image Server	By default, one image server is installed for OCR purpose. If you want to improve performance, you can add more image servers. The content store to be added to the system has to be installed and running in another machine.

To use Smart Analytics Assistant, follow these steps:

1. Type saa in the command line, and then press Enter. The Smart Analytics Assistant interface is launched.

2. Select one of the actions for Smart Analytics from the drop-down list, or typing an action.

   Note Replace <Host>, <port>, <variable_value> in the following action examples with the corresponding values that you can find from the corresponding status blocks.

   • Backup Component

     Creates a backup that can be used to restore the component’s state. You can use this action for the Content, Category, Agent and Community components, but you must send the action to the component ACI port, rather than to the IDOL Proxy port. The backup file is stored in the path that you specified.

     For example, to backup category,

     http://<Host>:<CategoryPort>/action=BackupServer&path=c:\backup_category

     Note By default, the Smart Analytics server CategoryPort is 9020.

   • Backup Database

     Exports all the index documents of a database from the Smart Analytics content server to a series of compressed files in the defined backup directory. This action is suitable to backup an individual database. If you want to backup all databases in a content server, use the action Backup Component as mentioned above.

     Action example:

     http://<Host>:<indexPort>/DREEXPORTIDX?filename=c:/BackupFolderName/FilePrefix&DatabaseMatch=<Database_name>&HostDetails=true

     Note In this example, the filename is a combination of path and basic file name. Please make sure you specify parameter DatabaseMatch=DatabaseName.

   • Restore Component or Category step 1

     Imports backup files of component that was backed up by using the action Backup Component. It could be Content, Category, and Community component. For the Category component, you need an extra step to synchronize it.

     Action example:

     http://<Host>:<CategoryPort>/action=RestoreServer&filename=c:\backup_category\***.zip

   • Restore Category step 2 - Synchronize

     After restore category component, you need to synchronize and build the category.

     Action example:

     http://<Host>:<MainProxyACIPort>/action=CategorySyncCatDRE

     Note By default, the port number is 9000.

   • Restore Database

     Restores the index IDX exported before. If no DREDbName is specified, use the dbname of the indexed file.

     Action example:

     http://<MainProxyHost>:<IndexPort>/DREADD?c:\\path\to\<xxx.idx>&DREDbName=<variable_value>&CreateDatabase=True

     Note By default, the port number is 9001.

   • View Index Status

     Checks the status of index actions in the Smart Analytics index queue.

     Action:

     http://<Host>:<port>/action=indexerGetStatus

   • View Action History

     Displays a log of requests, including the date and time that a request was made, the client IP address that made the request, and the internal thread that handled the action.

     Action example:

     http://<Host>:<port>/action=GRL&format=xml

   • View Root Category Detail

     Displays the root categories after training.

     Action example:

     http://<Host>:<port>/action=CategoryGetHierDetails

   • View Status

     Requests details about all components. Check whether all components are up and running; check how many documents are in each database.

     Action example:

     http://<Host>:<port>/action=GetStatus

     Note If any component is offline, check the corresponding log file and fix it to bring it online. During indexing, the DIH periodically checks whether all the connected content servers are available. If a content is unavailable, the DIH queues the data that this content server normally receives, and when the content server starts operating again, the DIH indexes the queued data into it.

   • Show Smart Search content server status

     Displays the status of the Smart Search content server.

     Action example:

     http://SmartSearchProxyHost:DIHPort(20080)/action=EngineManagement&EngineAction=showstatus

   • Add Smart Search Content servers dynamically

     To add a Smart Search content server dynamically, follow these steps:

     1. Run the following action:

        http://SmartSearchProxyHost:DIHPort(20080)/action=EngineManagement&EngineAction=Add&Host=ContentServerHost&Port=ContentServerPort&weight=1

     2. Run the following action:

        http://SmartSearchProxyHost:DAHPort(20070)/action=EngineManagement&EngineAction=EngineAdd&EngineHost=ContentServerHost&EnginePort=ContentServerPort

     3. Repeat previous steps until all content servers are added.

     4. Click the Redistribute link in saa to redistribute data among all Smart Search Content servers after you add the new content servers.

3. Click Run. The result of the action is displayed.