Schnittstellen

In diesem Abschnitt werden die Schnittstellen beschrieben, die im Scripting für helpLine verfügbar sind.

IHISession-Schnittstelle

Über die Schnittstelle „IHlSession“ können sessionspezifische Daten abgefragt werden. Darüber hinaus stellt die Schnittstelle Hilfsmethoden für die Internationalisierung zur Verfügung.

Diese Schnittstelle wird durch die Serviceware Processes Objekte („hlSession“, „hlObj“, „hlCaller“, „hlProduct“, „hlOrgUnit“ und „hlChainedObj“) implementiert und die Methoden dieser Schnittstelle werden alle als Methoden dieser Objekte aufgerufen.

IHlObject-Schnittstelle

Über die Schnittstelle „IHlObject“ können Sie helpLine Objekte bearbeiten und deren Eigenschaften abfragen.

Diese Schnittstelle wird durch das Objekt „hlObj“ implementiert und die Methoden dieser Schnittstelle werden alle als Methoden dieses Objekts aufgerufen.

IHlAttachment-Schnittstelle

Über die Schnittstelle „IHlAttachment" können Sie Anhänge von helpLine Objekte bearbeiten und deren Eigenschaften abfragen.

Diese Schnittstelle unterstützt die folgenden Methoden:

GetID

Diese Methode ermittelt die ID eines Anhangs.

Syntax GetID()
Rückgabewert numerischer Wert

GetName

Diese Methode ermittelt den Namen der Datei aus diesem Anhang. Der Pfad einer Verknüpfung wird über die Methode „GetURL“ ermittelt.

Syntax GetName()
Rückgabewert Name der angehängten Datei als Variant (String)

SetName

Diese Methode setzt den Namen des Anhangs.

Syntax SetName()

GetURL

Wenn der Anhang eine Verknüpfung ist, ermittelt diese Methode den vollständigen Pfad (URL) des Anhangs. Für Dateianhänge ist der zurückgegebene String leer.

Syntax GetURL()
Rückgabewert URL der Verknüpfung als Variant (String)

GetSize

Diese Methode ermittelt die Größe des Anhangs.

Syntax GetSize()
Rückgabewert

numerischer Wert

Die Größe des Anhangs wird in Bytes angegeben. Für Verknüpfungen beträgt dieser Wert „0“.

SetURL

Diese Methode setzt die Verknüpfung zu einem Anhang. Angegeben werden muss der vollständige Pfad des Anhangs. Sie legen somit keine Kopie der Datei an, sondern speichern nur eine Verknüpfung.
Anmerkung: Mit der Methode „SetURL“ ersetzen Sie eine zuvor gesetzte Verknüpfung bzw. einen zuvor über die Methode „SetFile“ gesetzten Dateianhang.
Syntax SetURL("URL")
Parameter URL: vollständiger Pfad des Anhangs als Variant (String)

SetFile

Diese Methode setzt die Datei eines Anhangs. Angegeben werden muss der vollständige Pfad des Anhangs. Eine Kopie der angegebenen Datei wird im helpLine System gespeichert.
Anmerkung: Mit der Methode „SetFile“ ersetzen Sie einen zuvor gesetzten Dateianhang bzw. ein zuvor über die Methode „SetURL“ gesetzte Verknüpfung.
Syntax SetFile("filename")
Parameter filename: vollständiger Pfad des Anhans als Variant (String)

GetLastModified

Diese Methode ermittelt, wann das Anhangsobjekt zum letzten Mal geändert wurde.

Syntax GetLastModified()
Rückgabewert Datum der letzten Änderung als Variant (Date)

SetData

Diese Methode setzt die Daten des Anhangs.

Syntax SetData(byte(), size)
Parameter

byte(): Byte-Array (die Daten des Anhangs)

size: Größe des Anhangs in Bytes

GetData

Diese Methode ermittelt die Daten des Anhangs.

Syntax GetData()
Parameter Byte-Array (die Daten des Anhangs)

IHlGroupPerms-Schnittestelle

Über die Schnittstelle „IHlGroupPerms“ können Sie auf die einzelnen Instanzberechtigungen auf ein Objekt bearbeiten. Jede Berechtigung wird über eine Eigenschaft angegeben, für die die Werte „true“ und „false“ gesetzt sein können. Folgende Eigenschaften stehen zur Verfügung:

  • AllowRead
  • AllowNew
  • AllowModify
  • AllowDelete
  • AllowAssociate
  • AllowTakeOwnerShip
  • AllowSearch
  • AllowViewCases
  • AllowViewHistory

Außerdem kann über die Eigenschaft „PermissionsDefined“ definiert und ermittelt werden, ob überhaupt Instanzberechtigungen festgelegt sind.