SyncThru™Admin 5 ▌ Job Accounting Plug-in Admin Guide
Copyright © 2009 Samsung Electronics Co., Ltd. All rights reserved. This admin guide is provided for information purposes only. All information included herein is subject to change without any notice. Samsung Electronics is not responsible for any direct or indirect damages, arising from or related to use of this admin guide. • • • • SyncThru™ is a trademark of Samsung Electronics Co., Ltd Samsung and Samsung logo are trademarks of Samsung Electronics Co., Ltd.
Contents COPYRIGHT/2 CONTENTS/3 HOW TO USE THIS GUIDE INTRODUCTION Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Benefits of using the SyncThru™ Admin 5 Job Accounting Plug-in . . . . . . . . . 8 What’s improved? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Device History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . History list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . History Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . History Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents TROUBLESHOOTING Common errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Device shows SyncThru Login message even if Job Accounting is disabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . After changing Job Accounting-enabled device to local device, Job Accounting is not working. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Understanding error codes . . . . . . . . . . . . .
How to use this guide 1. The SyncThru™ Admin 5 Job Accounting Plug-in Admin Guide is intended to be used to install and setup the SyncThru™ Admin 5 Job Accounting Plug-in on a network server and client systems. To assist you in acclimating to the SyncThru™ Admin 5 Job Accounting environment, this guide provides instructional screen images, situational examples, easy-to-read tables of features, and step-by-step instructions.
Reference Material SyncThru™ Admin 5 software http://solution.samsungprinter.com Updates and Plug-ins http://solution.samsungprinter.com Help Click Help in site the navigation bar at the top right corner of the SyncThru™ Admin 5 page. Product Support Information Contact Samsung’s printer service http://www.samsungprinter.
Introduction 1. This chapter gives you an overview of the SyncThru™ Admin 5 Job Accounting Plug-in’s major features and benefits. This chapter includes: • • • • • Overview Benefits of using the SyncThru™ Admin 5 Job Accounting Plug-in What’s improved? Features of SyncThru™ Admin 5 Job Accounting Plug-in Tips for using SyncThru™ Admin 5 The SyncThru™ Admin 5 Job Accounting Plug-in can be used only with Samsung devices.
• Job records stored even after Job Accounting disabled : You can see job records even after Job Accounting disabled for the devices. (See "Viewing job records for a device" on page 22) You can also see job records with Analysis & Reports. Compatibility SyncThru™ Admin 5 provides backward compatibility for SyncThru™ Web Admin Service 4.x Job Accounting Plug-in. If you are using SyncThru™ Web Admin Service 4.x with the Job Accounting Plug-in, the SyncThru™ Web Admin Service 4.
Tips for using SyncThru™ Admin 5 Layout related tips Drag-and-drop SyncThru™ Admin 5 provides drag-and-drop functionality. When you want to add devices to a group, you can select the devices you want and drag-and-drop them into a specific group. The drag-and-drop functionality allows you to copy multiple devices easily. It also shows warning icons where devices cannot be added. Page navigation SyncThru™ Admin 5 has a convenient and easy-to-use page and panel navigation system.
System related tips Starting and stopping SyncThru™ Admin 5 service SyncThru™ Admin 5 starts automatically every time the computer you installed SyncThru™ Admin 5 onto boots up. If you want to stop and start SyncThru™ Admin 5 manually, follow the steps below: If the database is PostgreSQL, then there will be one more service (SyncThru 5 database) to stop/start. To stop SyncThru™ Admin 5 1. From the Windows Start menu, click Control Panel > Administrative Tools > Services. 2. Select SyncThru 5.
Getting started 2. This chapter gives you instructions for installing the SyncThru™ Admin 5 Job Accounting Plug-in.
Enabling Job Accounting for devices After adding users, you need to enable Job Accounting on the devices. 1. From SyncThru™ Admin 5, click Job Accounting menu > Devices > Device Settings > Job Accounting Settings. 2. Select Enable/Disable Job Accounting. 3. Click OK/Apply. Assigning Job Accounting to the devices After enabling Job Accounting on the devices, you can assign user permissions or user group permissions to the Job Accounting enabled devices. For individual users 1.
Users 3. Before using Job Accounting, user accounts should be registered in SyncThru™ Admin 5. These are users who will be using the device. You can manage users only within SyncThru™ Admin 5, not from the device. This Users menu is like a prerequisite for starting Job Accounting for the device. This chapter includes: • • • • Overview Adding Users User List User Groups Overview With the Users menu, you can: • add job accounting users to SyncThru™ Admin 5 (See "Adding users" on page 15.).
1 User Groups Shows the user groups. 2 User List Shows the list of users in the selected group. 3 Add Users Settings for adding users. Adding Users You need to add users before using Job Accounting. You can add local users as well as LDAP users. Adding users From SyncThru™ Admin 5, click Job Accounting menu > Users > Job Accounting Users > Add Users. If you want to add users to a specific group, see the adding a user group section (See "Adding a new group" on page 17).
4. Click the Search button. You can see the search results below the button. 5. Select the users you want to add. 6. Select the group to which you want to add users (If no group is selected, users will be added to Ungrouped). 7. Click the Apply button at the top of the Add Users panel. You can see the added user(s) in the selected group’s User List. Adding Users with Import Users(CSV) If you need to add more than ten users, you can use the Import Users(CSV) button to do it. 1.
User Groups You can group users into different categories for easier management. For example, you have 2 different marketing teams that have different printing permissions for the area printer. You can set up two different groups with different sets of permissions. Managing user groups You can manage users by grouping. All, Ungrouped and Grouped are created as a default in the User Groups panel. These groups are used for group permissions.
Managing user permissions If you are already using job accounting, you can change the specified permissions from the User List panel or the User Groups panel. Modifying user permissions 1. From SyncThru™ Admin 5, click Job Accounting menu > Users > Job Accounting Users > User List. 2. Select the user you want to modify. 3. Click the Devices button in the Modify Devices column. • • If you cannot find the Device button, resize the panel (See "Resizing panels" on page 10).
Devices 4. If user account settings are completed, you can configure Job Accounting on the device. With the Devices menu, you can: • • • • • • view Job Accounting supported devices (See "Understanding the Device List" on page 20). enable/disable Job Accounting on a device (See "Enabling/disabling Job Accounting" on page 21). change the access code of a device (See "Changing Access Code" on page 21). view job records of a device (See "Viewing job records for a device" on page 22).
Understanding the Device List • Display devices from subgroups : This option is located in the top left corner of the Device List panel. By default, this option is enabled, which means you can see all the devices, including the subgroups’ members. If you do not want to see the devices from subgroups, you can uncheck this option.
Enabling/disabling Job Accounting Enabling Job Accounting 1. From SyncThru™ Admin 5, click Job Accounting menu > Devices > Devices Settings > Device List. 2. Select the device(s) you want to enable job accounting. Please make sure that JAC State is Disabled. You can see the details in Devices History (See "Device History" on page 23). • If the JAC State is already Enabled, the operation will show success.
Show deleted but controlled devices Show deleted but controlled devices is an option available to change the way devices are displayed. If a device has been added to Job Accounting, a device removed from the Devices menu > Group/List > Device List (or other menus’ device list) can still be seen in the Job Accounting menu > Devices > Device List.
Device History SyncThru™ Admin 5 keeps the history of a device’s operations. Devices History also shows the status of the task started in the Job Accounting menu > Devices > Devices Settings. History list You can see all the accumulated history for configurations in the History list. The latest task is located at the very top of the list. You can see the date and status of the task. If you want to see a task in detail, click the specific task on the list. You can see the details in the middle.
User Permissions 5. Once you have added user accounts into the SyncThru™ Admin 5 system and enabled Job Accounting with your devices, you are ready to use the Job Accounting function. With Job Accounting enabled, only valid users (groups) can use the specified device and perform jobs. The last step is to configure user (group) permission settings. You can arrange user(group) accounts and devices, like allowing only software engineers (groups) to use device A.
Understanding the Job Accounting Enabled Device List • Display devices from subgroups : By default, this option is enabled, which means you can see all devices including the subgroups’ members. If you do not want to see devices, from subgroups, you can uncheck option.
7. At the bottom of Apply Permissions, you can see the Permissions list. Check the function(s) you want to assign then double click the number under Permission column. You can change the number (default is 250). Or, you can export user permissions with Import Permissions (CSV) button (See "Importing user permissions from a CSV file" on page 26). 8. Click OK/Apply. You can see the results of this permission setting in the User Permissions History.
User Permissions History After configuring user permission settings, you may want to see the results without leaving your desk. From SyncThru™ Admin 5, click Job Accounting menu > User Permissions > User Permissions History. If you click the OK button (not Apply button) after the final step of the job, the page automatically moves to User Permissions History. User Permissions History provides detailed information of user permissions settings.
Group Permissions 6. Once you have added user accounts into the SyncThru™ Admin 5 system and enabled Job Accounting with your devices, you are ready to use the Job Accounting function. With Job Accounting enabled, only valid groups (users) can use the specified device and perform jobs. The last step is to configure group (user) permission settings. You can arrange group (user) accounts and devices, like allowing only software groups (engineers) to use device A.
Group Permissions Settings From SyncThru™ Admin 5, click Job Accounting menu > Group Permissions > Group Permissions Settings. Make sure that the user groups are arranged. Group Permissions work with user groups.
• Display devices from subgroups : By default, this option is enabled, which means you can see all the devices, including the subgroups’ members. If you do not want to see the devices from subgroups, you can uncheck the option. If you uncheck the option, the Job Accounting Enabled Device List displays a different total number of devices from the number in the group list because the current Job Accounting Enabled Device List displays only the members of the selected group.
Exporting group permissions to a CSV file 1. From SyncThru™ Admin 5, click Job Accounting menu > Group Permissions > Group Permissions Settings > Job Accounting Enabled Device List. 2. Select the device(s) you want to export permissions. 3. Click the Export Permissions (CSV) button. 4. You can open or save the exported CSV file Show deleted but controlled devices option (See "Show deleted but controlled devices" on page 22.
History Details You can see details of the selected configuration task in this list. You can choose to see only jobs that have succeeded or jobs that have failed by filtering the list. If you want to check the details, click the Details button. History Details window appears with detail results of the entries. If configuration fails, you can see the reason for the failure. In the History Details panel, you can: • see details of the task. • retry the specific task.
Driver settings 7. This chapter includes: • Installing the printer driver Once the entire Job Accounting configuration is done in SyncThru™ Admin 5, users have to install the printer driver that supports Job Accounting on their computers. Also, Job Accounting’s user ID and password should be entered in the driver user interface. Installing the printer driver 1. From the Windows Start menu, select Printers and Faxes.
Login window 8. Once the Job Accounting function has been enabled, the login window is displayed on the device as shown below when users try to do any job. (This window is only for GUI models) The users must enter a valid ID and password in order to perform jobs. In addition, users need to check their permission type, Personal or Group. If they have only Group permission, they need to select Group.
Analysis & Report 9. This chapter includes: • • • Overview Analysis Report Overview SyncThru™ Admin 5 provides reporting capabilities for printing and imaging devices. If you install the Job Accounting Plug-in, you can see the Job Accounting category in the Analysis & Reports menu. Basically, SyncThru™ Admin 5 analyzes the devices information by time, historical report, current report, and proactive report.
Analysis An analysis’s purpose is to provide useful information with simple options. You can quickly and easily get an analysis since SyncThru™ Admin 5 aggregates analyses every time its database is updated. With the Analysis menu, you can: • see analysis based on a device group (not for individual devices). • easily see different analyses by changing settings options, such as period. • • If you want to see an analysis for an individual device, refer to the Reports section (See "Report" on page 37).
Report Reports has a slightly different concept for analyzing devices’ data than Analysis. You can see more options, like Schedule and Device List, which lets you generate reports for individual devices. With the Reports menu, SyncThru™ Admin 5 generates reporting data when you configure options and select devices, which is the main difference from the Analysis menu. You can generate a wider variety of reports with the Reports menu.
Scheduling report generation You can schedule report generation. 1. From SyncThru™ Admin 5, click Analysis & Reports menu > Reports > Reports settings. 2. Configure settings. 3. Check the Schedule checkbox and set the specific date/time you want. If you want to generate the report periodically, set the Time Interval. If you configure the scheduling option, reports will be marked with the special icon history. in the Report 4. Click OK/Apply.
Report history You can see the accumulated history for the report generating tasks here. The latest task is located at the top. You can see the date and status for a task. If you want to see the history in detail, click the specific history on the list. Then you can see details in the Report history summary and Report history details. In the Report history panel, you can: • see all the generated reports. • add a new folder for managing tasks. • delete any task or folder from the list.
Related features 10. SyncThru™ Admin 5 provides additional settings for Job Accounting. If you install the Job Accounting Plug-in, you can see the new settings within SyncThru™ Admin 5. This chapter includes: • • Device configuration Settings menu Device configuration From SyncThru™ Admin 5, click Devices menu > Configuration > Configuration Settings. From the Configuration Settings panel, you can see Job Accounting under Features .
Settings menu From SyncThru™ Admin 5, click Settings menu > Settings > Device Management > Job Accounting. You can see the Job Accounting related settings. The options are as follows: • Default Access Code : When you enable Job Accounting for devices, SyncThru™ Admin 5 uses this value as an access code unless you enter a custom access code. You can change the default access code here. SyncThru™ Admin 5 will use Use Default Access Code as a default.
Troubleshooting 1. This chapter gives helpful information for what to do if you face an error. This chapter includes: • • Common errors Understanding error codes Common errors Device shows SyncThru Login message even if Job Accounting is disabled. When the device shows the SyncThru Login screen even though the Job Accounting feature is disabled from SyncThru™ Admin 5, follow the below steps: 1. Go to the Device. 2. From the devices control panel, press Machine Setup. 3. Select Admin Settings.
Understanding error codes The following table shows all the error codes SyncThru™ Admin 5 Job Accounting defines. The error codes appear in pop-up window messages or log messages.
Detailed description of meanings Following tables are classified according to modules. Common CODE SEVERITY REASON SOLUTION 20001 Invalid Request Warning The SyncThru server received unexpected request. Try the operation again by following the Help menu or this SyncThru™ Admin 5 Job Accounting Guide. 20002 Error In Processing Severe SyncThru faced some critical error due to network/database failure or other failures.
CODE SEVERITY REASON SOLUTION 21004 Login ID Already Exists Warning The Login ID you have entered already exists in the system. Please check to see if the same login ID is already in the system. Change the ID and try again. 21005 Some of the Selected Users Already Exist Warning When adding the LDAP users to SyncThru, if the user already exists in the SyncThru, this warning appears Check whether the user already exists in SyncThru.
CODE SEVERITY REASON SOLUTION 21013 Selected User is Assigned To a Device(s), Cannot Modify Login Warning When the user you want to modify is assigned to Job Accounting enabled device(s), you cannot modify the Login ID of the user. Please make sure that the selected user is not assigned to any device. If you really want to modify the user’s Login ID, you need to change the Job Accounting settings for the user. First, you need to check the device(s) using the user.
Data reference 12. Only SyncThru™ Admin 5 Job Accounting compatible devices can use Job Accounting functionality. The devices should support the Job Accounting interfaces SyncThru™ Admin 5 defines.
Open Source Information 13. The Apache Software License, Version 1.1 Copyright (C) 2000 The Apache Software Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2.
2. Grant of Copyright License.Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License.
JDOM Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer. 2.
Boost Software License 1.0 (BSL1.
2.2 Contributor Grant. Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: • (a).
5. 6. 7. 8. 9. 10. DISCLAIMER OF WARRANTY COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN “AS IS” BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU.
GNU LESSER GENERAL PUBLIC LICENSE This product uses some software programs which are distributed under the LGPLv2.1/LGPLv3 license. LGPL v2.1 Software : JaperReports, Java CSV Library, Jcommon, jCIFS, Pager Tag Library LGPL v3 Software : JFreeChart Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies. of this license document, but changing it is not allowed.
A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it.
• a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library.
NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU.
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0.
5. Combined Libraries You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: • a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
Glossary • • The following glossary will help familiarize you with SyncThru™ Admin 5 by understanding the terminologies commonly used in this admin guide. The definitions of the below terms are mostly cited from: A) http://en.wikipedia.org and B) www.ietf.org/rfc.html. Account In SyncThru™ Admin 5, having an account means you have the right to access the device or system. Console Console is the device’s LCD display. CSV Comma Separated Values (CSV) is a type of file format.
IPP Internet Printing Protocol (IPP) defines a standard protocol for printing as well as managing print jobs, media size, resolution, and so forth. IPP can be used locally or over the Internet to hundreds of printers, and also supports access control, authentication, and encryption, making it a much more capable and secure printing solution than older ones. LDAP The Lightweight Directory Access Protocol (LDAP) is a networking protocol for querying and modifying directory services running over TCP/IP.
RSS Really Simple Syndication (RSS 2.0) is a family of Web feed formats used to publish frequently updated works—such as blog entries, news headlines, audio, and video—in a standardized format. RSS feeds can be read using software called an "RSS reader", "feed reader", or "aggregator", which can be web-based or desktop-based. A standardized XML file format allows the information to be published once and viewed by many different programs.
UDP User Datagram Protocol (UDP) is one of the core members of the Internet Protocol Suite, the set of network protocols used for the Internet. With UDP, computer applications can send messages, sometimes known as datagrams, to other hosts on an Internet Protocol (IP) network without requiring prior communications to set up special transmission channels or data paths. UDP is sometimes called the Universal Datagram Protocol.
Index A P analysis and report 35 analysis 36 categories 35 report 37 generating 37 history 39 scheduling 38 permissions group 28 assigning 30 exporting 31 importing 30 modifying 22 user 24 assigning 25 exporting 26 importing 26 C changing acess code 21 configuring 12 adding users 12, 13 enabling job accounting 13 R related features 40 copyright 2 T D terminology 6 data reference 47 tips 10 device list 20 troubleshooting 42 acronyms 6 common 42 error codes 43 downloading 11 driver setting
