Embedded client for Ricoh device Technical Installation Manual

Transcription

1 Embedded client for Ricoh device Technical Installation Manual Version Copyright 2014 Ubiquitech A/S Ubiquitech A/S Bregnerødvej 144 DK-3460 Birkerød Phone.:

2 1. Introduction Ricoh devices supporting embedded client Download the Embedded client for Ricoh Adding customer logo Single sign on via Ricoh AAA integration Configuration for VDMS gateway (Pcounter only) Install the embedded client on Ricoh MFP Locking the Ricoh MFP Locking the Ricoh SDK 2 MFP Locking the Ricoh SDK4 to SDK Locking the Ricoh SDK Tips and troubleshooting Embedded client advanced configuration options Support Embedded client for Ricoh device

3 1. Introduction Use these instructions to load the Ubiquitech Embedded Client to Ricoh MFP in order to communicate with Ubiquitech EASY or VDMS. Please first set up the Ricoh MFP s as shown in the Terminals section of the Ubiquitech EASY / VDMS installation guide prior to installing the Embedded Client for Ricoh Ricoh devices supporting embedded client For a list of supported Ricoh devices please log into the partner website via the following link: Press the Log in button and log in with your username and password Once logged in press the Compatible MFPs link. A new page loads. Find the brand name and click the link to open a PDF file. 2. Download the Embedded client for Ricoh The file for the Ubiquitech system for the Embedded Client for Ricoh is available from the Ubiquitech TRAC system in the download folder. Download the embedded client (xlet) with support for SDK 4.xx and forward and save it on your PC Adding customer logo This section describes how a customized logo can be added to the client. For a list of advanced features please go to the advanced configuration section. The configuration of the embedded client is done by editing the terminal.properties and vdms-client.dalp files found in the downloaded zip file. Prepare a logo picture in 256-color BMP format Unpack terminal.properties and vdms-client.dalp from the xlet zip archive In terminal.properties there are two settings: logo.resource.name (for upper right corner) logo.resource2.name (for upper left corner) This property must be set to the name of the file without BMP extension In vdms-client.dalp an additional entry must be added with the logo file. Find a line that says: <jar href="./terminal.properties" basepath="current"/> Add a new line after it with the name of the logo file <jar href="./custom_logo.bmp" basepath="current"/> Save terminal.properties and vdms-client.dalp and add them to the xlet zip together with the customized logo bmp file. 1 Embedded client for Ricoh device

4 2.2. Single sign on via Ricoh AAA integration This section describes how to enable single sign on integration with Autostore via Ricoh AAA. This feature is supported on SDK5 and forward. The configuration of the embedded client is done by editing the terminal.properties found in the downloaded zip file. # Autostore application ID in decimal format to switch to after logging in sso.productid = # Write the name of the of the button which will be visible on the MFP sso.label = Example: sso.productid = sso.label = AutoStore 2.3. Configuration for VDMS gateway (Pcounter only) Using VDMS gateway software together with the embedded Ricoh client requires additional configuration of terminal.properties found in the xlet zip file. Unpack terminal.properties from the xlet zip archive Change autoconfig.legacy=false to autoconfig.legacy=true Save terminal.properties and add it to the xlet zip 3. Install the embedded client on Ricoh MFP Installation of the embedded client is done via a web browser, so you need the IP address of the MFP you are installing to. Please note that once the installation is complete you need to proceed to the Locking instructions to lock the MFP! 1. Open a web browser and enter the IP address of the MPF 2. The following page will be displayed: 2 Embedded client for Ricoh device

5 3. Press Login in the upper right corner 4. Log in with username admin Please note that no password is given! 5. Once logged in go to Device Management/Configuration Some models have a direct link to Configuration 6. A new page is loaded. Scroll down to Extended Feature Settings 7. Click on Extended Feature Info and note down the Startup Location of the JavaTM Platform Could be something like SD1 or SD2 you need to install the xlet to the same location! 8. Press Back 9. Press Install A new page is loaded: 10. Choose Local File and press Vælg Fil or the button in your own language located the same place 11. Browse to the Embedded Client you downloaded 3 Embedded client for Ricoh device

6 12. Press Open 13. Press Display Extended Feature List Only press the button ONCE!! Be patient and wait until the new page loads! 14. In Installation Target Setting it is important you select the same location as the JavaTM Platform was installed to! In this example it was SD1, so I choose SD Card Slot Enable Autostart by checking the radio button ON 16. Select Ubiquitech Xlet 17. Before proceeding to Install please check the screenshot below and pay attention to the areas marked in Yellow 4 Embedded client for Ricoh device

7 18. Once verified that selections are correct press Install and confirm the installation on the next page 19. Once the installation procedure is completed press Back and go to Startup settings 20. Select the Ubiquitech xlet and press Startup/stop 21. Installation of the embedded client is completed. Please proceed to the Locking instructions 4. Locking the Ricoh MFP Depending on which version of the SDK the Ricoh MFP supports you have to follow the instructions that match the SDK of your Ricoh MFP! All Ricoh MFPs with SDK 4.xx and higher needs to be locked Locking the Ricoh SDK 2 MFP The Ricoh MFP can be locked so only users that are authenticated to VDMS can use the Copy or Scanning facilities. If you don't want to lock the MFP then you can skip this chapter. If you do, please read the following: Using a special version of the Ricoh firmware and the version of the Ubiquitech xlet, we can lock the MFP. The firmware and xlet are available on request. This document explains how you use the special firmware and xlet. Prerequisites: 1. Ricoh MFP model MPC2500, MPC3000, MPC3500, MPC4500, MP5500, MP6500, MP7500, MP6000, MP7000 and MP8000 are currently supported. 2. Ricoh Java SDK 2.11cs4 (use ONLY java 2.11cs4 for sdk2 devices) 5 Embedded client for Ricoh device

8 3. VDMS Client version with accounting (or later). 4. Special firmware from Ricoh with softlock mechanism. Install the special version of the firmware. Look in the Ricoh documentation for information about installing firmware. Follow the normal guidelines. Go to the service menu to enable the lock. To go to the service menu you press the yellow button, then 107 and then hold down the red button until the service menu appears. Press Copy Sp Then go to menu 5113 and then 2 and 1. Then press OK and exit the service menu. Configure the lock settings. Then go to System Settings in the Administrative interface on the MFP. 6 Embedded client for Ricoh device

9 Press Enhanced External Change Unit Management Then select the features that you wish to be locked without authentication. Make sure that you do not lock the print functions because the server will not be allowed to print. Also Java should not be locked since that will prevent the users from unlocking the MFP. Make sure to make an entry in the MFP's service book about the special firmware. It must not be upgraded since the standard Ricoh firmware does not support these features. 7 Embedded client for Ricoh device

10 4.2. Locking the Ricoh SDK4 to SDK 7 The Ricoh MFP can be locked so only users that are authenticated to VDMS can use the Copy or Scanning facilities. This needs to be done on the sdk4 devices otherwise the xlet will not work. These changes needs to be done before the xlet is installed. Update java to the latest. Take the Java SD card a put in a card reader Edit the file \sdk\ap\ap.properties Set the jp.co.ricoh.dsdk.ap.panelservice=1 Save the file and put the java card back in MFP. Then start the MFP. Go to the service menu to enable the lock. To go to the service menu you press the yellow button, then 107 and then hold down the C button until the service menu appears. Press Copy Sp Then go to menu 5113 and then 2 and 1. 8 Embedded client for Ricoh device

11 Then press OK and exit the service menu. Configure the lock settings. Then go to System Settings in the Administrative interface on the MFP. Press Enhanced External Change Unit Management Then select the features that you wish to be locked without authentication. This is only necessary if you wish that users should authenticate before they can use the build in functions. Make sure though that you do not lock the print functions because the server will not be allowed to print. Also Java should not be locked since that will prevent the users from unlocking the MFP. 9 Embedded client for Ricoh device

12 4.3. Locking the Ricoh SDK10 The Ricoh MFP can be locked so only users that are authenticated to VDMS can use the Copy or Scanning facilities. This needs to be done on the sdk10 devices otherwise the xlet will not work. These changes needs to be done before the xlet is installed. Update java to the latest. Take the Java SD card a put in a card reader Edit the file \sdk\ap\ap.properties Set the jp.co.ricoh.dsdk.ap.panelservice=1 Save the file and put the java card back in MFP. Then start the MFP. Go to the service menu to enable the lock. To go to the service menu you press the yellow button, then 107 and then hold down the C button until the service menu appears. 10 Embedded client for Ricoh device

13 Press System Sp Then go to menu 5113 and then 2 and 1. Then press OK and exit the service menu. Configure the lock settings. Then go to System Settings in the Administrative interface on the MFP. 11 Embedded client for Ricoh device

14 Press Enhanced External Change Unit Management Then select the features that you wish to be locked without authentication. This is only necessary if you wish that users should authenticate before they can use the build in functions. Make sure though that you do not lock the print functions because the server will not be allowed to print. Also Java should not be locked since that will prevent the users from unlocking the MFP. 12 Embedded client for Ricoh device

15 5. Tips and troubleshooting Change homescreen to Ubiquitech homescreen: Go to the service menu to enable the lock. To go to the service menu you press the yellow button, then 107 ( on newer devices) and then hold down the C button until the service menu appears. Press System Sp Select menu 5074 Check that menu 91 is set to 1 13 Embedded client for Ricoh device

16 Check that menu 92 is set to the hex-value 1312D0Da (equals the application ID ) Click exit twice A reboot is not necessary 14 Embedded client for Ricoh device

17 6. Embedded client advanced configuration options This section describes the advanced configuration options of the Ricoh embedded client. Connection settings Define the port which it uses to receive gateway configuration. It is not recommended to change this. Default UDP port to receive server configuration. Default: server.port=81 Balance rounding Round the balance to the specified digits to round the user s account balance. Default: balance.rounding.digits = 2 Addressbook group keeping If this option is set to true then the client can prevent the MFP from deleting address book entires added into a group, please reference to the Address.cleanup parametre. Default: addressbook.keep groupid =true Addressbook If this option is set to sender, or recipient or both then MFP will add the in the scan2me function in the addressbook. Default:addressbook. =both Windows.colour The default background colour of the client. Possible values are blue or white Default: windows.color=blue Commit.interval The interval in seconds to perform automatic commit of pending copy/scan transactions. If set to 0 (zero) the autocommit is disabled. Transactions are also recorded upon logging out, logging in and machine start up. Default: commit.interval=30 seconds Pin.enable Enable or disable unconditional pin code entry when the card is swiped. If disabled the pin code is only asked if configured so on the server side. Default: pin.enable=false Addressbook.cleanup Cleanup machine s address book upon startup. Default: addressbook.cleanup=false Auto configuration The secret key for HMAC signature used in the autoconfiguration packetan select the copy, print or scan button. Default: autoconfig.key=vdms To enable older autoconfiguration protocol for older servers true and false to use the new protocol Default: autoconfig.legacy=false Show button Defines which buttons to be shown in the main window, print screen and login screen. 15 Embedded client for Ricoh device

18 Configure Username and Password field in the login window possible values are button, label, none. button shows the push button; label shows the specified label (see label.username description); none hides this entry. Default: show.button.username=button Default: show.button.password=button Show and hide the short ID entry field Default: show.button.pin=true Show or hide the Print All button Default: show.button.printall=true Show or hide the Scan button. Default: show.button.scan=true Show or hide the Print button Default: show.button.print=true Show or hide the Copy button Default: show.button.copy=true Logo resource The name of the custom logo file displayed in the upper right corner (without the BMP extension). The file must be properly specified in the DALP installation script, conform to Ricoh image requirements (BMP format, 256 colors) and be no wider than 160 pixels. Default: logo.resource.name=ubi_logo_small The same rules apply to the secondary logo to be displayed in the upper left corner. Default: logo.resource2.name= The label for the Username field: Default: label.username The label for the password field: Default: label.password Set login/pw/pin buttons To have a custom login button, you must have the bitmaps in the jar file. That means the programmers from Ubiquitech have to make a custom xlet for you. #button.login.res=login_xxx #button.pass.res=pass_xxx #button.pin.res= The default card reader type. This parametre should not be changed Default: default.cardreader.type The swipe mode. This parametre should not be changed Default: default.swipe.mode 16 Embedded client for Ricoh device

19 Swipe interval The default interval between card swipes used to detect double-swiping. This parameter is only used when the card swipe mode is set to 2. This parameter may be changed for slower card readers. Default: swipe.interval=2000 Autostore single sign on To enable single sign on via Ubiquitech login set the following parameters (See chapter 2.2) # Autostore application ID in decimal format to switch to after logging in ( for AutoStore) sso.productid = # application label to switch to after login sso.label = ScannerVision settings Valid only for the Scannervision-integrated version. Enables or disables password authentication for Scannervision. Default: scannervision.passpw = false If enabled the Scannervision application will be the main one after logging in. Default: scannervision.mainscreen = false If enabled the domain part of the user name will be stripped when performaing Scannervision authentication Default: scannervision.truncatepw = false Logging Define the level of logging. You can see the log from the mfp with the rsh command from a Windows PC. Default: rsh [IP address of the device] mmesg_auto 125 # logging # valid levels are: # FATAL = 0; # ERROR = 1; # WARN = 2; # INFO = 3; # DEBUG = 4; # ALL = 5; logger.level=4 logger.file=terminal.log logtofile = false If enabled the xlet rsh logging will contain user names, card numbers and short ids Default: loguserid = false Administrator account details 17 Embedded client for Ricoh device

20 These settings are for integration to MFP's address book user name and password. Default: adminaccount.login = admin Default: adminaccount.pw = Short ID login mode This setting is only used for Cirrato. The setting control how the shourtid login should be used. normal will compare the typed value in the shortid field with the card number database field. And if shortforpass is set, then Cirrato will handle the value differently. # valid values are "normal", "shortforpass" Default: login.shortid.mode Extra domain support The list of maximal 4 domains names. If not empty the appropriate buttons will be displayed on the login screen propting a user to choose the domain before logging in. The xlet support authentication for up to four domains separated by comma, if used with the Cirrato print management system. The username will then be send to the Gateway in the format of [username]@[domain]. The Gateway will then send the username to Cirrato. Default: logindomains = domain1.com,domain2.org,domain3.net,domain4.de 7. Support Download, documentation and support request can be obtained from 18 Embedded client for Ricoh device