Working with Report Generator 3 Client

Report Generator 3 Client

Requirements

1. Linux or any Linux based system
2. PHP 5.2 or higher

Installation

NOTE: Default Miners that are chipped with RG3C are built to work with Xinet Webnative logs. It is recommended to install RG3C on Webnative server.

1. Obtain an archive with RG3C from NAPC ftp server
2. Extract archive to any folder on your server (it does not have to be web accessible)
3. Set extracted folder permissions to 0755 (chmod –R 0755 )
4. Navigate into that folder
5. Run configuration script (./config)

Endpoint server configuration

Endpoint server configuration allows you to connect your RG3C to your Report Generator 3 account. Check RG3 documentation for more info on how to get API Key, required for that.

NOTE: The following steps are mandatory

1. In the Main Menu input “1” and hit Enter. This will open Endpoint Server Configuration Menu.

2. In the Endpoint Server Configuration Menu input “1” and hit Enter.

3. Input RG3 URL and hit Enter.

NOTE: Make sure url is valid and contains proper schema (http, https, etc).

4. In the Endpoint Server Configuration Menu input “2” and hit Enter.

5. Input RG3 API Key obtained from RG3 Application and hit Enter.

6. Now back in Endpoint Server Configuration Menu you can input “3” and hit Enter to test connection. If everything was setup correctly, you will see the following message:

7. Input “0” and hit Enter to go back to Main Menu

Configure Miners

In the Main Menu input “2” and hit Enter. You will see Miners Menu.

Here you can enable/disable miners, change execution time or edit amount of lines, miner reads from its source during single run or change miner configuration.

NOTE: Miners List may differ depending on which miners you have.

1. Enable/Disable Miner

a. In the Miners Menu input “1”and hit Enter

b. Input required miner id (from the list of miners) and hit Enter

c. Input “1” to Enable or “2” to Disable miner and hit Enter

2. Change Execution Time

a. In the Miners Menu input “2” and hit Enter

b. Input required miner id (from the list of miners) and hit Enter

c. Enter new execution time.

• NOTE: Execution time is specially formatted value, readable by CRON. Default value is “0, 30 ” which corresponds to 30 minutes. Example value “/1 *” corresponds to 1 minute. More information about CRON formatting can be found here.

• NOTE: We recommend setting execution time to one minute during RGC3 configuration and testing.

3. Change Read Lines Number

a. In the Miners Menu input “3” and hit Enter

b. Input required miner id (from the list of miners) and hit Enter

c. Enter new read lines number

• NOTE: Read Lines Number contains maximum amount of rows of data that miner can send to RG3 in one chunk.

4. Change Miner Config

a. In the Miners Menu input “4” and hit Enter

b. Input required miner id (from the list of miners) and hit Enter

c. You will see the list of configuration parameters for current miner

• NOTE: Not all miners have configuration parameters

d. In order to change parameter value input “1” and hit Enter

e. Input name of parameter, you want to edit and hit Enter

f. Input new value and hit Enter

Run All Enabled Miners

1. In the Main Menu input “3” and hit Enter. This will force run all enabled miners. Information, collected by miners will be immediately available in RG3. The feature is useful during RG3C setup and configuration. PIC14

Update Client Application

1. In the Main Menu input “4” and hit Enter. This will open Update Client Application Menu

2. If new version is available, input “1” and hit Enter. This will start an update process

NOTE: Application will quit successful update to apply changes.