IBI-helpMe Client Handbuch

Transkript

1 IBI-helpMe Client Aktuelle Version Gültig ab Verantwortlich für den Inhalt GR IBITECH AG Jurastrasse Münchenstein BL Switzerland Tel: Fax: ibitech.com 1/38

2 Inhaltsverzeichnis IBI-helpMe Client 1 Einführung Aufgaben der Anwendung Inbetriebnahme Übersicht Systemvoraussetzungen Nutzung eines Service Portals Supportfall aus dem Service Portal erstellen Ermittelte Informationen in die Service Portal Seite einfügen Integriertes Browserfenster Konfigurationsdatei Sendeart SMTP-Verbindungseinstellungen Empfänger Alternative Absender-Adresse Tastenkombination Neustart Synchronisationsintervall Fenstereinstellungen Einstellungen der Eingabefelder Einträge im Kontextmenü des Taskleistensymbols Allgemeine Einstellungen Kategorien Zu ermittelnden Informationen Zusätzliche Eingabefelder Service Portal - Platzhalter Service Portal - POST-Mappings Service Portal - Integriertes Browserfenster verwenden Lokalisierung Template verwenden Verteilung der Anwendung Anwendung ausführen Startparameter Arbeitsweise Übersicht Erfassung von Warnungen, Fehlern Verhalten beim Anwendungsstart Verhalten während des Betriebs Bedienung Übersicht Allgemein Supportfall erstellen MAPI SMTP SMTP-Passwort verschlüsseln Aktualisierungen Übersicht Anwendung aktualisieren /38

3 3/38

4 1 Einführung 1.1 Aufgaben der Anwendung Die IBI-helpMe Client-Anwendung stellt den Benutzern eine einfache Möglichkeit zur Erstellung eines Supportfalls zur Verfügung. Hierbei kann sie automatisch einen Screenshot erstellen und die aktuellen Daten des angemeldeten Users bzw. des verwendeten Endgeräts übermitteln. Darüber hinaus kann die IBI-helpMe Client-Anwendung als Einstiegspunkt zu einem bestehenden Service Portal genutzt werden. 4/38

5 2 Inbetriebnahme 2.1 Übersicht Dieses Kapitel befasst sich mit der Inbetriebnahme der IBI-helpMe Client- Anwendung. 2.2 Systemvoraussetzungen Um die IBI-helpMe Client-Anwendung ausführen zu können, wird mindestens das Betriebssystem Microsoft Windows XP mit aktuellem Service Pack vorausgesetzt. 2.3 Nutzung eines Service Portals Die IBI-helpMe Client-Anwendung kann als Einstiegspunkt zu einem Service Portal genutzt werden. Dabei wird eine individuell gestaltete HTML-Seite anstelle des üblichen Dialogs zur Erstellung eines Supportfalls angezeigt. Das Erstellen eines Supportfalls über den klassischen Supportfall erstellen-dialog kann dabei weiterhin, falls gewünscht, über das Kontextmenü des Taskleistensymbols erreicht werden oder komplett deaktiviert werden. Um diese Möglichkeit nutzen zu können, erstellen Sie im gleichen Verzeichnis, in dem sich die IBI-helpMe Client-Anwendung befindet, ein neues Verzeichnis namens CustomContent und legen Sie dort eine HTML-Datei namens index.html mit beliebigem HTML-Inhalt an. Alternativ können Sie einen Pfad oder eine URL zu einer beliebigen HTML-Datei über den Startparameter /CustomContent angeben (siehe Startparameter) Supportfall aus dem Service Portal erstellen Es ist möglich, aus einem Service Portal heraus einen Supportfall zu eröffnen. Um dies zu erreichen, kann die URL ibihelpme:showsupportdialog() verwendet werden. Soll der Supportfall erstellen Dialog bereits mit bestimmten Werten 5/38

6 belegt werden, kann dies durch einen POST-Aufruf der URL ibihelpme:showsupportdialogwithpost() erreicht werden. Derzeit kann das Betrefffeld, sowie das sfeld vorbelegt werden. (Weitere Informationen siehe Service Portal - POST-Mappings) Ermittelte Informationen in die Service Portal Seite einfügen Die von IBI-helpMe ermittelten Informationen über den Benutzer oder den Computer können in eine Service Portal Seite eingebettet werden. Welche Informationen ermittelt werden können, wird unter Zu ermittelnden Informationen erläutert. Lediglich die Schreibweise unterscheidet sich ggü. der aus der Konfigurationsdatei. Das folgende Bespiel zeigt den Unterschied: Konfigurationsdatei <! Active Directory > <collectedvalue type="activedirectory" displayname="telefon" value="telephonenumber" source="user" /> <! Local > <collectedvalue type="local" displayname="sitzungsid" value="sessionid" /> Service Portal <! Active Directory > {%ActiveDirectory.User.telephoneNumber%} <! Local > {%Local.SessionId%} Integriertes Browserfenster Wenn aus dem Service Portal heraus ein neues Fenster geöffnet wird (z.b. mit der target-eingeschaft _blank eines anchor-html-elements), wird standardmäßig ein neues Internet Explorer-Fenster geöffnet. Dieses Verhalten kann jedoch so angepasst werden, dass IBI-helpMe ein integriertes Browserfenster öffnet. Wie diese Einstellung vorgenommen wird, wird unter Service Portal - Integriertes Browserfenster verwenden beschrieben. 6/38

7 2.4 Konfigurationsdatei Jede IBI-helpMe Client-Anwendung benötigt für den Betrieb eine Konfigurationsdatei. Normalerweise befindet sich diese im gleichen Verzeichnis, indem sich auch die IBI.helpMe.Client.exe befindet. Es ist allerdings möglich, diese an einem separaten Speicherort abzulegen. Voraussetzung hierfür ist, dass die IBI-helpMe Client Anwendung auf die Datei zugreifen kann. Der Pfad zur Konfigurationsdatei muss in diesem Fall mittels eines Startparameters (siehe Startparameter) angegeben werden. Derzeit stehen die im Folgenden beschriebenen Konfigurationsmöglichkeiten zur Verfügung Sendeart [deliverytype] Legt fest, welche Senderart verwendet werden soll. Zur Auswahl stehen die Sendearten MAPI und SMTP. Bei der Sendeart MAPI wird ein installierter - Client benötigt, welcher die Simple MAPI (Messaging Application Programming Interface) Schnittstelle unterstützt. Wird diese Sendeart ausgewählt, erstellt die IBI-helpMe Client-Anwendung aus den eingegebenen Daten eine -Vorlage, welche der Benutzer anschließend absenden muss. Mehr Komfort bietet dagegen die Auswahl der Senderart SMTP, da die eingegeben Daten direkt mittels SMTP versendet werden. Beispiel <! Sendeart festlegen [SMTP oder MAPI] <deliverytype>mapi</deliverytype> SMTP-Verbindungseinstellungen [connection] Wird die Sendeart SMTP ausgewählt, müssen in der Konfigurationsdatei die entsprechenden Verbindungseinstellungen zu dem eingesetzten SMTP-Server konfiguriert werden. Der Zugriff auf den SMTP-Server sollte mittels eines entsprechenden Benutzers erfolgen. Hierfür bietet die IBI-helpMe Client- Anwendung die Möglichkeit, das verwendete Login-Passwort verschlüsselt in die 7/38

8 Konfigurationsdatei abzulegen (siehe SMTP-Passwort verschlüsseln). Wird usesecureauthentication auf den Wert True gesetzt, wird die Authentifizierungsmethode NTLM verwendet. Mittels dieser Methode wird das Passwort zu keinem Zeitpunkt über das Netzwerk verschickt. Beispiel <!-- SMPT-Verbindungseinstellungen <connection name="smtp"> <url>smtp.company.net</url> <domain>userdomain</domain> <username>username</username> <!-- Verschlüsseltes Passwort Um ein Passwort verschlüsseln zu können, muss die Anwendung mit dem Parameter /Admin gestartet werden. <password>8+hnxnacucl+e+oh9//w3w==</password> <!-- Sorgt dafür, dass nur sichere Authentifizierungsmethoden verwendet werden. <usesecureauthentication>true</usesecureauthentication> </connection> Empfänger [ recipient] Hiermit wird die Standard-Empfänger- -Adresse angegeben. Alle mittels der IBI-helpMe Client-Anwendung erzeugten Supportfälle, werden an die hier hinterlegte -Adresse gesendet, sofern in den Kategorien (siehe unten) keine alternativen -Empfänger eingetragen wurden. Beispiel <!-- -Empfänger [Support- -Adresse] 8/38

9 2.4.4 Alternative Absender-Adresse [alternativesenderaddress] Hiermit wird eine alternative -Adresse festgelegt, welche im SMTP-Modus verwendet wird, wenn das Feld Ihre -Adresse nicht ausgefüllt wird. Beispiel <!-- Alternativer -Absender (nur im SMTP-Modus). Wird verwendet, wenn keine Absender-Adresse angegeben wurde Tastenkombination [generatesupportmessage] Die IBI-helpMe Client-Anwendung bietet die Möglichkeit, das Fenster für das Erstellen eines Supportfalls durch betätigen einer bestimmten Tastenkombination einzublenden. Die entsprechende Tastenkombination kann an dieser Stelle angepasst werden. Eine Tastenkombination besteht aus einem sog. Modifier und einem Virtual Key Zur Auswahl stehen die Modifier WIN, ALT, STRG, SHIFT (SHIFT nur in Verbindung mit einem zusätzlichen Modifier). Ein Virtual Key kann ein Zeichen A-Z, 0-9 oder einen andere Taste, welche allerdings in HEX- Repräsentation (z.b. für die ESC-Taste: 0x1B) angegeben werden muss. Es ist zu beachten, dass eine bereits von einer anderen Anwendung belegte Tastenkombination, nicht verwendet werden kann, solange diese ausgeführt wird. Beispiel <!-- Definiert einen alternativen Global HotKey. Ein HotKey muss aus mindestens einem Modifier [WIN, ALT, CTRL, SHIFT (nicht alleine)] und aus einem (Virtual) Key [A-Z, 0-9 oder Virtual Key in Hex-Repräsentation (z.b. 0x1B für ESC)] bestehen. <hotkeys> <generatesupportmessage>win + SHIFT + H</generateSupportMessage> </hotkeys> 9/38

10 2.4.6 Neustart [lastrestart] Hiermit ist es möglich, einen Neustart der Anwendung zu erzwingen (z. B. auf Grund eines Updates). Hierzu muss die vorhandene ganze Zahl durch eine beliebige andere ersetzt werden. Beispiel <!-- Gibt an, ob ein Neustart durchgeführt werden soll. Um ein Neustart der Anwendung einzuleiten muss die vorhandene Zahl durch eine beliebig andere Zahl ersetzt werden. [NEUSTART => lastrestartalt!= lastrestartneu] <lastrestart>1</lastrestart> Synchronisationsintervall [syncinterval] Da alle Einstellungen während des Betriebs verändert werden können, prüft die IBI-helpMe Client-Anwendung in regelmäßigen Abständen, ob Änderungen an der Konfigurationsdatei vorgenommen worden sind. Der Zeitabstand (in Sekunden) zwischen einer Prüfung kann an dieser Stelle festgelegt werden. Je kleiner diese Zahl, desto häufiger wird die Datei auf Änderungen geprüft. Werte unter 30 Sekunden sind nicht erlaubt. Beispiel <!-- Intervall (in Sekunden) in dem diese Datei auf Änderungen überprüft wird [Wert >= 30] <syncinterval>30</syncinterval> 10/38

11 2.4.8 Fenstereinstellungen [windowsettings] In diesem Bereich lassen sich die Fenstereigenschaften der folgenden Dialoge festlegen: Dialog Supportfall erstellen Service Portal Integrierter Browser des Service Portals Id SupportCase ServicePortal ServicePortaIntegratedBrowser Folgende Eigenschaften können festgelegt werden: Eigenschaft Werte ismaximized True, False Legt fest, ob das Fenster maximiert dargestellt werden soll. canmaximize True, False Legt fest, ob das Fenster maximierbar ist. canresize True, False Legt fest, ob die Fenstergröße angepasst werden darf. sizingmode Content, Window Legt fest, wie die Angabe der Fenstergröße interpretiert wird. Wird Window gewählt, wird die Größe des gesamten Fensters festgelegt. Wird stattdessen Content gewählt, wird die Größe der zur Verfügung stehenden internen Fläche (abzgl. unterer Bereich mit den Schaltflächen) festgelegt. width Eine Zahl > 0 Fensterbreite height Eine Zahl > 0 Fensterhöhe 11/38

12 Beispiel <!-- Fenstereinstellungen <windowsettings> <window id="supportcase" sizingmode="window" width="650" height="550" canmaximize="false" canresize="false" /> <window id="serviceportal" sizingmode="content" width="650" height="550" ismaximized="true" /> <window id="serviceportalintegratedbrowser" sizingmode="content" width="650" height="550" ismaximized="true" /> </windowsettings> Einstellungen der Eingabefelder [controlsettings] Hiermit ist es möglich bestimmte Eingabefelder, die im Standardverhalten als Pflichtfelder definiert sind, auf optionale Felder umzustellen. Derzeit können folgende Felder parametrisiert werden: Id des Eingabefelds subject Description Betreff-Feld sfeld Beispiel <!-- Ermöglicht das Ändern des Verhaltens bestimmter Eingabefelder. <controlsettings> <control id="subject" isoptional="true" /> <control id="description" isoptional="false" /> </controlsettings> 12/38

13 Einträge im Kontextmenü des Taskleistensymbols [traymenuitemsettings] Wenn Sie IBI-helpMe zur Anzeige einer Service Portal Seite verwenden, können Sie hier festlegen, ob bestimmte Einträge im Kontextmenü des Taskleistensymbols angezeigt werden sollen. Beispiel <!-- Ermöglicht das Anpassen der Kontextmenü-Einträge des Taskleistensymbols. <traymenuitemsettings> <!-- Eintrag "Supportfall erstellen" ausblenden <item id="createsupportcase" isvisible="false" /> <!-- Eintrag "Service Portal anzeigen" <item id="showserviceportal" isvisible="true" /> </traymenuitemsettings> Allgemeine Einstellungen [generalsettings] In diesem Bereich können verschiedene Einstellungen vorgenommen werden. Derzeit stehen folgendende Einstellmöglichkeiten zur Verfügung: 13/38

14 SupportCase.CreateScreenshot.ServicePortal Erlaubte Werte Yes, No, Ask Legt fest, ob ein Bildschirmabbild automatisch erstellt werden soll, wenn ein Supportfall aus dem Service Portal erstellt wird. Yes Beim Öffnen des Supportfall erstelle-dialogs wird automatisch ein Bildschirmabbild erstellt. No Beim Öffnen des Supportfall erstellen-dialogs wird kein Bildschirmabbild erstellt. Ask [Standard] Vor dem Öffnen des Supportfall erstellen-dialogs wird ein Auswahldialog angezeigt, der den Anwender fragt, ob ein Bildschirmabbild erstellt werden soll oder nicht. SupportCase.CreateScreenshot.Direct Erlaubte Werte Yes, No, Ask Legt fest, ob ein Bildschirmabbild automatisch erstellt werden soll, wenn ein Supportfall direkt (z.b. über das Startleistensymbol) erstellt wird. Yes [Standard] Beim Öffnen des Supportfall erstelle-dialogs wird automatisch ein Bildschirmabbild erstellt. No Beim Öffnen des Supportfall erstellen-dialogs wird kein Bildschirmabbild erstellt. Ask Vor dem Öffnen des Supportfall erstellen-dialogs wird ein Auswahldialog angezeigt, der den Anwender fragt, ob ein Bildschirmabbild erstellt werden soll oder nicht. 14/38

15 SupportCase.SenderAddress.Enabled Erlaubte Werte True, False Gibt an, ob die Absender -Adresse im Supportfall erstellen-dialog editiert werden darf. (Nur im SMTP-Modus relevant) True [Standard] Das Feld darf editiert werden. False Das Feld darf nicht editiert werden. Beispiel <!-- Allgemeine Einstellungen <generalsettings> <! Supportfall erstellen über Service Portal: Screenshot erstellen (Werte: [Ask, Yes, No], Standard: [Ask]) <setting key="supportcase.createscreenshot.serviceportal" value="ask" /> <! Direkter Aufruf von Supportfall erstellen : Screenshot erstellen (Werte: [Ask, Yes, No], Standard: [Yes]) <setting key="supportcase.createscreenshot.direct" value="yes" /> <! Gibt an, ob die Absender -Adresse im Supportfall erstellen Dialog editiert werden darf. (Werte: [True, False], Standard: [True]) <setting key="supportcase.senderaddress.enabled" value="true" /> </generalsettings> Kategorien [categories] Bei der Erstellung eines Supportfalls ist es möglich dem Anwender eine Kategorisierung vornehmen zu lassen. Hierzu wird ein zusätzliches Eingabefeld angezeigt, welches sich ggf. als Pflichtfeld festlegen lässt. 15/38

16 Kategorien können frei definiert werden. Jede Kategorie kann weitere Unterkategorien beinhalten. Für Kategorien und Unterkategorien können alternative -Empfänger festgelegt werden. Darüber hinaus besteht die Möglichkeit den unter value festgelegten Wert einer selektierten Kategorie (category) bzw. Unterkategorie (subcategory) automatisch in die Betreffzeile einzufügen (addvaluetosubject). Beispiel <!-- Kategorien <categories displayname="{category}" isoptional="false"> <category displayname="{category.software}" value="software" addvaluetosubject="no"> <subcategories> <subcategory displayname="{category.software.applicationa}" value="software"> < recipients> < recipient sendtype="to"> </ recipient> < recipient sendtype="cc"> </ recipient> </ recipients> </subcategory> <subcategory displayname="{category.software.applicationb}" value="software"/> </subcategories> < recipients> < recipient </ recipients> </category> <category displayname="{category.it}" value="it" addvaluetosubject="after" /> </categories> 16/38

17 Hinweis Bei den displayname-werten im Beispiel handelt es sich um Resource-IDs (erkennbar an den geschweiften Klammern). Diese Resource-Ids müssen in den Lokalisierungsdateien definiert werden. Weitere Informationen sind im Kapitel 2.5 Lokalisierung zu finden Zu ermittelnden Informationen [collectedvalues] Ein Kern-Feature von IBI-helpMe ist die Fähigkeit, Informationen, die beim Bearbeiten eines Supportfalls von Bedeutung sein können, ohne Benutzerinteraktion zu ermitteln. Welche Informationen ermittelt werden sollen, wird in der Konfigurationsdatei festgelegt. Welche Informationen ermittelt werden können wird im Folgenden erläutert: Type= Local Informationen, die den lokalen Client-PC betreffen. Wert (value) OS OsSystemType Computername Clientname Username SessionID IP Name und Version des eingesetzten Betriebssystems. Betriebssystemtyp (32-bit oder 64-bit) Name des Computers Name des Clients, falls eine Verbindung über Remote Desktop besteht. Benutzername ID der Windowssitzung Zugewiesene IP-Adressen 17/38

18 Type= ActiveDirectory Informationen, die aus dem Active Directory stammen. Quelle (source) Attributname (value) User telephonenumber Telefonnummer des Benutzers User Beliebig Beliebiges Active Directory Attribut, welches mit dem Benutzer-Objekt verknüpft ist. Computer countrycode Ländereinstellung des Computers Computer Beliebig Beliebiges Active Directory Attribut, welches mit dem Computer-Objekt verknüpft ist. Hinweis Bei den oben genannten Einträgen handelt es sich lediglich um Beispiele. Welche Active Directory Attribute vorhanden sind, kann mittels der Microsoft-Anwendung Active Directory-Benutzer und -Computer in Erfahrung gebracht werden. Unter den Einstellungen des jeweiligen Active Directory-Benutzers bzw. -Computers werden die einzelnen Attribute in der Spalte Attribute Editor aufgelistet. Möchte man den Wert eines Attributs mittels IBI-helpMe ermitteln, muss dessen Name, wie in den o.g. Beispielen, als value angegeben werden. Type= Input Werte aus der IBI-helpMe-Eingabemaske. Wert (value) Category Ausgewählte IBI-helpMe Kategorie, falls verwendet. Type= Static Statische Werte, welche lediglich "durchgeschleift" werden. Wert (value) Beliebig Der Wert einer statischen Information kann frei gewählt werden. 18/38

19 Beispiel <!-- Zu ermittelnden Informationen. Hinweis: Wenn keine Informationen ermittelt werden sollen, müssen alle collectedvalue-einträge auskommentiert oder entfernt werden. Wird stattdessen der komplette collectedvalues-block auskommentiert oder entfernt, werden - zur Wahrung der Kompatibilität zu den Vorgängerversionen - die standardmäßig eingestellten Informationen ermittelt. <collectedvalues> <collectedvalue type="local" displayname="betriebssystem" value="os" /> <collectedvalue type="activedirectory" displayname="telefon" value="telephonenumber" source="user" /> <collectedvalue type="static" displayname="installationsid" value="01234" /> <collectedvalue type="input" value="category"/> </collectedvalues> Zusätzliche Eingabefelder [inputfield] Falls die ermittelnden Informationen nicht ausreichen, besteht die Möglichkeit zusätzliche Eingabefelder im Supportfall erstellen Dialog anzuzeigen, welche der Anwender ausfüllen kann. Die Felder können bei Bedarf als Pflichtfelder festgelegt werden. 19/38

20 Um ein zusätzliches Eingabefeld anzuzeigen muss die Konfigurationsdatei wie folgt erweitert werden: <!-- Konfigurationsdatei <configuration version="1.2.0"> <applicationsettings>... <!-- Zusätzliches Eingabefeld 1 <inputfield displayname="{inputfield.title}" isoptional="false" /> <!-- Zusätzliches Eingabefeld 2 <inputfield displayname="{inputfield2.title}" isoptional="true" />... </applicationsettings> </configuration> Die Eingabe des Anwenders wird in der versendeten im Bereich der ermittelten Informationen eingefügt, falls das entsprechende Feld vom Anwender ausgefüllt wurde Service Portal - Platzhalter [customreplacements] IBI-helpMe ist in der Lage mit einer Service Portal Seite zu interagieren. Bestimmte Platzhalter, welche in der Konfigurationsdatei definiert wurden können beim Aufruf der Service Portal Seite entsprechend durch Ihren Wert ersetzt werden. Die Platzhalter werden im Bereich customreplacements unter customcontent definiert. Im key -Attribut wird der Name des Platzhalters definiert, welcher in der Service Portal Seite zur Erkennung verwendet wird. Im value-attribut wird der zu verwendete Text hinterlegt. Damit IBI-helpMe erkennt, dass es sich um ein Platzhalter handelt wird, muss innerhalb der Service Portal Seite folgende Syntax verwendet werden: {%Config.KEY%} 20/38

21 Beispiel Configuration.xml <!-- Service Portal Einstellungen <customcontent> <! Texte die in die Service Portal Seite eingefügt werden <customreplacements> <customreplacements key="url" value=" /> </customreplacements> </customcontent> Index.html <!-- Service Portal Seite <html>... <body> </body>... </html> <a href="{%config.url%}">link</a> Service Portal - POST-Mappings [postdatamappings] Innerhalb einer Service Portal Seite ist es möglich, einen Supportfall über einen HTML-POST-Aufruf zu eröffnen. Die beim POST-Aufruf ermittelten Daten können bei Bedarf im Supportfall erstellen Dialog von IBI-helpMe übernommen werden. Derzeit können die Felder Betreff (id="subject") und (id="description") abgefüllt werden. Mittels Platzhaltersyntax {%Html-Name%} kann auf die im POST-Aufruf ermittelten Daten zugegriffen werden. 21/38

22 Configuration.xml <!-- Service Portal Einstellungen <customcontent> <! Mapping eines POST-Aufrufs <postdatamappings> <control id="subject"> {%selpriority%} {%txtsubject%} </control> <control id="description"> {%txtdescriptionshort%}\n\n {%txtdescription%} </control> </postdatamappings> </customcontent> 22/38

23 Index.html <!-- Service Portal Seite <html>... <body> <form enctype= application/x-www-form-urlencoded" action="ibihelpme:showsupportdialogwithpost()" id="showsupportdialogfrom" method="post"> </form> </body>... </html> Dringlichkeit:<br/> <select name="selpriority"> <option value="prio0">normal</option> <option value="prio1">dringend</option> </select> <br/><br/> Betreff:<br/> <input type= text name= txtsubject /> <br/><br/> (kurz):<br/> <input type= text name= txtdescriptionshort /> <br/><br/> :<br/> <textarea type= text name= txtdescription /> Service Portal - Integriertes Browserfenster verwenden [newwindowbrowsertype] Wird innerhalb einer Service Portal Seite ein neues Browserfenster geöffnet, wird standardmäßig ein neues Internet Explorer Fenster geöffnet. Alternativ lässt sich IBI-helpMe so konfigurieren, dass stattdessen ein integriertes Browserfenster geöffnet wird. Dies hat der Vorteil, dass sich die Fenstereigenschaften, analog zu dem Service Portal Fenster, einstellen lassen. 23/38

24 So stellen Sie in der Konfigurationsdatei das Verwenden eines integrierten Browserfensters ein: <!-- Service Portal Einstellungen <customcontent> <! Gibt an, welcher Browsertyp verwendet werden soll, wenn ein neues Browserfenster geöffnet werden soll. Erlaubte Werte: [default, integrated] <newwindowbrowsertype>integrated</ newwindowbrowsertype > </customcontent> Die zuvor erwähnten Fenstereigenschaften des integrierten Browserfensters können im Bereich windowsettings der Konfigurationsdatei eingestellt werden. Die entsprechende Id lautet ServicePortaIntegratedBrowser. Weitere Informationen sind im Bereich Fenstereinstellungen dieses Kapitels zu finden. 2.5 Lokalisierung Die IBI-helpMe Client-Anwendung ist vollständig lokalisierbar. Dazu existiert im Client-Verzeichnis das Resources-Verzeichnis. In diesem Verzeichnis befindet sich für jede Sprache eine entsprechende Lokalisierungsdatei. Standardmäßig steht die IBI-helpMe Client Anwendnung in den Sprachen Deutsch und Englisch zur Verfügung. Dementsprechend befinden sich im Resources-Verzeichnis die Dateien strings.de.xml (Deutsch) und strings.default.xml (Default-Sprache, in diesem Fall Englisch). Soll eine weitere Sprache unterstützt werden, muss lediglich eine weitere strings.{iso-sprachcode}.xml-datei mit den lokalisierten Texten in das Verzeichnis abgelegt werden. In einer solchen Lokalisierungsdatei können individuelle Einträge definiert werden, die z.b. zur Lokalisierung der Kategorien verwendet werden können Template verwenden Das für das Versenden eines Supportfalls verwendete -Format kann bei Bedarf selbst festgelegt werden. Dazu muss eine Datei namens Mail.template im Anwendungsverzeichnis erstellt werden. Ein alternativer Pfad zu einer Template- Datei kann mittels dem Startparameter /MailTemplate angegeben werden. Die Zeichenkodierung der Datei muss auf UTF-8 eingestellt sein. Der Inhalt der Datei kann beliebig gestaltet werden. Das Einfügen der ermittelten Informationen, sowie der Benutzereingaben geschieht mittels Platzhalter. Das Format der Platzhalter sieht wie folgt aus: 24/38

25 Benutzereingaben Eingegebener Betreff Eingegebene Ausgewählte Kategorie Wert des zusätzlichen Eingabefelds Platzhalter {%Input.Subject%} {%Input.Description%} {%Input.Category%} {%Input.InputField%} Zu ermittelnde Informationen Lokale Informationen Betriebssystem Betriebssystemtyp (32-bit oder 64-bit) Computername Clientname, falls eine Verbindung über Remote Desktop besteht. Benutzername Sitzungs ID Zugewiesene IP-Adressen Platzhalter {%Local.OS%} {%Local.OsSystemType%} {%Local.Computername%} {%Local.Clientname%} {%Local.Username%} {%Local.SessionID%} {%Local.IP%} Active Directory Informationen Es können alle lesbaren ActiveDirectory-Attribute des Benutzers, sowie des Computers ermittelt werden. Der Platzhalter setzt sich dabei wie folgt zusammen: 1. {% 2. ActiveDirectory 3. [Punkt] 4. Quelle: Benutzer (User) oder Computer (Computer) 5. [Punkt] 6. Name des Attributs 7. %} 25/38

26 Beispiele Telefonnummer des Benutzers Ländereinstellung des Computers Platzhalter {%ActiveDirectory.User.telephoneNumber%} {%ActiveDirectory.Computer.countryCode%} Beispiel einer -Template-Datei {%Input.Description%} --- [Computername] {%Local.Computername%} [ -Adresse] {%ActiveDirectory.User.mail%} 2.7 Verteilung der Anwendung Die IBI-helpMe Client-Anwendung benötigt keine Installation. Deshalb gestaltet sich die Verteilung sehr einfach. Eine besonders einfache Möglichkeit besteht darin, die Anwendung über eine Netzwerkfreigabe bereitzustellen. Alternativ besteht auch die Möglichkeit die Anwendung lokal, mittels einer Softwareverteilungsanwendung, auf den gewünschten PCs zu installieren. Hierbei ist zu beachten, dass die Anwendung mittels des Startparameters /NoLocalCopy gestartet wird, sodass keine lokale Kopie im Benutzerverzeichnis angelegt wird. Unabhängig von der Verteilungsart, muss sichergestellt werden, dass die Anwendung beim Login eines Anwenders automatisch gestartet wird. Dies kann zum Beispiel mittels eines Scripts erfolgen, welches das Betriebssystem automatisch bei einem Login ausführt (Login-Script). 2.8 Anwendung ausführen Wird die bei der Lieferung vorhandene Ordnerstruktur beibehalten, kann die IBIhelpMe Client-Anwendung in der Regel ohne Angabe von Startparametern gestartet werden. In diesem Fall wird eine Konfigurationsdatei Namens Configuration.xml im gleichen Verzeichnis, in dem sich die Anwendung befindet, erwartet. Darüber hinaus wird beim Start der Anwendung eine lokale Kopie im Benutzerverzeichnis 26/38

27 angelegt, sodass die Anwendung bei einem Ausfall der Netzwerkverbindung weiterhin ausgeführt werden kann. Als Sendeart wird standardmäßig MAPI verwendet. Je nach Einsatzweck besteht die Möglichkeit, das Verhalten der IBI-helpMe Client-Anwendung durch die Angabe von Startparametern entsprechend anzupassen. Nachfolgend werden alle verfügbaren Startparameter aufgelistet und deren Funktion erläutert Startparameter <Pfad zur Konfigurationsdatei> oder /Configuration <Pfad zur Konfigurationsdatei> Anmerkung Optional Dieser Parameter muss angegeben werden, wenn die Konfigurationsdatei sich nicht mit dem Namen Configuration.xml im gleichen Verzeichnis befindet, von dem aus auch die Anwendung gestartet wird. Falls der Pfad zur Konfigurationsdatei an erster Stelle übergeben wird, muss das Schlüsselwort /Configuration nicht angegeben werden. Beispiele IBI.helpMe.Client.exe /Param_0... /Param_n Ohne Angabe einer Konfigurationsdatei. In diesem Fall muss sich eine Datei namens Configuration.xml im Anwendungsverzeichnis befinden. IBI.helpMe.Client.exe "\\fileserver\ibishare$\config.xml" /Param_1... /Param_n Angabe des Pfades zur Konfigurationsdatei an erster Stelle. In diesem Fall muss das Schlüsselwort /Configuration nicht angegeben werden. IBI.helpMe.Client.exe /Param_0... /Param_n /Configuration "\\fileserver\ibishare$\config.xml" Angabe des Pfades zur Konfigurationsdatei an beliebiger Stelle. In diesem Fall muss das Schlüsselwort /Configuration angegeben werden. 27/38

28 /Language <Sprachkennung im ISO-Format> Anmerkung Optional, erst ab Version verfügbar Hiermit ist es möglich, die Sprache der Anwendung unabhängig von den Benutzereinstellungen festzulegen. Beispiele IBI.helpMe.Client.exe /Language en Die Sprache der Anwendung ist Englisch. /Admin Anmerkung Optional Durch Angabe dieses Parameters wird die IBI-helpMe Client-Anwendung im Administrationsmodus gestartet. Derzeit besteht dort lediglich die Möglichkeit ein Passwort für die SMTP-Verbindung zu verschlüsseln. Beispiele IBI.helpMe.Client.exe /Language en Die Sprache der Anwendung ist Englisch. /CustomContent <URL oder Pfad zu einer HTML-Datei> Anmerkung Optional, erst ab Version verfügbar Geben Sie diesen Parameter an, wenn Sie einen alternativen Pfad zu einer Service Portal Seite angeben möchten. Beispiele IBI.helpMe.Client.exe /CustomContent " Angabe einer URL als Quelle. IBI.helpMe.Client.exe /CustomContent "\\fileserver\index.html" Angabe eines Pfades zu einer HTML-Datei. 28/38

29 /ErrorLogPath <Pfad zu einem Verzeichnis> Anmerkung Optional Mittels dieses Parameters ist es möglich, einen alternativen Ort zur Ablage der Fehler-Log-Datei festzulegen. Wird dieser Parameter nicht angegeben, wird ein Ordner namens Errors im gleichen Verzeichnis, in dem sich die Konfigurationsdatei befindet, erwartet. Beispiele IBI.helpMe.Client.exe /ErrorLogPath "\\fileserver\errorlogs" Fehlerdatei wird an einem benutzerdefinierten Ort abgelegt. /FixTray Anmerkung Optional, ab Version verfügbar Ab Windows 7 werden die Symbole neben der Systemuhr (TrayIcons) nur noch temporär angezeigt. Dem Benutzer wird die Möglichkeit eingeräumt das TrayIcon permanent im sichtbaren Bereich zu setzen. Möchte man als Administrator sicherstellen, dass das IBI-helpMe-Symbol immer sichtbar bleibt, kann man die Anwendung mittels dieses Parameters starten. Wichtig: Wenn die Anwendung mit diesem Parameter gestartet wird, darf die Explorer.exe nicht ausgeführt werden, da die Einstellungen sonst nicht übernommen werden. Ein geeigneter Zeitpunkt für die Ausführung ist z.b. während des Windows-Logoff-Vorgans in einem Windows-Logoff-Script. /OpenSupportCase Anmerkung Optional Mittels dieses Parameters wird beim Start der Anwendung das Supportfall erstellen-fenster angezeigt. Wird bereits eine Instanz der Anwendung ausgeführt, wird die bestehende Instanz benachrichtigt, das Fenster zu öffnen. 29/38

30 /OpenServicePortal Anmerkung Optional Mittels dieses Parameters wird beim Start der Anwendung das Service Portal- Fenster angezeigt. Wird bereits eine Instanz der Anwendung ausgeführt, wird die bestehende Instanz benachrichtigt, das Fenster zu öffnen. /MailTemplate Anmerkung Optional, ab Version Geben Sie diesen Parameter an, wenn Sie einen alternativen Pfad zu einer E- Mail-Template-Datei angeben möchten. Beispiele C:\Program Files\IBI-helpMe\IBI.helpMe.Client.exe /MailTemplate "C:\mail.tpl" Alternativer Pfad zu einer -Template-Datei. /NoLocalCopy Anmerkung Optional Durch Angabe dieses Parameters wird verhindert, dass eine Kopie der Anwendung in dem lokalen Anwendungsdatenordner des Benutzers erstellt wird und von dieser Stelle aus ausgeführt wird. Es wird empfohlen diesen Parameter nur dann einzusetzen, wenn die Anwendung bereits lokal zur Verfügung steht und nicht aus einer Netzwerkfreigabe heraus gestartet wird. Beispiele C:\Program Files\IBI-helpMe\IBI.helpMe.Client.exe "\\fileserver\ibishare$\config.xml" /NoLocalCopy Verhindert, dass die Anwendung eine Kopie von sich selbst im lokalen Anwendungsdatenordner des Benutzers erstellt und ausführt. 30/38

31 3 Arbeitsweise 3.1 Übersicht Dieses Kapitel behandelt die Arbeitsweise der IBI-helpMe Client-Anwendung. Zunächst wird das Verhalten der Anwendung beim Auftritt eines Fehlers erläutert. Anschließend werden die Schritte erläutert, welche die Anwendung beim Starten oder im laufenden Betrieb durchführt, wenn bestimmte Ereignisse auftreten. 3.2 Erfassung von Warnungen, Fehlern Die IBI-helpMe Client-Anwendung ist in der Lage bestimmte Ereignisse, die während des Betriebs auftreten, zu erfassen. Es wird zwischen zwei Arten von Ereignissen unterschieden: Warnungen und Fehlern. Ein Fehler führt immer zum Beenden der Anwendung, während beim Auftritt einer Warnung die Anwendung weiterhin ausgeführt werden kann. Warnungen und Fehler werden gemeinsam in einer Datei erfasst. Tritt eine Warnung oder ein Fehler auf, versucht die Anwendung das Ereignis in einer Datei zu dokumentieren. Damit dies gelingt, muss sichergestellt werden, dass ein Verzeichnis Namens Errors im gleichen Verzeichnis, in dem sich die Konfigurationsdatei befindet, angelegt wurde und die Benutzer über die entsprechenden Rechte zum Anlegen und Mutieren von Files haben. Kann das Ereignis nicht in die Fehler-Log-Datei erfasst werden, wird es stattdessen in das betriebssystemeigene Event-Log erfasst. Im Gegensatz zu einer Warnung wird die Anwendung beim Auftreten eines Fehlers, nachdem dieser erfasst wurde, beendet. Warnungen werden in der Fehler-Log-Datei mit einem W gekennzeichnet, während Fehler immer mit einem E gekennzeichnet werden. Der Speicherort der Log-Dateien kann durch Angabe eines entsprechenden Startparameters (siehe ErrorLogPath) verlegt werden. 31/38

32 3.3 Verhalten beim Anwendungsstart Die IBI-helpMe Client-Anwendung erstellt standardmäßig nach dem Start zunächst eine Kopie von sich selbst in das lokale Anwendungsdaten-Verzeichnis des Benutzers, führt diese Instanz anschließend aus und beendet sich. Dieser Schritt wird durchgeführt, um die Netzwerk-Abhängigkeit auf ein Minimum zu reduzieren. Dadurch kann die Anwendung nach einem Unterbruch der Netzwerkverbindung weiterhin ausgeführt werden. Mittels des Startparameters /NoLocalCopy ist es möglich, das Erstellen einer Kopie in das lokale Anwendungsdaten-Verzeichnis zu unterbinden. Allerdings sollte dieser Parameter nur dann eingesetzt werden, wenn die Anwendung bereits aus einem lokalen Speicherort heraus gestartet wird. Wird die lokal gespeicherte Anwendung erfolgreich ausgeführt, werden die Informationen aus der Konfigurationsdatei eingelesen. Das folgende Diagramm zeigt, wie sich die Anwendung nach dem Start verhält: Starte Anwendung Anwendung lokal kopieren und lokal starten? Ja Kopiere Anwendung im lokalen Benutzer-Verzeichnis und starte diese von dort aus neu Nein, die Anwendung befindet sich bereits im lokalen Benutzer-Verzeichnis oder wurde mit dem NoLocalCopy-Parameter gestartet Konfigurationsdatei vorhanden? Nein Starte drei Versuche im Abstand von 15 Sekunden Ja Lade Konfigurationsdaten Ja Konfiguraitonsdatei vorhanden? Nein Beende Anwendung Warte auf Benutzereingaben 32/38

33 3.4 Verhalten während des Betriebs Während des Betriebs prüft die IBI-helpMe Client-Anwendung in regelmäßigen Zeitabständen, ob Änderungen an der Konfigurationsdatei vorgenommen wurden. Wurde die Konfigurationsdatei seit dem letzten Zugriff verändert, werden die Informationen ausgelesen und entsprechend umgesetzt. Die Prüfung der Konfigurationsdatei wird auch vor dem Erstellen eines Supportfalls durchgeführt, sodass die aktuellen Einstellungen möglichst schnell angewendet werden. Das nachfolgende Diagramm verdeutlicht den soeben erläuterten Vorgang: Klick auf Supportfall erstellen Synchronisationsintervall abgelaufen Prüfe Konfigurationsdatei auf Änderungen Konfigurationsdatei vorhanden? Nein Ja Wurde die Datei seit dem letzten Zugriff modifiziert? Nein Warte auf Benutzereingaben Ja Lade Konfigurationsdaten 33/38

34 4 Bedienung 4.1 Übersicht Dieses Kapitel befasst sich mit der Bedienung der IBI-helpMe Client-Anwendung. 4.2 Allgemein Sobald die IBI-helpMe Client-Anwendung gestartet wird, erscheint ein Symbol in der Startleiste (neben der Uhr). Hinweis: Je nach Betriebssystem kann via Group-Policy oder manueller Konfiguration das Symbol dauerhaft angezeigt werden. 34/38

35 4.3 Supportfall erstellen Möchte der Anwender einen Supportfall erstellen, kann er sich verschiedener Möglichkeiten bedienen: Durch ein Doppelklick auf das IBI-helpMe-Symbol in der Startleiste. Durch die Auswahl des Eintrages Supportfall erstellen, innerhalb des Menüs, welches sich durch einen Rechtsklick auf das Symbol in der Startleiste öffnet. Durch Ausführen eines Tastaturkürzels (Standardmäßig WIN + SHIFT + H). Wurde eine der oben beschriebenen Möglichkeiten ausgeführt, öffnet sich das Fenster zur Erstellung eines Supportfalls. Wie in der nachfolgenden Abbildung zu sehen ist, werden dem Anwender bereits alle zusätzlich zu seinen Angaben übermittelten Informationen (wie Computername, IP-Adressen, usw.) angezeigt. Darüber hinaus wurde automatisch ein Screenshot erstellt, welches bei Bedarf gelöscht bzw. aktualisiert werden kann. Besteht eine Anbindung an das Active Directory (AD) und wurde beim Anlegen eines Benutzers das AD-Feld Mail mit einer gültigen -Adresse versehen, liest die IBI-helpMe Client-Anwendung den Wert automatisch aus, sodass der Anwender diesen Schritt überspringen kann. Je nach eingestellter Sendeart, variiert das Verhalten beim Erstellen eines Supportfalls. Das Verhalten der jeweiligen Sendeart wird nachfolgend erklärt MAPI Die Erstellung eines Supportfalls wird bei dieser Sendeart in zwei Schritten durchgeführt. Im ersten Schritt werden die entsprechenden Angaben, die das Problem beschreiben, geschildert. 35/38

36 Anschließend wird mittels der MAPI-Schnittstelle der installierten - Anwendung eine -Vorlage, die alle gemachten Angaben beinhaltet, erstellt und angezeigt. Um den Vorgang abzuschließen, muss der Anwender die im zweiten Schritt absenden SMTP Wird diese Sendeart verwendet, besteht die Erstellung eines Supportfalls aus nur einem Schritt. Nach Angabe der Daten, wird der Supportfall durch einen Klick auf Senden direkt abgesendet. Es wird in diesem Fall keine installierte - Anwendung benötigt, die das Senden der übernimmt. 36/38

37 4.4 SMTP-Passwort verschlüsseln Um zu verhindern, dass ein Login-Passwort in der Konfigurationsdatei von Dritten ausgelesen werden kann, wird das Passwort verschlüsselt abgelegt. Die Möglichkeit ein Passwort zu verschlüsseln ist in der IBI-helpMe Client-Anwendung integriert. Hierzu muss die Anwendung mittels des Parameters /Admin gestartet werden. Im erscheinenden Fenster kann nun das gewählte Passwort verschlüsselt werden. Anschließend muss das generierte Passwort in das entsprechende Feld der Konfigurationsdatei eingefügt werden. 37/38