3.Application Usage

Main drop-down menu at the top left corner leads to 3 pages: “New project”, “Open saved project”, “Projects monitoring”.

3.1Projects Monitoring

First and main page is a general monitor of all saved projects. You can see their status and details or delete any of unwanted or irrelevant projects.

At the first run, the page will appear with empty fields:

When you will have several projects performed, your Project Monitoring page will show the details and possible actions.

You can edit the project, delete it, or download project related materials. You can download separately indexes, templates, logs, or everything together.

The “Status” column has color-coded options which correspond to standard Elasticsearch classifications:

• Red – FAILED
• Green – SUCCEDED
• Yellow – ON FLY
• Grey – NEW/STOPPED

3.2New Project

In order to start a new project, you need to choose “New project” from main drop-down menu.

This will redirect you to “Project settings” page.

Fields marked * are mandatory. The rest of parameters are chosen according to your needs and project configuration requirements.

3.2.1Source

First step is to indicate Host and set basic parameters. The Applications gives opportunity for user authentication and/or to include SSL certificate, if required.

• a.Host may be in format: http(https)://__HOST_OR_IP__:PORT
• b.If you have a need for user authentication, you may mark the checkbox “Use authentication” and define the username and password.
  
  

  NOTE: The Application doesn’t save your passwords in the configuration files, so after application restart, you’ll require to provide the password again.

• c.If your cluster supports the secure connection (https), you have to mark the “SSL” checkbox.
  
  

  If you provide the SSL certificate, it will be used for secure connection to your cluster. Otherwise, the Application will set up connection to ignore SSL verification.

• d.In order to test connection with your Elasticsearch cluster press “Test” button. When testing process will finish you receive the cluster status.
  
  

  The status button can appear in 3 colors depending on test result: Red/Yellow/Green. Those are standard Elasticsearch cluster statuses.

3.2.2Input settings

You need to insert the name of your index or index pattern in the required “Index for analyze” field.

You can choose maximum number of docs for analyze. Thus, you are limited only to the number you indicated, or to the actual number of docs there are. In “Scroll size” filed you can indicate the desired size of information bulk to be analyzed.

The default numbers appearing automatically in those fields, are representing the most common and best practice only.

3.2.3Actions

By choosing one of the Actions options you can generate a ready template or a ready index. At the end of the process, you will receive a whole file with all the details.

3.2.4Template properties

In “Template properties” settings fields marked * are mandatory. Here as “Template name” you need to insert the future name of the template to be generated.

All “Settings” to be filled are standard Elasticsearch settings. The settings parameters have default values which can be altered according to your Elasticsearch parameters. Indicated Compression and Refresh interval values are representing the most common and best practice only.

Add fields from existing templates

This setting essentially means that you are taking existing template and compare it to the one to be generated. So, in this case the Application is taking an existing template and performs additional actions to it.

Choosing “Add filed from existing templates” checkbox extends the table and provides more parameters to enter:

“Add all fields” – take all fields from existing template and add them to the generated template.

“Add only used top level fields” – top level fields of a file. For example:

You can choose only one of those two checkboxes (“Add all fields” or “Add only used top level fields” as they are mutually exclusive). Other settings described below can be added upon your choice.

Replace existing field types – fields from existing template will be replaced in the generated template.

Add settings – adds index settings from existing template to generated template in addition to new settings of generated template.

Add dynamic mappings – adds dynamic mappings from existing template to generated template.

Generate dedicated template – he application compares generated template to existing one, and generates only those fields that are not present in existing template. This parameter helps to avoid duplications.

Ignore type conflicts – in the case of conflicting field types, the Application will not show it in the log.

Add normalize to all keyword fields

By choosing this checkbox you can add lowercase normalizer for all fields that are defined as keywords.

3.2.5Index properties

Here you need to insert Index name and settings. Settings in this field are essentially similar to corresponding settings of Template properties.

3.3Project Admission

When all settings are indicated, before pressing “Analyze” button there is a need to press “Save”. You will receive an approval in the lower right corner of the page:

When everything is ready, you can press “Analyze” button and you will see in the top left corner indication of started process (“ON FLY”)

Throughout the process in “Mapping changes logs” section you will see results of changes made.

Status and progress of the project you can see at the top left corner of the page.

There you can also see the number of indexed documents. Or “Stop” the whole process.

At the top right you can find download options for the results depends of the selected actions. You can download parts separately or as one file.

You will receive a file like:

3.4Open Saved Project

By picking this category in the main menu, you will go directly to the Project Monitoring page of a specific project chosen.