Technical Manual DocuPRO embedded Client for Konica Minolta

DocuPRO embedded Client for Konica Minolta

Technical Manual | DocuPRO embedded Client for Konica Minolta Product Versie: 4.27 Versie van deze handleiding: 1.0.1 © 2014 Inepro B.V. Alle rechten voorbehouden

DocuPRO embedded Client for Konica Minolta De meest veelzijdige embedded oplossing

Bedankt dat u gekozen heeft voor de DocuPRO embedded Client for Konica Minolta. We zijn er van overtuigd dat U tevreden zult zijn over de aankoop van een van de beste oplossingen van vandaag. We willen u helpen om het beste resultaat te bereiken van uw DocuPRO embedded Client for Konica Minolta en om er veilig mee te werken. Deze handleiding bevat de informatie om dat doel te bereiken; leest u hem alstublieft zorgvuldig. Vanwege de constante veranderingen in onze produkten is deze handleiding aan onvermelde verandering onderhevig. Wij bevelen u sterk aan de gebruikerovereenkomst te lezen zodat u volledig begrijpt wat hij ondersteunt en wat uw verantwoordelijkheden zijn als eigenaar. Uw Inepro dealer is er op gebrand u tevreden te houden en zal graag uw vragen beantwoorden en uw zorgen wegnemen. Het allerbeste, Inepro BV.

Alle rechten voorbehouden. Niets van deze uitgave mag verveelvoudigd, opgeslagen in een geautomatiseerd gegevensbestand, of openbaargemaakt, in enige vorm of op enige wijze, hetzij elektronisch, mechanisch, door fotokopieën, opnamen of op enige andere manier, zonder schriftelijke toestemming van de uitgever. Produkten waarnaar verwezen wordt in dit document kunnen handelsmerken zijn van hun eigenaars. De uitgever en autheur maken geen aanspraak op deze handelsmerken. Hoewel de grootst mogelijke zorg is besteed aan de samenstelling van dit document kan de uitgever geen aansprakelijkheid aanvaarden voor de schade die het gevolg is van fouten, nalatigheid of verandering in details van deze uitgave of de programma's en broncodes die er eventueel worden bijgeleverd, en voor de gevolgen van het afgaan op verkeerde informatie. Versie 1.0.1 geproduceerd: September 2014 in Nieuw-Vennep, Nederland

Uitgever Inepro B.V. Hoofdredacteur K. de Graaf Technische samenstelling P. Grimmerink K. de Graaf Cover Design H. Wagenaar K. de Graaf Team Coördinator R. Groen Productie Inepro B.V.

Inhoudsopgave

Introductie Open API User Interface Open API Service Open API FTP Service Configuratie Communicatie Logging Troubleshooting Notities

http://www.inepro.com

2 4 9 12 14 18 20 22 24

Version 1.0.1 © Inepro B.V.

Introductie

I

Deel

Introductie

Introductie tot Open API Wat is Open API (Open Application Programmers Interface)? Het Open API systeem zorgt ervoor dat er gebruikers kunnen afdrukken, scannen en kopiëren op de multi-functional machines zonder dat er een extern betaalsysteem nodig is, omdat de software op het besturingssysteem van de machine draait.

Hoe is Open API met elkaar verbonden? De Inepro Open API applicatie bestaat uit 3 programma's; Open API Service, Open API FTP Service, Open API User Interface (voor de PC), de eerste 2 draaien als een Windows Service, het laatste programma is de back office Graphical User Interface.

2 - DocuPRO embedded Client for Konica Minolta

Open API User Interface

II

Deel


Open API User Interface Met de Open API User interface kan er een installatie gedaan worden op de Open API applicatie op een MFD (Multi Functional Device). De instellingen van de applicatie kunnen worden bekeken en het Listing Log moet worden uitgelezen.


MFD's zoeken & Application aanmelden / verwijderen

Via dit scherm kunnen de printers en MFD's die moeten worden beheerd door Open API worden gedefinieerd. De SNMP (Simple Network Management Protocol) versie moet op '1' worden gezet, de SNMP versie 3 optie is voorbehouden voor eventueel gebruik in de toekomst. Het adres type moet altijd 'IPv4' zijn. De gebruiker kan zoeken per IP-adres evenals per DNS hostnaam. Als DNS wordt geselecteerd, zal er een 'hostname' veld getoond worden in plaats van een start en eind veld. De gedefinieerde printer en hun instellingen zullen worden opgeslagen in het RegisteredPrinters.xml bestand in de Open API folder. De ‘Remove Selected Printer’ knop verwijderd een printer uit het bestand. § De ‘Delete Application’ knop verwijderd de applicatie van de printer. § De ‘Register Application’ knop zal de applicatie op de printer installeren. § En als laatste zal de ‘Restart Listening’ knop de communicatie (TCP/IP port 50003) tussen de printer en de (IneproOpenAPI.exe) herstarten.

Version 1.0.1 - 5


Configuration aanpassen

In het ‘General Configuration’ tekst vak kan de configuratie (Configuration.txt) worden aangepast of bekeken. ‘Save Configuration & Restart Services’ zal uiteraard de configuratie opslaan en de Open API services herstarten.


Selecteer Printer

In dit keuzevak kan de versie van de applicatie die op de MFD draait gewijzigd worden. Dit moet alleen in samenspraak met Inepro support gebeuren! Het ‘Enable Logging’ keuzevak kan worden gebruikt om extra logging te genereren voor de geselecteerde printer. Als er wijzigingen gemaakt worden moet de ‘Save Configuration’ knop worden ingedrukt om de wijzigingen in het RegisteredPrinters.XML bestand op te slaan. Om de wijzigingen ook in de services dor te voeren moeten deze opnieuw worden gestart. De grafische gebruikersinterface applicatie is alleen nodig om wijzigingen door te voeren in de setup en configuratie en kan worden gesloten als deze niet gebruikt wordt.

Version 1.0.1 - 7

Open API Service

III

Deel

OpenAPI Service Deze service is de kern van Open API, en bestaat uit 4 onderdelen.

Installeer de Open API modules De Open API bestaat uit 4 modules, waarvan een uitsluitend de installatie of de-installatie van de applicatie op de MFD verzorgd. 1. ‘Setup’ module De setup module verzorgd de installatie of de-installatie van de applicatie op de MFD. De software op de MFD is verdeeld en drie modules, elk met zijn eigen functionaliteit. 2. ‘Authenticatie’ embedded applicatie De ‘Authenticatie’ module zal controleren of de gebruiker wel authentiek is. De gebruiker kan inloggen via het on-screen keyboard op de MFD, of door de kaart aan de kaartlezer te presenteren. Als de gebruiker inlogt via het on-screen keyboard, zal er een login verzoek naar de Inepro Business Server worden gestuurd. De Inepro Business Server zal de gebruikersgegevens controleren en als deze correct is de gebruiker inloggen op de MFD. Als de gebruiker inlogt via een gebruikerskaart, zal de kaartlezer een inlogverzoek naar de Inepro Business Server sturen, als dit verzoek wordt goedgekeurd, wordt de gebruiker ingelogt en de kaart- en gebruikersgegevens naar de MFD gestuurd. 3. ‘PullPrint’ embedded applicatie Deze applicatie is verantwoordelijk voor het eigenlijke betaald afdrukken. De gebruiker kan een of meerder afdruktaken uit een lijst selecteren om te printen. De applicatie stuurt de lijst met de geselecteerde taken naar de Inepro Business Server, die de afdruktaken dan (via DocuPRO) zal vrijgeven.

Version 1.0.1 - 9

Open API Service

4. ‘Scan’ embedded applicatie De ‘Scan’ applicatie Zal de taak die door de gebruikers is ingescand wordt naar het betreffende email adres gestuurd of naar de scan map van de gebruiker. Het email adres en de scan map of 'Home Directory' kunnen worden ingesteld in de Inepro Back Office Manager. Voor deze functionaliteit moet de IneproOpenAPIFTP server actief zijn, en de gegevens van deze server moeten in de Inepro Back Office Manager zijn ingevuld! Lees meer over de Inepro Open API FTP server in dit deel: Open API FTP server 12 .


Open API FTP Service

IV

Deel

Open API FTP Service

Open API FTP Service De service moet alleen actief zijn als de Scan applicatie wordt gebruikt. Bekijk: Configuration.txt 14 .. De service zal de scan via FTP aan een SMTP server sturen, welke door het systeem is ingesteld door de systeem administrator, en de SMTP server zal de scan dan doorsturen naar het email adres van de gebruiker de thuis map (home directory).


Configuratie

V

Deel

Configuratie

Configuratie De configuration.txt file is het belangrijkste beheer mechanisme voor het Open API systeem. Dit bestand bevindt zich in de installatiemap. In deze table staat het configuration.txt bestand, met een uitleg van de instellingen. Value Mask

Default / example value

ApplicationServerIP

10.4.1.20

SecondaryServerIP

PrimaryServerTimoutInSeconds

DebugLevel

MFPPortWithSSL

<WindowsPort>

IneproTerminalServiceURL

IsPayConAuth

<0> or <1>

PayConAuthListenPort

<WindowsPort>

MFPAdminUserName

MFPAdminPassword

IsFTPServerAvailable FTPServer FTPPort FTPUserName

or <WindowsPort>

FTPPassword

AuthAppNo AuthAppID

AuthAppNode

Key


Description

These 2 settings are the IP addresses on which the main and secondary OpenAPI server are running, normally there will be no 10.4.1.20 'SecondaryServer', in these cases, the secondary address is the same as the main (ApplicationServer) address. This is the timeout (in seconds) until the applicatie 20 returns a NACK after a request from or to the multifunctional. Debug level OpenAPISDK log. Always 1, unless specified 1 differently by Inepro certified engineers. Port gebruikt voor communication between the multifunctional and service, 50003 don't change unless specified differently by Inepro certified engineers. Socket used for http://10.0. communication between 3.61:10035/ Open API and the Inepro soap/ITer Business Server, don't minalInterf change unless specified ace differently by Inepro certified engineers. 1 When this is set to 1, The Inepro IP card reader is used 10027 on the port number specified (10027 by default). Admin The User ID and password of the Admin account on the 12345678 multifunctional. No These settings will determine if FTP is used to 10.4.1.12 send the email to the SMTP 121 server in the ‘Scan’ sdk application. Additional setting for the FTP / SMTP sdk server can also be set here. 1 Installatie settings for the 3 INEPRO11 embedded applications, don't change unless SIMWIN specified differently by

Value Mask


AuthAppListenPort PrintAppNo PrintAppID PrintAppNode PrintAppListenPort ScanAppNo ScanAppID ScanAppNode ScanAppListenPort IsGlobalFunctionLimitation EnableBox EnableColorPrint EnableColorSend EnableMonochromePrint EnablePrintSend EnableCopy EnableFax EnablePrint EnableScan EnableScanToUsb EnableScanToUsb EnableAddressManualInput RegistrationTimeOutInSeconds

<WindowsPort> <WindowsPort> <WindowsPort> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1>

50004 2 INEPRO22 SIMWIN 50002 3 INEPRO33 SIMWIN 50005 1 1 1 1 1 1 1 1 1 1 1 1 1 30

ListenTimeOutInSeconds

30

IsDebugMode

<0> or <1>

1

EnableRawDataLogging

<0> or <1>

1

ScanAppType

or <S>

D

EnableUserDefaultApplication

1

EnableDefaultMyPanel DisplayDefaultMyPanel EnableCopyShortCut EnableScanFaxShortCut EnableBoxShortCut EnableImageDealerShortCut EnableBrowserShortCut EnableApplicationListShortCut

<0> or <1> or <Scan> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1> <0> or <1>

0 0 0 0 0 0 0 0

EnableAccountMap

<0> or <1>

1

CurrencySign

ScanResolution ScanFileType

??? ???

Standard PDF

ScanColor

???

FullColor

Key

DefaultApplicationName

Pull print

Description

Inepro certified engineers.

Customizable function restrictions, 1 = enabled, 0 = disabled.

Miscellaneous timeout settings, don't change unless specified differently by Inepro certified engineers. Enable writing to debug log files. 1 = enabled, 0 = disabled. Log de xml data uitgewisseld tussen de OpenAPI en de BusinesServer. Set scan application type. (D)ynamic or (S)tatic. Set default applicatie and type, can be either ‘Pull print’ or ‘Scan’.

Set the MyPanel screen and enable / disable shortcuts. 1 = enabled, 0 = disabled.

Enable accounting for print/scan/copy on the multifunctional. Set the currency sign for the multifunctional. Default scan settings for the multifunctional, don't change unless specified differently

Version 1.0.1 - 15

Configuratie

Value Mask Key


Language

???

English

CCScreenMode

<Select> or <Search>

Select

UserLabel PassLabel EnablePrintJobCustomScreen

<0> or <1>

InitString


Description

by Inepro certified engineers. Language User Interface Multifunctional CostCenter screen format, Can be either Select or Search.

User Password These user settings have no influence on the install / 0 or swipe uninstall procedures. card

Communicatie

VI

Deel

Communicatie

Communicatie In het Open API system communiceren de modules en services met elkaar via verschillende protocollen en poorten. Deze worden hieronder gespecificeerd.

Communicatie tussen OpenAPI en MFD Communicatie tussen OpenAPI en de MFD wordt gedaan via SOAP/XML boodschappen. Deze communicatie loopt over de poorten 50002, 50003, 50004 en 50005 (Bekijk : applistenport 15 instelling.). Poort 50003 is beveiligd via SSL, omdat deze gebruikt wordt voor de authenticatie. (Authenticatie is de tweede stap in het toegangscontroleproces. De eerste stap in dit proces is identificatie, de derde en laatste stap is autorisatie.) Communicatie tussen OpenAPI en de Business Server. Communicatie tussen OpenAPI en de Inepro Business Server wordt gedaan door middel van XML boodschappen, Deze berichten worden door een socket verzonden. Het IP deel van een socket is het IP adres van de machine die op de Inepro Business Server loopt, het poort nummer is standaard 10035. De gegevens van de IP kaartlezer wordt verzonden over poort 10028 van de business server naar de Open AI service, over poort 10027 en vice versa. Deze poort kan worden gewijzigd in het configuration.txt bestand bij deze instelling: : IsPayConAuth 14 . De communicatie tussen OpenAPI en de Inepro Business Server kunnen worden gelogt voor debug doeleinden. (Bekijk : IsDebugMode 15 instelling. en de logging checkbox in het printer configuration scherm). Communicatie tussen Inepro IP Kaartlezer en de Business Server. Communicatie tussen de kaartlezer en de Inepro Business Server loopt via TCP/IP poorten. De lezer communiceert met de Inepro Open API Server over poort 10039.


Logging

VII

Deel

Logging

Logging In the logging worden bepaalde systeem boodschappen gelogd, dit zijn gebruikelijkerwijs foutmeldingen maar, kunnen ook worden uitgebreid voor een uitgebreidere analyse. OpenAPIUserLevelLog Het belangrijkste log voor Open API is het OpenAPIUserLevelLog, dat standaard alleen foutmeldingen logt. Voor meer gedetailleerdeinformatie is de installing ‘ IsDebugMode’ in het configuration.txt bestand van belang, deze moet op '1' staan. Het vinkje ‘Enable Logging’ in de ‘Select Printer' groep moet worden aangevinkt in de instellingen van de printer die moet worden geanalyseerd. OpenAPIRawRequest & OpenAPIRawResponse Communicatie tussen de Business Server en de Open API server kan in de OpenAPIRawRequest en OpenAPIRawResponse bestanden gelogd. Om dit in te schakelen, stelt men ‘EnableRawDataLogging’ in op '1' in het configuration.txt bestand. OpenAPISDK1 & OpenAPISDK2 Communicatie tussen de MFD en de Open API Server zal worden gelogd in de OpenAPISDK1 of OpenAPISDK2 logbestanden. Deze logbestanden moeten alleen worden ingesteld naar advies van Inepro Support, de standaardwaarde is ‘ DebugLevel=1’ (uit). Deze logs zijn erg uitgebreid en kunnen in een erg beperkte tijd erg snel groeien, dus deze moeten met enige terughoudendheid worden gebruikt.


Troubleshooting

VIII

Deel

Troubleshooting

Troubleshooting Als er dingen niet gaan zoals verwacht, neem dan eerst dit hoofdstuk voordat u contact opneemt met de Inepro Support. De kans is aanwezig dat u het zelf kunt oplossen. Het hoofdstuk is opgezet in een vraag - antwoord - oplossing stramien, dat wil zeggen eerst wordt het vraagstuk benoemd, dan wordt een van de mogelijke oorzaken gegeven en daarna de stappen waarmee deze oorzaak kan worden weggenomen.

V - De applicatie wordt niet op de MFD geladen, waarom niet? A - Vermoedelijk is de copier niet klaar om de software te ontvangen omdat deze in een status is beland waarin hij dit niet kan. 1) De MFD opnieuw opstarten (aan- en uitzetten) zorgt er vaak voor dat de MFD in de staat komt waarin de software ontvangen kan worden. a) Start de MFD opnieuw op. V - De applicatie wordt op de MFD geladen, maar er kan geen verbinding gemaakt worden? A - Er zijn problemen met de verbinding. 1) Als een MFD constant: ‘Connecting to server’ toont, is de netwerkkaart geblokkeerd. a) Om een netwerkkaart tot rust te dwingen kan SSL gestart worden in de beheerdersinstellingen. Deze instellingen kunnen gevonden worden onder 'administrator/network settings/forward/TCP socket settings/TCP socket/ menu'. 2) Ook kan een proces de netwerk in een loop houden. De MFD moet dan waarschijnlijk opnieuw gestart worden om dit te herstellen. a) Herstart de MFD. 3) Controleer of de business server draait. a) Zo niet, start dan de Business server. 4) Poorten kunnen geblokkeerd zijn. a) Controleer of de benodigde poorten open staan in de firewall, en of alle andere netwerkapparaten op de route van MFD naar server die ook open hebben, met name poort 10035 is van belang, deze moet open staan. 5) Services kunnen geblokkeerd zijn. a) Herstart de services. Als de stappen het probleem niet verhelpen, zet dan OpenAPIUserlevelLog aan, loop de procedure opnieuw door en stuur de gegenereerde logs (met de tijd, datum en relevante IP-adressen naar Inepro Support ([email protected]).


Notities

IX

Deel

Notities

Notities Deze ruimte is bedoeld voor de notities van de lezer:


Version 1.0.1 - 25

Technical Manual DocuPRO embedded Client for Konica Minolta

Recommend Documents