SyncThruTM Web Admin Service Report Generator Plug-In ... 4.x/SWAS_PlugIn... · SyncThru Web Admin Service Report Generator Plug-In 3 2 Getting Started Use this chapter when you get

SyncThruTM Web Admin ServiceReport Generator Plug-In

Administrator Manual

2007 Samsung Electronics Co., Ltd. All rights reserved.

This administrator's guide is provided for information purposes only. All information included herein is sub-ject to change without notice. Samsung Electronics is not responsible for any direct o r indirect damages, arising from or related to use of this administrator's guide.

• SyncThru(TM) is a trade mark of Samsung Electronics Co., Ltd.

• Samsung and the Samsung logo are trademarks of Samsung Electronics Co., Ltd.

• This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)

• This product uses OpenSLP library. (http://www.openslp.org/)

• This product uses Xerces library.

• This product uses Xalan library. (http://xalan.apache.org/)

• This product uses NetSNMP library. (http://net-snmp.sourceforge.net/)

• This product uses SQLite library. (http://www.sqlite.org/docs.html)

• This product uses Boost library. (http://www.boost.org/libs/libraries.htm)

• This product uses QT library. (http://doc.trolltech.com/)

All other brand or product names are trademarks of their respective companies or organizations.

CONTENTS

1 Introducing the Report Generator Plug-InOverview 1Benefits 1Installation 1

2 Getting Started

3 Create ReportsReport Settings 4Device Selection 6Scheduling for Automated Report Delivery 8Report Generation and Results 9

4 Report TemplatesCreating Template at Create report page 12Creating Template at Report templates page 13Modify Template 13Delete Template 13Generate Report 14

5 Supported Devices

6 Report SamplesConsumables Info 17Usage Count 18Chart format 18Device Info 19

7 Troubleshooting110 - No available data for report generation 20112 - There is no device in the selected Group 20

8 Frequently Asked QuestionsHow does one generate the Usage Count Report and export the report as a CSV file? 21

9 Acronyms and Abbreviations

SyncThru Web Admin Service Report Generator Plug-In

1

1 Introducing the Report Generator Plug-InThis chapter introduces you the Report Generator Plug-In for SyncThruTM Web Admin Service.

This chapter includes:

• Overview• Benefits• Installation

Overview

Report Generator Plug-In for SyncThruTM Web Admin Service provides reporting capabilities for printers or MFPs managed by SyncThruTM Web Admin Service. With this plug-in, you can create, display, and e-mail reports about status, usage data, alert history, accounting details and consumables information. The data is collected in a database that can be used to generate reports.

NoteJob Accounting Plug-In is required for accounting reports.

Benefits

Report Generator Plug-In benefits are as follows:

• Generate reports in various formats.

• Generate reports in chart format.

• Generate periodical and summary reports.

• Generated reports can be exported to XML, HTML and CSV format.

• Generated reports can be sent as email attachments in XML, HTML and CSV format.

• Schedule report generation.

Installation

In general, you can install Report Generator Plug-In as follows:

1. Go to the local or network location where you downloaded the Samsung SyncThru Web Admin Service Component installation file.

2. Start SyncThru Web Admin Service Report Generator.exe.

3. Follow the instructions on the installation wizard.

• The default destination path is C:\Program Files\Samsung Network Printer Utilities\SyncThru Web Admin Service Report Generator. You can change the path if desired.

4. Click the Finish button.


2

Note

SyncThruTM Web Admin Service supports additional features by providing plug-in com-ponents. Each plug-in is provided as an installation file.


3

2 Getting StartedUse this chapter when you get started with Report Generator on SyncThruTM Web Admin Service.

After installing the Report Generator Plug-In, access the SyncThruTM Web Admin Service home page. You can see a new main menu Reports added to the list. If you click the Reports it will take you to the Reports main page which has 2 sub-menus on the left hand side.

Basic tasks are as follows:

• Create Reports: See 3. Create Reports.

• Save report templates: See 4. Report Templates.

• Check the supported devices: See 5. Supported Devices.

• See the report samples: See 6. Report Samples.

Menu Description

Create report To create and generate reports.

Report templates To create report templates.


4

3 Create ReportsThis chapter includes:

• Set parameters for report generation: Report Settings.

• Select devices on which report should be generated: Device Selection.

• Schedule and set parameters for automated report generation and delivery: Scheduling for Automated Report Delivery.

• Start report generating and see the results: Report Generation and Results.

Report Settings

You can configure general settings for creating report in the Reports > Create report.

Report Category, Report Type

Select the Report category and Report type. All other report settings are based on these type. Report Generator for SyncThruTM Web Admin Service provides the following reports type:

Report Category Report Type Remarks

Driver management

Device Info Summary Detailed Device Information

Current Device List

Device Discovery History

Firmware Upgrade History

ConsumablesConsumable Information Consumable Information, such as toner

Low Toner/No Toner List of devices with low or no toner


5

NoteJob Accounting reports are provided only when the Job Accounting Plug-In installed. If you have no Job Accounting Plug-In installed, there is no Job Accounting category in the Report category.

Summarized report

Check the box to create a summarized report. The report will be generated based on the selected period in Period field. If Summarized report is not checked, then a detailed report will be gener-ated on the configured Period.

Group by

This list allows you to specify grouping for a summarized report. The will change based on values such as Model name, Device location.

Period

Select the period for which the report should be generated such as Last week, This week, Last month, This month. The Customize option can be used to enter a specific dates and times at From and To for report generation.

Time interval

Select the time interval such as Hour(s), Day(s). This field is considered only in case of a detailed report. In other word, this field is valid only if summary is not selected. For example, if the Period is selected as This week and Time interval as Day(s), the report will be from Monday to Sunday of this week, with a time interval of one day. If the Time interval is Hour(s), the report will be from Monday 00:00 hours to Sunday 23:00 hours of this week, with a time interval of one hour.

AlertAlert History (Log)

Alert History Trend

Usage Count

Print/Copy/Fax/Scan By Period Usage report by job type

Print Usage Count By Period Print Usage report

Color/Mono By Period

Simplex/Duplex By Period

Paper Size By Period Usage report in A4(Small), A3(Large)

Total Pages: Device Counter Total Pages accumulated

Job Accounting

Job Accounting Basic

Job Accounting Print Details

Job Accounting Copy Details

Job Accounting Scan Details

Job Accounting Fax Details

Report Category Report Type Remarks


6

Report format

You can select the report output format.

Sort results by

Specify the field by which results should be sorted either IP address or Model name.

NoteSome of the above options are not available for all report types.

Device Selection

This section is for selecting the devices for which a report should be generated. Configure the following field in the Reports > Create report.

Groups

Select the corresponding device group from the list on the right. The default option is All Devices, other groups will be displayed if they exist.

Models

Select the corresponding device model from the list on the right.

Report Format Description

Table (text) In tabular format, which is easy to export to XML, CSV or HTML

Chart

In image format. 3 types of chart are provided: • Bar chart• Line chart• Pie chart


7

Select devices individually

In order to generate a report for one or more specific devices, select this option. Then a list of devices will be displayed. Select the devices required for report generation.


8

Scheduling for Automated Report Delivery

You can configure parameters for automated report generation and delivery to e-mail as an attachment in the Reports > Create report.

Scheduling (automated report delivery)

Check the box in order to configure the parameters for automated report delivery to your email.

NoteTo receive email, configure Settings > SMTP server configuration.

NoteTo schedule automated report delivery, the configuration should be saved as a template.

Start date

Specify the date and time starting from which the report should be sent.

E-mail addresses

Specify the email addresses separated by a semicolon for report delivery.

item Description

Send once Check this option if you wish to receive the report only once.

Send every This allows you to specify the time interval for sending a report.


9

Custom message

This box allows you to customize message content. Checking the box results in additional fields appearing:

File format

Select the report format you wish to receive as an attachment among CSV, HTML, or XML.

Report Generation and Results

After configuring the above-mentioned settings, click the button of View report which is present at the bot-tom-left of the page of Reports > Create report. After clicking the View report button, the Report gener-ation status page will be displayed. This page shows the percentage completion of report generation, and after completing 100% of report generation the Report results page will be loaded.

item Description

E-mail subject Specify the report message subject.

E-mail content Specify the report message content.


10

This page contains the generated report. The report format will be based on report settings. Either table format or chart format will be displayed.

Export

The report result can be exported to CSV, HTML, or XML format. This is only available for table reports.You can export the report by the following steps.

1. Click the Export button in the result page.

2. Select the format of file to be exported, and click the Get button.

3. Right-click the Download report link, and select Save target as.

4. The exported file can be saved.


11

Send by e-mail

The report result can be sent by e-mail as an attachment in CSV, HTML, or XML format. This selection of format is only available for table reports. In case of a chart, the report will be sent as an attachment in image format.

NoteTo receive email, configure the fields in the Settings > SMTP server configuration page.


12

4 Report TemplatesFor report generation, the user has to configure or select the items such as report settings, devices. To avoid setting each time, the user can save these settings as report templates. Once saved, the templates can be used for report generation.


• Creating Template at Create report page• Creating Template at Report templates page• Modify Template• Delete Template• Generate Report

Creating Template at Create report page

The report template can be created as follows:

1. Go to the Reports > Create report page.

2. Configure the report settings, devices and other settings.

3. Click the Save as button, then enter the name of the template and click the Save button.

4. The Report template will be created.


13

5. The Report Templates page will be loaded with a list of templates.

Creating Template at Report templates page

1. Go to the Reports > Report templates page.

2. Click the Add button.

3. Repeat step 2 to 5 of Creating Template at Create report page.

Modify Template

The report template can be modified as follows:


2. The Report templates page will be opened with a list of templates.

3. Select the template to be modified from the list and click the Modify button.

4. The Modify Report Template page will be opened with template report settings.

5. Configure the changes to be made, and click the Save button.

6. The changes will be applied and templates will be listed.

7. In step 5, if you click the Save as button, a new template will be created.

Delete Template

The report template can be deleted as follows:


2. The Report Templates page will be opened with a list of templates.

3. Select the template to be deleted from the list and click the Delete button.

4. The template will be deleted.


14

Generate Report

The report template can be used for report generation as follows:


2. The Report Templates page will be opened with a list of templates.

3. Select the template to be used for report generation from the list and click the View report button.

4. The report will be generated and results will be displayed.

5. If the Back button is clicked in the result page, the modify report template page will be dis-played.


15

5 Supported DevicesCurrently, the following models supports report generating functionality.

Category Model

Mono Laser MFP

SCX-6345FNSCX-5530FNSCX-4725FNSCX-6322FNSCX-6320FNSCX-4720FN

Color Laser MFP

CLX-8480FNCLX-2160CLX-6180FXCLX-3160FN

Mono Laser Printer

ML-2850ML-4051NML-3471NML-3051NML-2571N

Color Laser Printer

CLP-350CLP-300CLP-660NCLP-600N


16

6 Report SamplesReport Generator for SyncThruTM Web Admin Service provides various types of reports. You can see some of the report samples as follows:

• Consumables Info• Usage Count• Chart format• Device Info


17

Consumables Info


18

Usage Count

Chart format


19

Device Info


20

7 TroubleshootingThis chapter gives helpful information on what to do if you encounter a problem.


• 110 - No available data for report generation• 112 - There is no device in the selected Group

110 - No available data for report generation

This error is returned when there is no data for report generation. When there are zero results for the report requested, this error will be returned.

112 - There is no device in the selected Group

This error is returned when there is no device in the selected group for report generation. Add the devices to the group in Devices > Group management or discover the devices in Devices > Discovery page.


21

8 Frequently Asked QuestionsThis chapter gives the answer of frequently asked questions.


• How does one generate the Usage Count Report and export the report as a CSV file?

How does one generate the Usage Count Report and export the report as a CSV file?

Follow the steps below:

1. In the Create report page, select the Report category as Usage Count and the Report type as Usage Count By Period.

2. Select Summary report or not.

3. Select Period and Time interval of report.

4. Select report format as Table(text).

5. Select the devices for which the report should be generated and click View report button.

6. The Report result page will be displayed with the generated report.

7. To export the report to CSV format:

• Click the Export button in the result page.

• Select the format of file to be exported as CSV and click the Get button.

• Right-click the Download report link, and select Save target as.

• The exported file can be saved.

NoteFor more details refer to Report Generation and Results.


22

9 Acronyms and AbbreviationsTerms Used Description of terms

IP Internet ProtocolSMTP Simple Mail Transfer ProtocolMFP Multi-Functional Peripheral CSV Comma Separated ValuesXML Extensible Markup LanguageHTML Hypertext Markup Language

SyncThruTM Web Admin Service Report Generator Plug-In ... 4.x/SWAS_PlugIn... · SyncThru Web Admin Service Report Generator Plug-In 3 2 Getting Started Use this chapter when you get

Documents