IBI-helpMe Client Handbuch

Transkript

1 Dokumentinformationen Titel: IBI-helpMe Client Aktuelle Gültig ab: Status: Version: Gültig bis: Verantwortlich für den Inhalt: GR History Version: Datum: Ersteller: Änderungen: Geprüft: GR Erstellung MS GR Anpassungen bzgl. Version 1.1 MS GR Anpassungen bzgl. Version 1.2 MS GR Anpassungen bzgl. Version MS GR Anpassungen bzgl. Version 1.3 MS GR Anpassungen bzgl. Version MS GR Anpassungen bzgl. Version 1.4 MS GR Konfiguration erweitert, FixTray- Parameter MS GR Lokalisierung MS Betroffene Bereiche IBI-helpMe Client Inhalt / Zielstellung Dieses gibt einen Einblick in die Funktionsweise der IBI-helpMe Client Anwendung. Unter anderem wird erklärt wie die Anwendung in Betrieb genommen wird, wie sich diese in bestimmten Situationen verhält und wie Aktualisierungen der Anwendung vorgenommen werden können. 1/29

2 Inhaltsverzeichnis 1 Einführung Aufgaben der Anwendung Inbetriebnahme Übersicht Systemvoraussetzungen Nutzung eines Service Portals Konfigurationsdatei Lokalisierung 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 /29

3 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. 3/29

4 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). 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 4/29

5 belegt werden, kann dies durch einen POST-Aufruf der URL ibihelpme:showsupportdialogwithpost() erreicht werden. Derzeit kann das Betrefffeld, sowie das Beschreibungsfeld vorbelegt werden. (Weitere Informationen siehe Konfigurationsdatei Punkt Service Portal: POST-Mappings) Zusätzlich können die von IBI-helpMe ermittelten Informationen über den Benutzer oder den Computer in eine Service Portal Seite eingebettet werden. Welche Informationen ermittelt werden können, wird im Kapitel Konfigurationsdatei im Abschnitt Zu ermittelnden Informationen [collectedvalues] 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%} 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. 5/29

6 Derzeit stehen folgende 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 E- Mail-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. <! 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 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. 6/29

7 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. -Empfänger [Support- -Adresse] 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 7/29

8 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. 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> 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. 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] 8/29

9 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. Intervall (in Sekunden) in dem diese Datei auf Änderungen überprüft wird [Wert >= 30] <syncinterval>30</syncinterval> Fenstereinstellungen Hiertmit ist es möglich die Fenstereigenschaften der Dialoge Supportfall erstellen (id="supportcase") bzw. Service Portal (id="serviceportal") unabhängig voneinander anzupassen. Neben der Fenstergröße kann auch eingestellt werden, ob das Fenster maximiert (ismaximized="true") angezeigt werden soll, ob das Fenster maximiert werden darf (canmaximize="false") oder ob die Fenstergröße änderbar (canresize="false")) ist. Die Fenstergröße kann in zwei verschiedenen Arten angegeben werden. Zum einen kann die Größe des gesamten Fensters (sizingmode="window") oder alternativ die Größe der zur Verfügung stehenden internen Fläche (abzüglich des IBIhelpMe Schaltflächen-Bereichs am untereren Fensterrand) festgelegt werden (sizingmode="content"). 9/29

10 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" /> </windowsettings> Eingabefelder Hiermit ist es möglich bestimmte Eingabefelder, die im Standardverhalten als Pflichtfelder definiert sind, auf optionale Felder umzustellen. Derzeit können die Felder Betreff (id="subject") und Beschreibung des Problems (id="description") umgestellt werden. Ermöglicht das Ändern des Verhaltens bestimmter Eingabefelder. <controlsettings> <control id="subject" isoptional="true" /> </controlsettings> Einträge im Kontextmenü des Taskleistensymbols 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. 10/29

11 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> Kategorien [categories] Hiermit ist es möglich, bei der Erstellung eines Supportfalls ein Feld anzuzeigen, welches der Anwender nutzen kann, um sein Problem zu kategorisieren oder ggf. zu priorisieren. Pro Kategorie kann entschieden werden, ob der entsprechende Supportfall an einen oder mehrere alternative Empfänger versendet werden soll. Darüber hinaus besteht die Möglichkeit den Wert der selektierten Kategorie automatisch in die Betreffzeile einzufügen. 11/29

12 Definiert individuelle Kategorien, welche anschließend den Anwendern zur Auswahl stehen <categories> - displayname [Beliebiger Text, Länge > 0]: Text welcher den Anwendern angezeigt wird. - isoptional [True, False]: Gibt an, ob die Auswahl einer Kategorie zwingend (False) oder freiwillig (True) sein soll. <category> - displayname [Beliebiger Text, Länge > 0]: Text welcher den Anwendern angezeigt wird. - value [Beliebiger Text]: Wert, welcher bei Bedarf in die Betreffzeile hinzugefügt wird. Dieses Attribut muss vorhanden sein und einen nicht-leeren Text beinhalten, wenn addvaluetosubject!= No ist. - addvaluetosubject [No, Before, After]: Gibt an, ob und an welcher Stelle der ausgewählte Wert in die Betreffzeile hinzugefügt werden soll. < recipient> - sendtype [To, Cc, Bcc]: Gibt an, wie der Empfänger die erhalten soll. Hinweis: Sollen keine Kategorien verwenden werden, muss der komplette categories-block auskommentiert oder entfernt werden. <categories displayname="verwendete Anwendung" isoptional="false"> <category displayname="anwendung A" value="a" addvaluetosubject="no"> < recipients> < recipient sendtype="to">u1@company.com</ recipient> < recipient sendtype="cc">u2@company.com</ recipient> </ recipients> </category> <category displayname="anwendung B" value="b" addvaluetosubject="after" /> </categories> Zu ermittelnden Informationen [collectedvalues] 12/29

13 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. Ab Version 1.2 kann festgelegt werden, welche Informationen ermittelt werden sollen. Darüber hinaus besteht die Möglichkeit, Active Directory-Informationen des Benutzers oder des Computers einzubinden. Auf folgende Informationen kann derzeit zugegriffen werden: Typ Local: [type="local"] - Name und Version des eingesetzten Betriebssystems. [value="os"] - Betriebssystemtyp [value="ossystemtype"] - Computername [value="computername"] - Clientname, falls eine Verbindung über Remote Desktop besteht. [value="clientname"] - Benutzername [value="username"] - Sitzungs ID [value="sessionid"] - Zugewiesene IP-Adressen [value="ip"] Typ Input: [type="input"] - Ausgewählte IBI-helpMe Kategorie, falls verwendet. [value="category"] Typ Active Directory: [type="activedirectory"] - Attribute des Benutzers [source="user"], wie z.b. die Telefonnummer [value="telephonenumber"] - Attribute des Computers [source="computer"], wie z.b. die Ländereinstellung [value="countrycode"] Hinweis: Welche Active Directory Attribute vorhanden sind, kann mittels der Microsoft-Anwendung Active Directory-Benutzer und -Computer in 13/29

14 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. 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="local" displayname="computername" value="computername" /> <collectedvalue type="local" displayname="clientname" value="clientname" /> <collectedvalue type="local" displayname="benutzername" value="username" /> <collectedvalue type="activedirectory" displayname="telefon" value="telephonenumber" source="user" /> <collectedvalue type="local" displayname="sitzungsid" value="sessionid" /> <collectedvalue type="local" displayname="zugewiesene IP-Adressen" value="ip" /> <collectedvalue type="input" value="category"/> </collectedvalues> 14/29

15 Service Portal: Platzhalter 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%} 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> <a href="{%config.url%}">link</a> </body>... </html> Service Portal: POST-Mappings Innerhalb einer Service Portal Seite ist es möglich, einen Supportfall 15/29

16 ü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 Beschreibung (id="description") abgefüllt werden. Mittels Platzhaltersyntax {%Html-Name%} kann auf die im POST-Aufruf ermittelten Daten zugegriffen werden. 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> Index.html 16/29

17 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/> Beschreibung (kurz):<br/> <input type= text name= txtdescriptionshort /> <br/><br/> Beschreibung:<br/> <textarea type= text name= txtdescription /> 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 dem Verzeichnis abgelegt werden. 17/29

18 2.6 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.7 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 Konfigurations-Datei 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 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> [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 18/29

19 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. /Language <Sprachkennung im ISO-Format> [Optional, erst ab Version verfügbar] Hiermit ist es möglich, die Sprache der Anwendung unabhängig von den Benutzereinstellungen festzulegen. - IBI.helpMe.Client.exe /Language en Die Sprache der Anwendung ist Englisch. /Admin [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. - IBI.helpMe.Client.exe /Admin Startet den Administrationsmodus. /CustomContent<URL oder Pfad zu einer HTML-Datei> [Optional, erst ab Version verfügbar] Geben Sie diesen Parameter an, wenn Sie einen alternativen Pfad zu einer Service Portal Seite angeben möchten. 19/29

20 - 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. /ErrorLogPath <Pfad zu einem Verzeichnis> [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. - IBI.helpMe.Client.exe /ErrorLogPath "\\fileserver\errorlogs" Fehlerdatei wird an einem benutzerdefinierten Ort abgelegt. /FixTray [Optional, ab Version verfügbar] Ab Windows 7 werden TrayIcons nur noch temporär angezeigt. Dem Benutzer wird die Möglichkeit eingeräumt das TrayIcon permanent im sichtbaren Bereich des Trays zu setzen. Möchte man sichestellen, dass das IBI-helpMe-TrayIcon immer sichtbar bleibt, kann z.b. während des Windows-Logoff-Vorgangs (die Explorer.exe darf zu dieser Zeit nicht ausgeführt werden, sonst werden die Einstellungen nicht übernommen) die Anwendung mittels dieses Parameters gestartet werden, um die Einstellungen des Benutzers zu überschreiben. /NoLocalCopy [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. - C:\Program Files\IBI-helpMe\IBI.helpMe.Client.exe "\\fileserver\ibishare$\config.xml" /NoLocalCopy 20/29

21 Verhindert, dass die Anwendung eine Kopie von sich selbst im lokalen Anwendungsdatenordner des Benutzers erstellt und ausführt. 21/29

22 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. 22/29

23 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 Konfigurations-Datei 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 23/29

24 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 24/29

25 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. 25/29

26 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. 26/29

27 4.3.1 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. 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. 27/29

28 4.3.2 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. 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. 28/29

29 5 Aktualisierungen 5.1 Übersicht Dieses Kapitel befasst sich mit der Aktualisierung der IBI-helpMe Client- Anwendung. 5.2 Anwendung aktualisieren Steht eine neue Version der IBI-helpMe Client-Anwendung zu Verfügung, kann diese - vorausgesetzt sie wurde von einem zentralen Ort aus gestartet - im laufenden Betrieb aktualisiert werden. Wie eine Aktualisierung im Detail durchgeführt wird, hängt von der verwendeten Version ab. Weitere Informationen werden bei jeden Release veröffentlicht. Im Normalfall genügt es die neue.exe bereitszustellen und den in Kapitel 2.3 beschriebenden Parameter [lastrestart] zu verändern. 29/29