Quick start

This section contains information about how to log into the application and what will see after user login.

 Login

Once you point your browser to http://YOUR_SERVER_IP:3000 you will see the application login page. This page is the first shown to the user when you point your browser to the application.

You should use your Openkm login and password in order to get access to the application:

If the login and password are correct you will enter the application 

If the login or password are not correct you will see an error 

Login credentials are stored into import-station.cfg file (only if okm.system.user are empty). This user will be used to schedule periodic tasks after system reboot.

If you want to change this user just leave empty both okm.system.user and okm.system.password properties.

Main page

This is the first page we will see after login into the application. The main page of the application contains a table showing every task registered in the system with the state and possible actions.

The table contains the following information:

FieldDescription
Type

On demand or scheduled

Name Task name 
State

State of the task.

StateDescription
Stopped

The task it's not scheduled in the system and it's not running neither

Scheduled  The task is scheduled in the system using cron expression
 Running  The task is running in the system
 Error Blinking element. Indicates that there is an error in an execution 

 

Processor Plugin to be executed in the task.

Depending on which plugins have configured this list will vary.

Actions List of actions to operate with this task.
ActionDescription
Run

This action launch the task. If it's periodic it will be scheduled. If it's not, it will be executed only once.

Edit

Change task proeprties. You could also change the plugin to execute.

A user only can change task properties when a task is Stopped

Stop Stop and unschedule (if it's periodic) task.
Delete

Delete task.

A user only can delete task when a task is Stopped

CSV Report Get a report in csv format of every execution and execution event between two dates.
View executions View execution and execution events for each task. See Manage task executions section

If you have any execution problem on any task you will see this message: 

You have executions with errors. Please check them. 

 This message is shown to indicate the user that something went wrong and you should fix it. 

There is a Refresh button in the main page. It's used to realod the page to see current status of each task.

Table of contents [ Hide Show ]