Use Smart Analytics Assistant

User Role: Administrator

Smart Analytics Assistant (SAA) is a built-in tool that enables 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 SAA interface, there is a command line to enable the administrator to send IDOL actions to IDOL components. The most frequently used actions are 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.

To use Smart Analytics Assistant, follow these steps:

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

2. Use Smart Analytics Assistant to perform the administrative tasks . For example, you can select an action from the drop-down list.

   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 appropriate for backing up an individual database. If you want to back up all databases on 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 the path and basic file name. 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 Backup Component action. It could be the Content, Category, or 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 you restore the 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 IP address of the client 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. Indicates whether all components are up and running; indicates how many documents are stored 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 server 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

     Tip To view the status for different Smart Analytics components, instead of using the action command, you can easily click the component link on the Smart Analytics Assistant form.

   • 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. After you add the new content servers, click the Redistribute link in saa to redistribute data among all Smart Search content servers.

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