KPI

1. Installation & Login
2. KPI Layout
3. KPI List
4. Creating a KPI Page
5. Editing a KPI Page
6. Resizing/Moving KPIs
7. Page Rotation
8. Viewing Modes

Similar to the V5 Reporting Suite and API package, the V5 KPI is installed as a Windows service using Apache Tomcat to host it on a customer’s server. From here, again similar to the reports, the V5 KPI can be accessed by any user connected to the network via a standard internet browser.

The connection format for this would be “http://IP Address:Port #/kpi”, so in this case we will be looking at a locally installed instance of the KPI, so we will connect via “http://127.0.0.1:8181/kpi”.

Once we connect to the KPI service we be asked to log in.

We would log in here using the same username and 4 digit PIN that we would use to log on to any of the other V5 applications.

Once logged in we will see the main KPI page view.

We can take a look at this layout in greater detail below.

Once logged in to the V5 KPI, we can take a look at the general layout and see where our various functions are located.

We can look at these areas as follows:

1. User options – we have a variety of options under this menu here, including page rotation settings and visual options for using the application.
2. Saved KPI Pages – This area will contain all KPIs that the logged in user has created previously.
3. Page Rotation – Using this ‘Play’ button here will automatically turn the application full screen to then rotate through the desired KPI pages that were set under the user options.
4. ‘New Page’ button – Allows us to quickly and easily create new KPI pages.
5. Viewing Area – in this area we will see whichever KPI page that we have selected from the ‘Saved KPI Pages’ list above. So here we have our ‘Production Stats’ KPI page visible.

We can see above that we already have some KPI pages created and saved, but let’s take a look at how we can create a new KPI page to go along with these.

We would start here by clicking the ‘New Page’ button on the left hand side of the screen.

After which we will be taken to the KPI creation screen. We should first enter a name for our new KPI page (required). Let us imagine here that we are creating a KPI page for a Sales Manager, so we will call it ‘Sales Performance’.

The category drop-down menu can be used to filter available KPI pages by their function, or we can scroll through all the available KPIs if we scroll down through the page. Since we are creating a page for our Sales Manager, we will select the following KPIs for them:

• Sales Planning
• Shipped Quantity
• Sales Order Count
• Sales Accuracy

Once we have found the KPIs we want to add, it is simply a matter of clicking the ‘+’ icon for each desired KPI. Once this has been hit, then we wil be shown the individual KPI’s parameter options, such as here for ‘Shipped Quantity’.

So we can see here that we can rename the KPI if desired, as well as having the option of searching via days in the past or using a specific date selection. We can also set a refresh interval which specifies how often the KPI page will refresh to included updated data from the live SG database.

Other KPIs such as the ‘Sales Order Count’, provide more options for what data they will display. A full breakdown of parameters for each KPI is featured below!

We will see that, as we are adding KPIs and then saving their setup, they are added to a list on the right hand side of the screen.

We can continue to add  as many (or as few) KPIs as we would need here, before clicking on ‘Create’ create our new KPI page.

We will then be returned to the main KPI screen, and our newly created KPI will now be visible.

Once a KPI page is created, we have the ability to edit it, giving us the ability to add/remove KPIs, as well as changing their parameter settings if desired. This can easily be done by clicking the ‘Edit’ button for the relevant KPI. So let’s edit the KPI we have just created.

Once we have clicked this we will be taken to the ‘Edit Page’ area for the KPI that we wish to edit.

Here we have the following options for editing KPIs, where we can:

1. Delete the KPI, which will remove it from our list of saved KPIs on the main homepage
2. Rename the KPI
3. Add new KPIs
4. Edit the parameters of a KPI that is already a part of our page
5. Remove a KPI from our page
6. Save any changes that we have made
7. Cancel any changes that we have made and return the KPI homepage with the same KPIs/settings for our page

Once we have created a custom KPI page with all the information that we need, we then have the option to drag and drop, as well as resize each KPI window to create a customized view that is best suited to an individual’s workflow.

Drag & Drop

To drag and drop a KPI, all we need to do is click and hold in a neutral area of the KPI (so not over any of the generated graphs/the refresh button/the resieze button (see below) and drag it into a new position. A red shaded area will indicate the space that the KPI will be dropped into.

Existing KPIs will automatically move to best make space for the KPI we are moving.

Resizing

Resizing can be done simply by clicking and dragging the arrow icon in the bottom right corner of each KPI.

Again a shaded red area will  indicate the space that the resized KPI will occupy.

With these 2 adjustments made we have now created a more personalized view of our ‘Sales Performance’ KPI that we first created.

As we touched on above, the V5 KPI features a ‘Page Rotation’ feature, which is ideally suited for large scale production monitors throughout a production facility. Let’s see how we can set these up.

We would begin setup for Page Rotation by clicking the user icon in the top right of the page and then selecting ‘Settings’:

We can then expand the ‘Page Rotation’ section of these settings, and use the drop-down here to add our previously created KPI pages to our rotation.

We can add as many of our KPIs to the rotation as we’d like, so let’s add 3 here. We can then specify a time for the application to wait before displaying the next KPI in the list once page rotation is active.

Once we have set this up as we would like, we can use the ‘Save’ button in the bottom right to save our page rotation settings.

We can then activate our newly created KPI Page Rotation by clicking the ‘Page Rotataion’ button under our saved KPIs on the left. This will load the page rotation into the main window, where we can see our confirmed settings for which KPIs to display and the display interval.

The page rotation can then be launched in fullscreen by clicking the play icon in the center of the screen.

Finally, we also have additional accessibility/viewing options to further customize a user’s viewing experience while using the V5 KPI. These can be accessed via the same settings menu that we used above to access ‘Page Rotation’.

The first of these is a choice of light and dark modes (dark mode is enabled by default)

As well as a slider to increase or decrease text size, useful for viewing KPIs on larger or smaller displays, depending on where they are being displayed.

Once we have decided on our setup here, we can save any changes at the bottom of the screen, and changes will be made immediately. We can see an example of the KPI view with ‘Light’ mode selected below.