COM Interfaces

Diese Funktion wertet eine beliebige OCL-Expression aus. Das Ergebnis wird als Variant zurückgegeben und kann je nach OCL-Expression als String, Integer, Float, Boolean oder Object interpretiert werden. Beispiel:

dim list as IVtcObjectList 
Set list = vertec.Eval("projektbearbeiter->select(aktiv)")

liefert eine IVtcObjectList mit allen Vertec Bearbeitern, welche als aktiv markiert sind.

Damit können Werte in Variablen geladen werden, die dann global von überallher in OCL-Expressions verwendet werden können. Insbesondere können Ergebnisse von Expressions, welche nur durch die Expression entstehen und nicht in Vertec vorhanden sind, in eine Variable geschrieben werden (beispielsweise das Ergebnis einer Summierung, ein Datumswert mittels encodedate etc.)

Zum Beispiel sollen in einem Excel-Report die Leistungen ab einem bestimmten Zeitpunkt angezeigt werden. Statt nun die Leistungen in der Art "offeneLeistungen->select(datum >=" & encodeDate(2008, 08, 01) & ") " zusammenzusuchen, kann zuerst eine Variable gesetzt und dann verwendet werden:

Vertec.EvalToVariable Vertec.argobject, "encodeDate(2008,08,01)", "varVon"

und dann in OCL verwendet:

offeneLeistungen->select(datum >= varVon)

Die Expression wird auf dem angegebenen Root-Objekt ausgewertet. Es kann also auch eine Expression der Art:

Vertec.EvalToVariable Vertec.argobject, "projekt.rechnungen->reject(proforma)", "xArgObject"

angegeben werden.

Diese Funktion erlaubt es, einen Office-Report aufzurufen. Dabei muss der Pfad angegeben werden (templatepath) sowie das Vertec Objekt, aufgrund dessen der Report aufgerufen werden soll (rootObj). Die anderen Parameter sind optional; zu beachten ist, dass optarg mit nothing angegeben werden muss und nicht einfach leer gelassen werden kann.

Argumente:

• templatepath: Pfad zur Vorlage.
• rootObj: Das Vertec Objekt, für das der Report ausgeführt werden soll.
• optarg: Entspricht der optionalen Adresse auf dem Druckdialog. Optionales Argument. Wenn nicht verwendet, Parameter mit nothing angeben.
• filename: Speicherpfad des neu erzeugten Dokuments. Optional. Ist ein Filename angegeben, wird das Dokument gespeichert, sonst nicht. Die Verknüpfung (linkToRoot und linkToOptarg) kann nur erfolgen, wenn ein Filename angegeben ist.
• subject: Entspricht dem Betreff auf dem Druckdialog. Optional.
• text: Entspricht dem Kommentar auf dem Druckdialog. Optional.
• linkToRoot: Verknüpft das Dokument mit dem Hauptobjekt (Häkchen Auf Hauptobjekt auf dem Druckdialog). Optional. Standard: Nein. Die Verknüpfung kann nur erfolgen, wenn ein Filename (filename) angegeben ist.
• linkToOptarg: Verknüpft das Dokument mit der (optionalen) Adresse (Häkchen Auf Adresse auf dem Druckdialog). Optional. Standard: Nein. Die Verknüpfung kann nur erfolgen, wenn ein Filename (filename) angegeben ist.
• showWord: Öffnet das erstellte Dokument im Word und zeigt es auf dem Bildschirm an. Optional. Standard: Ja.

Der Aufruf in einem Skript ist beispielsweise wie folgt:

dim dok 
dim root

set root = Vertec.argobject 
set dok= Vertec.ExecuteFileReport("C:\Programme\Vertec\Reports\Deutsch\Rechnung.dot", root, nothing)

Der gesamte Aufruf mit allen Parametern wäre wie folgt:

set dok = Vertec.ExecuteFileReport("C:\Programme\Vertec\Reports\Deutsch\Rechnung.dot", root, nothing, "", "", "", False, False, True)

Das Dokument wird dann in der Voransicht angezeigt. Soll es direkt ausgedruckt werden, kann an obiges Script folgende Zeile angehängt werden:

dok.PrintOut

function vom Typ IDispatch. Liefert das Interface einer Extension.

set obj = Vertec.getobjectbyid(2880)

set obj = Vertec.getobjectbyid("2880")

Liefert das Ergebnis einer SQL-Abfrage auf einer bestimmten Vertec Klasse. Das heisst es werden per SQL alle Objekte einer bestimmten Klasse nach den angegebenen Kriterien (SQL Select, Where Clause) ausgewählt und in einer Liste zurückgegeben.

Der ausführende Benutzer muss über Administratorenrechte oder über das SQL Query Recht verfügen. In VBScripts steht für die Erteilung von temporären Administratorenrechte die Variante der erweiterten Berechtigungen zur Verfügung.

Vorsicht: Eval mit einer OCL-Expression lädt alle zu ihrer Berechnung notwendigen Objekte aus der Datenbank. In gewissen Fällen kann dies zu Performance-Problemen oder grossem Memory-Bedarf führen. Für Abfragen aus grossen Mengen gleicher Objekte ist GetWithSQL vorzuziehen.Im Gegensatz zu Eval werden nur die der SQL-Bedingung entsprechenden Objekte aus der Datenbank geladen. Beispiel:

dim list as IVtcObjectList 
Set list = vertec.GetWithSQL("adresseintrag", "name like 'isel%'","name")

Zeigt einen Dialog mit Titel, Prompt-Text und Eingabefeld mit Defaultwert an.

Gibt den eingegebenen Wert zurück. Falls Abbrechen gedrückt, wird ein Leerstring zurückgegeben.

Eine detaillierte Beschreibung finden Sie im Artikel msgbox/inputbox: Beschreibung der Parameter.

Nur in Vertec Versionen vor 6.5.0.15.

Meldet einen Benutzer an. Gibt true zurück, falls das Login erfolgreich war, und false, falls irgendetwas schief gegangen ist (Passwort falsch etc.)

Ab Version 5.8. Zeigt eine msgbox an und ist aufgebaut wie die Standard msgbox Funktion von Visual Basic (VB).

• prompt: String, der die Meldung enthält.
• Buttons: optional. Ein Integer-Wert mit der gleichen Bedeutung wie in der VB Standard msgbox Funktion.
• Titel: optional. String für den Fenster-Titel der MessageBox.

Der Rückgabewert gibt an, welcher Button geklickt wurde. Dies ist ein Integer-Wert mit der gleichen Bedeutung wie in der VB Standard msgbox Funktion.

Die Argumente Helpfile und Context der Standard-MsgBox-Funktion werden nicht unterstützt.

Eine detaillierte Beschreibung finden Sie im Artikel msgbox/inputbox: Beschreibung der Parameter.

Vertec 5.5 bis 6.1.0.11. Ruft Vertec dazu auf, seine Windows Messages Queue abzuarbeiten. Der periodischer Aufruf von ProcessMessages kann ein Problem mit langlaufenden Excel-Reports lösen: Der Excel Report wird von Vertec via COM-Aufruf (Excel.Application.Run) gestartet. Dieser Aufruf kehrt erst zurück, wenn das Report Makro in Excel durchgelaufen ist. Wenn diese lange dauert (z.B. 20 min und mehr) dann bricht der Report manchmal mit einem COM Error ab. Das Problem wird gelöst, wenn im Excel Report Makro periodisch an geeigneter Stelle Vertec.ProcessMessages aufgerufen wird. Der Aufruf sollte alle paar Minuten erfolgen.

Ab Version 6.1.0.12 wurde der Aufruf von Excel Reports überarbeitet und der Aufruf von ProcessMessages ist nicht mehr notwendig (aber nicht schädlich).

Ermöglicht den Aufruf eines Vertec Scripts.

• • scripttext: Als Scripttext wird der eigentliche Code übergeben. Dies kann zum Beispiel der Text eines in Vertec registrierten Scripts oder aber auch ein Codetext selbst sein.
  • argobject: Mit diesem Parameter können Sie das Objekt angeben, auf dem das Script ausgeführt werden soll. Wird dieser Parameter weggelassen, wird das Script auf dem aktuellen Vertec-Objekt aufgerufen.

Dim Vertec As IVtcSession
Dim Script As IVtcObject
Dim Scripttext As String

Set Vertec = CreateObject("Vertec.App")
Set Script = Vertec.Eval("scripteintrag->select(bezeichnung = 'Projekt kopieren')->first")
Scripttext = Script.Member("scripttext")
Vertec.ScriptExecute (Scripttext)

Setzt eine Objektvariable in OCL. Auf diese kann anschliessend global in OCL-Expressions via Variablenname zugegriffen werden. Beispiel:

Vertec.SetObjVariable "myProjekt", proj

anschliessend OCL auf Liste von offenen Leistungen:

self->select(projekt=myProjekt)->size

Der Unterschied zu EvalToVariable (siehe oben) besteht darin, dass hier einfach ein Objekt übergeben wird, ohne Auswertung einer Expression.

• intervalTyp: 0 = Tag, 1 = Woche, 2 = Monat
• value: Wert in Minuten.
• datum: Es wird die Periode mit dem Value gefüllt, in der das Datum ist. Am besten nimmt man das Datum am Anfang der Periode, dann gibt es keine Unklarheiten.

Methode zum Aufrufen des Detailfensters des als Argument übergebenen Vertec-Objekts.

Wird diese Methode in einem Script verwendet, gilt es zu beachten, dass sich mit dem Aufruf des Detailfensters das argobject, also das aktuelle Objekt in Vertec, ändert.

Beispiel:

set obj = vertec.eval("projekt->first") vertec.showform obj

function vom Typ string. Übersetzt den String anhand der aktuell eingestellten Sprache mit Hilfe der MLD Übersetzungstabelle.

Vertec.UpdateDatabase schreibt alle nicht gespeicherten Daten in die Datenbank. Speichert Änderungen in die Datenbank und validiert neuerstelle Objekte. Diese sind, sofern sie keine Regeln verletzen, danach nicht mehr ungültig.

property vom Typ IDispatch. Liefert den aktuell eingeloggten Benutzer als COM Objekt (Interface).

Ab Vertec 6.3. Fügt dem Objekt einen Tag hinzu.

argobject.addTag ("mytag")

property vom typ string. Liefert die String Representation des Objekts. Die String Representation ist eine kurze Charakterisierung des Objekts als String, z.B. bei einer Person Vorname und Name.

property vom typ string. Liefert den Klassennamen des Objekts, z.B. "Projekt", "Person" etc.

IDispatch. Liefert bei Objekten mit speziellen Interfaces dieses, sonst IVtcObject.

function (ohne Rückgabewert). Löscht das Objekt in Vertec. Liefert einen Fehler, wenn der eingeloggte Benutzer keine Berechtigung zum Löschen hat.

function vom Typ Variant. Wertet eine OCL-Expression auf dem Objekt aus. Im Unterschied zu IVtcSession.Eval wird versucht, die Expression aufgrund des Objekts zu berechnen. Beispiel:

dim obj as IVtcObject PLZ = obj.Eval("defaultadresse.adresse.plz")

function vom Typ string. Dasselbe wie Eval, ausser dass immer die String Representation des Ergebnisses geliefert wird.

Die sogenannten Multilanguage-Attribute (mehrsprachige Attribute) können über diese Methode abgefragt werden (ab Version 5.4).

• Membername: Name des Members
• Language ist der jeweilige Languagecode (DE, FR, IT, EN).

Multilanguage-Attribute sind:

• Taetigkeit.Text
• Spesentyp.Text
• Auslagetyp.Text
• Zusatzfeldklasse.Bezeichnung (Bezeichnung von Zusatzfeldern)
• GridColDef.Titel (Spaltentitel in Listeneinstellungen)

Beispiel

taetigkeit.GetMLValue("text", "DE") = "Fahrtspesen"

Wird das Member wie bisher abgefragt, entspricht der Rückgabewert der aktuellen Sprache:

taetigkeit.Member("text") = "Fahrtspesen"

Ab Vertec 6.3. Fragt ab, ob ein bestimmter Tag auf dem Objekt existiert.

If argobject.hasTag("mytag") Then
  ..

function vom Typ boolean. Gibt an, ob das Objekt vom angegebenen Typ ist. Beispiel:

dim obj as IVtcObject
if obj.IsOfType("Adresseintrag") then 
  msgbox "Ist ein Adresseintrag"
end if
if obj.IsOfType("Person") then 
  msgbox "Ist sogar eine Person"
end if

Macht eine Vertec Verknüpfung (via Linktyp) zum übergebenen Objekt mit der angegebenen Rolle. Detaillierte Informationen dazu finden Sie im Artikel Operatoren und Methoden für Links.

array property vom Typ Variant. Liefert oder setzt ein bestimmtes Member eines Vertec Objekts. Ein Member kann ein Attribute (zahl, string, boolean) oder ein Link (Objekt oder Objektliste) sein. Beispiel:

dim obj As IVtcObject .... name = obj.Member("name")

Ab Vertec 6.3. Entfernt einen Tag vom Objekt.

argobject.removeTag ("mytag")

Ab Vertec 6.3. Setzt einen Key-Value auf dem Objekt.

Set Vertec = CreateObject("Vertec.App")
Set argobject = Vertec.argobject
argobject.SetKeyValue "Datum", Date
argobject.SetKeyValue "Boolean", True

Die Methode setzt ein bestimmtes Member "out of date", so dass bei dem nächsten Zugriff erneut auf die Datenbank zugegriffen wird und so der aktuelle Wert drin stehen sollte.

Anwendungsfall: bei selbstgebauten Nummergeneratoren vor dem Zugriff auf ein Member "SetMemberOutOfDate" aufrufen, dann z.B. eins hochzählen, dann sofort "UpdataDatabase" aufrufen, so ist die Wahrscheinlichkeit klein, dass 2x die gleiche Nummer vergeben wird.

Ab Version 5.6 Neu kann die Methode auch auf derived Attributen benutzt und damit eine erneute Berechnung ausgelöst werden, ohne dass sich etwas geändert hat (wie das sonst bei derived Attributen der Fall ist).

Will man zum Beispiel das Member Rechnung.PhasenAufRechnung von dem erneuten Zugriff neu berechnen lassen, erfolgt der Aufruf wie folgt:

Rechnung1.SetMemberOutOfDate "phasenaufrechnung"

Die sogenannten Multilanguage-Attribute (mehrsprachige Attribute) können über diese Methode abgefragt werden (ab Version 5.4).

• Membername: Name des Members
• Value: Wert, den das Member erhalten soll
• Language ist der jeweilige Languagecode (DE, FR, IT, EN).

Multilanguage-Attribute sind:

• Taetigkeit.Text
• Spesentyp.Text
• Auslagetyp.Text
• Zusatzfeldklasse.Bezeichnung (Bezeichnung von Zusatzfeldern)
• GridColDef.Titel (Spaltentitel in Listeneinstellungen)

Beispiel

taetigkeit.SetMLValue("text", "Vacanze", "IT")

Entfernt eine Verknüpfung zum übergebenen Objekt mit der angegebenen Rolle. Detaillierte Informationen dazu finden Sie im Artikel Operatoren und Methoden für Links.

Entfernt das Objekt aus dem Vertec Objektspeicher. Muss mit Vorsicht verwendet werden, da anschliessende Zugriffe auf das entladene Objekt zu Fehlern führen können.

array property vom Typ String. Liefert oder setzt den Wert des Zusatzfeldes mit dem entsprechenden Namen als String. NULL Werte entsprechen dabei dem Leerstring "". Bei Auswahlzusatzfeldern wird der String Wert verwendet. Beispiel:

dim obj as IVtcObject .... wert = obj.zusatzfeld("name")

array property vom Typ Variant. Liefert oder setzt den Wert des Zusatzfeldes als Variant. Bei Abfragen wird dabei der Typ des Zusatzfeldes als Variant geliefert. Bei Auswahlzusatzfeldern wird der Integer Wert verwendet. Falls ein Zusatzfeld den Wert NULL hat, so wird der Defaultwert für den Feldtyp geliefert (Zahlen 0 bzw. 0.00, String "").

dim kommList as IVtcObjectList
dim obj as IVtcObject

...weise Adresseintrag zu
Set kommList = obj.Member("kommmittel")

for i = 0 to kommList.count-1 do
  msgbox kommList.Objects(i).AsString
next i