ErgoLytics

ErgoLytics

ErgoLytics is a program module introduced in Ergosoft 16.5 that lets you view data and statistics for your print production and summarizes relevant information for you. Search your Job History for specific jobs, view statistics on your processed jobs and see production costs summarized, with ErgoLytics all your production data is at your fingertips!

Ergolytics offers multiple tiered features: The Ergolytics Viewer which lets you access your production data through your browser, Ergolytics Publish which lets you export your production data to external tables manually or automatically at set intervals, and ErgoLytics API to interface directly with your Ergosoft Production Database through an API interface and retrieve your production information for further processing.

Requirements

Each of the functions for ErgoLytics has distinct requirements. For easy understanding we list the full requirements for each tier below.

ErgoLytics Viewer

Latest Version: ErgoLytics requires at least Ergosoft 16 version 16.7 to run. Please visit the Ergosoft User Portal to download and install the latest build.

License: ErgoLytics Viewer requires a license for JobComposer Production. If you already have the license level Production, ErgoLytics Viewer is automatically included.

Update: To run ErgoLytics Viewer you’ll need to install the ErgoLytics update. You can find it on the Ergosoft User Portal in Downloads > Ergosoft 17 Extensions > Ergosoft_ErgoLytics.

ErgoLytics Publish

Latest Version: ErgoLytics requires at least Ergosoft 16 version 16.7 to run. Please visit the Ergosoft User Portal to download and install the latest build.

License: ErgoLytics Viewer requires a license for JobComposer Production and a separate license for ErgoLytics Publish.

Update: To run ErgoLytics Viewer and export your production data with ErgoLytics Publish you’ll need to install the ErgoLytics update. You can find it on the Ergosoft User Portal in Downloads > Ergosoft 16 Extensions > Ergosoft_ErgoLytics.

ErgoLytics API

Latest Version: ErgoLytics requires at least Ergosoft 16 version 16.7 to run. Please visit the Ergosoft User Portal to download and install the latest build.

License: ErgoLytics Viewer requires a license for JobComposer Production and a separate license for ErgoLytics API.

Update: To access production data with ErgoLytics API you’ll need to install the ErgoLytics API update. You can find it on the Ergosoft User Portal in Downloads > Ergosoft 17 Extensions > Ergosoft_ErgoLytics.

Configuring Ergolytics

If you haven’t already defined the data in the cost manager, we’ll need to do that first to display the information in ErgoLytics.

Customer Information

To set up customer information such as customer name and project for the RIP to use, open the main JobComposer window and go to Properties & Actions > Customer Info. Click the New Button to set up a new set of customer information and confirm to save. When you print a Job with this customer information, ErgoLytics will also be able to retrieve this information.                    

Cost Factors

Open the Ergosfto Control Center and go to Tools > Cost Manager. In each of the Tabs, you can set up a name and cost factor for one element of your production (Media, Ink, Printer).

By selecting the appropriate type for each element, you’ll be able to view the cost associated with a job.

Manage Media Lists

The list of media types you use. Click New and set a name and cost per square unit for the material. This material can then be selected in the Print Environment and/or the PrintQueue for printed jobs to keep track of material costs.

Manage Ink and Printer Costs

The list of inks you use. Click New and set a name and cost per unit for the ink type. This ink type can then be selected in the Print Environment to keep track of ink costs for this printer.

Manage Cost for Printed Area

Sets the cost to run a printer per printed area. In the left column, check the printers you want to keep costs per printed area for. Select the respective printer in the right column and click the Edit button to specify a cost per unit. The Costmanager will then track the area printed by this printer and the cost associated with it.

Assign Media to Print Environments

Sets which materials are compatible with which Print Environments. This limits the selectable options in the Print Environment/Print Dialog/PrintQueue to let you find the suitable material and ink quicker. Select the suitable materials, ink type, and printer by checking the respective boxes, then click Assign Selection to Print Environments to associate these materials and this ink type with the selected Print Environment(s).

Once you have up your costs, click Close to close the dialog.

ErgoLytics Interface

Starting ErgoLytics

After installing the ErgoLytics module, you’ll be able to start ErgoLytics using the automatically created desktop shortcut.

ErgoLytics will open a new tab in your standard browser to display the production information. The information in ErgoLytics is grouped into multiple sections for easy access.

Note that the underlying system process for ErgoLytics is started automatically. However, should you need to start it manually, you can do so using Start > ErgoLytics > ErgoLytics (xxbit) to manually start the background process for ErgoLytics. This will not open the ErgoLytics page in your browser.

Should you ever need to re-add the Desktop shortcut to access the ErgoLytics page, simply create a new shortcut pointing to http://localhost:9004/ or access the URL directly in your browser to open the ErgoLytics viewer.

Dashboard

The Dashboard gives you a «big picture» view and statistics for your production.

Time Period lets you define for what time frame the statistics are is shown. Select from the predefined time periods or specify a custom period.

Totals will show total completed jobs, used media, and ink for the selected timeframe.

Statistics shows graphs for the combined production, completed jobs, media used, and ink used by quarter (If possible with the time frame selected in Time Period).

Job History

View a list of completed jobs and details for each job.

Quick Search lets you filter what jobs are shown based on time period, printer, media, or text string search. The list will then only show the jobs that fit the criteria. Use the Reset button to clear the filter and go back to the default view.

The Job List shows a thumbnail of the job and details such as Job Name, Job ID,  Printer, Date, Media/Ink Consumed, and total cost.

You can also switch the list display between List Only, Medium Size Job Preview, and Large Size Job Preview using the button on the top right of the list segment.

Resources

Lists the resources that are defined in this installation of Ergosoft.

Resources include Customers, Printers, Media Types, Inks, Projects, and Print Environments. See Configure Ergolytics in this guide to find out where to add resources to Ergosoft.

Publish > Production Data

Lets you export your Production Data (Information on printed Jobs, used materials, inks, etc.) to the formats .csv, .json or .xml.

You can export the data either manually or automatically in regular intervals.

To do a manual export, first set the parameters for the export in the top section. You can specify the timeframe, used media or even search for specific text strings.

Click Apply to search for all appropriate jobs in your production database. When the search is complete you will see how many Jobs the search returned under “Query Results”. Next select the desired File Format from the drop down menu and click “Publish” to export a file with your Production Data. The file is automatically dropped into your default download folder specified in Windows.

Note that no file is created if your query did not return any job results i.e. if Query Results is 0.

To automatically export your production data, you can set your desired parameters in the Scheduled Auto-Publish section. Set how frequently you want the data to be exported in Period (Daily, Weekly or Monthly), set what time you want the export to happen in Time of Day, select the desired file format and specify the output path by copying or typing the export path into the Directory Path field. Click Save to finalize your settings. From the point on your production data is automatically exported at the specified time. To adjust settings, simply change the settings as desired and click Save again.

Note that each export only covers the data since the last export. So e.g. if you specify daily exports, each export will have one days’ worth of data.

If the Apply, Publish and Save buttons are not clickable that means that you do not currently have a license for ErgoLytics Publish.

Publish > Resource Data

Lets you export your Resource Data such as Customers, Printers, Media, Inks, Projects and Print Environments as they are specified in Customer Information, Cost Factors and the Print Environments of your Ergosoft installation.

For information on how to set up these resources, see the Configuring ErgoLytics section at the beginning of this article.

Select a file format at the top and click Publish next to each resource to export a list of the respective resource to file. The file is automatically dropped into your default download folder specified in Windows.

Publish > Connect

This segment is part of the ErgoLytics API feature. If you have the appropriate license for ErgoLytics API and have the API update installed, this section will show you the Swagger page for ErgoLytics API.

Swagger lets you view all available API commands and let you test them directly. Inside the ErgoLytics viewer.

ErgoLytics API itself is run outside of the ErgoLytics Viewer. With the API commands listed here you will be able to directly access the production database of your Ergosoft RIP and fetch the desired information for whatever application you want to create.

Note that in order for the Swagger page and the API commands to work, the ErgoLytics API application needs to be running. You can start the API service through the Windows Start Menu by searching for ErgoLytics and launching “Start ErgoLytics.RestServices Service(64 bits)”.

If the Swagger API page in “Connect” is not displayed and instead you are getting an error message like “local host refused to connect", most likely you have not installed the ErgoLytics API upgrade. If the Swagger API is displayed, but testing doesn’t work, most likely the API service is not running, or you do not have a license for the Connect feature.

Settings

This is where you can switch between metric and imperial measurement units to display information in ErgoLytics.                     

Troubleshooting

In Publish > Production Data, the buttons for Apply, Publish and Save are not clickable/gray.

This likely means that you currently do not have a license for ErgoLytics Publish. Please contact your Ergosoft vendor or Ergosoft directly.

In Publish > Connect, nothing is displayed, and I just get an error message “local host refused to connect".

This likely means that the ErgoLytics API Service is currently not running. Start it by going to the Windows Start Menu, searching for ErgoLytics and launching “Start ErgoLytics.RestServices Service(64 bits)”.

In Publish > Connect, the Swagger API description is displayed, but “Try it out” is not working and shows a 403 error (License is invalid).

This indicates that the API update is correctly installed, but you currently do not have a license to run ErgoLytics API. Please contact your Ergosoft vendor or Ergosoft directly.

    • Related Articles

    • Installer Downloads / Change Log

      The Ergosoft RIP installer as well as the extensions and other useful resources are available on the User Portal. There you will also find the interactive Change Log and even more helpful information. To access the User Portal, you need to login. If ...