Vertec Python Interfaces

Produktlinien: Expert
Module: Leistung & CRM
Erstellt: 04.03.2013, Änderung: 08.08.2017
Schreibfehler korrigiert.
Mehr ansehen

Das Modul "vtcapp"

Mit der Vertec Installation wird eine Vertec Python Library mitgeliefert. Diese ist nach der Installation in den Python Scripts automatisch verfügbar und heisst vtcapp. Zu dieser Tabelle gibt es die Hilfe-Funktion help(vtcapp), welche alle Informationen dazu auflistet.

Das Modul hat folgende Methoden / Funktionen:

Methode / FunktionBeschreibungBeispielcode

__doc__

Dokumentation einer Funktion.
>>> print vtcapp.__doc__ 
Interface module to host application.
argobjectAktuelles Vertec Objekt. Diese Variable ist immer verfügbar, der Aufruf kann also ohne vtcapp. erfolgen.
projekt = argobject
appdatapath()

Gibt den Pfad zum Vertec Application Data Ordner zurück und erstellt den Ordner, falls noch nicht vorhanden.

Normalerweise befindet sich der Appdata Folder unter dem Pfad \Anwendungsdaten\Vertec. Als Ordnername unter Anwendungsdaten wird derselbe Ordnername genommen, in dem Vertec gestartet wurde. Falls sich Vertec.exe z.B. in einem Ordner VertecTest befindet, dann heisst der dazugehörige Appdate Folder ebenfalls VertecTest.

Falls VertecServer als Dienst gestartet wird, dann wird der AppData Ordner unter Alle Benutzer angelegt, da Dienste normalerweise kein Benutzerprofil zugeordnet haben.

Siehe dazu auch den Artikel Logging.

>>> print vtcapp.appdatapath()
C:\Users\christoph.keller\AppData\Roaming\Vertec
beginsystemcontext()Aktiviert innerhalb des Scripts die erweiterten Berechtigungen. Muss am Ende endsystemcontext() aufrufen, um die erweiterten Berechtigungen wieder freizugeben. Ist im Python-Editor aus Sicherheitsgründen nicht erlaubt.
try: vtcapp.beginsystemcontext()

main()

finally: vtcapp.endsystemcontext()
checkcreate(klasse:string): int

Prüft, ob Berechtigung zum Erstellen von Objekten der angegebenen Klasse besteht.

Rückgabewert ist 0 oder 1 (False, True)

>>> print vtcapp.checkcreate('Projekt')1
checkfeature(featurecode: string): boolean

Prüft, ob ein bestimmtes Feature lizenziert ist.

Die Featurecodes sind gemäss Vertec Feature-Matrix (z.B. 'fcPhasen' für Phasen).

Rückgabewert ist False oder True

>>> vtcapp.checkfeature('fcPhasen')True
comparetext(str1, str2): int

Vergleicht 2 Strings mit derselben Logik wie in Vertec (ComboBoxen, Spaltensortierung). Ist ein normaler ANSI Textvergleich (case insensitive) mit der Ergänzung, dass Bindestriche und Apostrophs als normale Zeichen im Vergleich berücksichtigt werden.

Falls die Strings übereinstimmen, ist der Rückgabewert 0, sonst -1 oder +1 je nachdem welcher String "grösser" ist.

>>>  vtcapp.comparetext('Dies ist mein Test', 'Dies ist mein Text')
-1

>>>  vtcapp.comparetext('Dies ist mein Test', 'Dies ist mein Test')
0

>>> vtcapp.comparetext('Dies ist mein Text', 'Dies ist mein Test')
1
createlist(classname, [list]): listAb Version 6.1.0.14.
  • classname: der Klassenname der Objekte, welche die Liste aufnehmen wird. Der Klassenname ist notwendig, damit die Liste selbst eine statische Typ-Information enthält und als Basis für die Auswertung von OCL Expressions dienen kann.
  • list (optional): das optionale List Argument ermöglicht die Konstruktion einer Bold-Liste direkt aufgrund einer anderen Liste (Bold- oder Python Liste). Wenn es nicht angegeben wird, ist die Liste leer und kann via append() Methode gefüllt werden.
mylist = vtcapp.createlist('Projekt')
mylist.append(argobject)

oder

liste = vtcapp.createlist("Projekt", vtcapp.evalocl("projekt->select(code.sqllike('A%'))"))
liste2 = liste.evalocl("self->select(aktiv)")
createobject(klasse: string)Erstellt neues Objekt der angegebenen Klasse.
leistung = vtcapp.createobject("OffeneLeistung")
currentdate(): dateAb Vertec 6.1.0.10. Gibt das aktuelle Datum zurück.
>>> vtcapp.currentdate()
2017-01-23
currentdatetime(): datetimeAb Vertec 6.1.0.10. Gibt das aktuelle Datum und die aktuelle Uhrzeit zurück.
>>>  vtcapp.currentdatetime()
2017-01-23 15:01:12.880000
currentlogin(): ProjektbearbeiterAktuell angemeldeter User
bearbeiter = vtcapp.currentlogin()

print bearbeiter.name

>>> Christoph Keller
disableevents()Eventsscripting ausschalten. Muss mit enableevents() wieder eingeschaltet werden. Benötigt erweiterte Berechtigungen.
Diese Funktion wird oft verwendet, wenn man ein gewisses Attribut anpassen möchte, welche eigentlich einen Event ausführen würde. Ist im Python-Editor aus Sicherheitsgründen nicht erlaubt. Achtung: Nach dem enableevents() darf es keine msgbox() mehr haben, sonst werden die nicht aufgerufenen Events nachträglich aufgerufen.
# Ganzes Script
try:
vtcapp.enableevents()
main()
finally:
vtcapp.disableevents()

# Teil eines Scripts
vtcapp.enableevents()
rechnung.datum = date.today()
vtcapp.disableevents()
enableevents()siehe disableevents()
endsystemcontext()siehe beginsystemcontext()
evalocl(expression: string): expressiontypeGlobale OCL Expression auswerten.
projektListe = vtcapp.evalocl("Projekt.allinstances->orderby(code)")
evaloclstring(obj: object, expStr: string): stringOCL Expression innerhalb eines Strings auswerten. Rückgabewert: vollständig ausgewerteter String.

print vtcapp.evaloclstring(argobject,"Bearbeiter: %name% ist %stufe.asstring%")

>>> Bearbeiter: Christoph Keller ist Senior Consultant
evaltovariable(obj: object, ocl: string, varname: string)Wertet eine OCL aus und speichert den Wert in eine OCL Variable. Die Variable kann man nur mit eval() auf das Objekt abfragen.

Ab Version 6.1.0.14 darf als Variablenname "self" nicht mehr verwendet werden, da dies ein Schlüsselwort ist. Es erscheint eine entsprechende Fehlermeldung.

vtcapp.evaltovariable(argobject,"kuerzel+' - '+name", "userinfo")

print argobject.eval("userinfo")

>>> CK - Christoph Keller
executefile(pfad: string)

Öffnet eine Datei auf dem Client (ohne Web App). Der Dateipfad muss vom Client aus erreichbar sein.

Kann auch verwendet werden, um ein Programm zu starten (z.B. "calc.exe").

pfad = r'S:\Dokumente\Kontakte\Bistro Cooper\Brief.docx'vtcapp.executefile(pfad)

Das r vor dem Pfad bewirkt, dass Steuerzeichen ignoriert werden. Da der Backslash in gewissen Kombinationen für Python ein Steuerzeichen darstellt, kann es passieren, dass sonst der Pfad nicht richtig interpretiert bzw. verstückelt wird und es einen Fehler gibt.

vtcapp.executefile("calc.exe")

öffnet den Windows Rechner.

executefolder(pfad: string)

Öffnet den angegebenen Ordner auf dem Client (ohne Web App), z.B. im Windows-Explorer. Der Pfad muss vom Client aus erreichbar sein.

Existiert der Ordner noch nicht, erscheint eine Meldung, ob er erzeugt werden soll:

In einem Script muss das darum abgefragt und der Ordner allenfalls im Code erzeugt werden, wenn keine Meldung auf der Oberfläche erscheinen soll. Dies kann z.B. über das Python Modul os geschehen.

import os

pfad = r'S:\Dokumente\Kontakte\Bistro Cooper'
if os.path.isdir(pfad):
  vtcapp.executefolder(pfad)

Das r vor dem Pfad bewirkt, dass Steuerzeichen ignoriert werden. Da der Backslash in gewissen Kombinationen für Python ein Steuerzeichen darstellt, kann es passieren, dass sonst der Pfad nicht richtig interpretiert bzw. verstückelt wird und es einen Fehler gibt.

executereport(rootObj, optarg, berichtObj, [saveAs, showDialog, doPrint, showApp])

Ab Version 5.8. Erlaubt den Aufruf und das Ausführen von Office- und von internen Reports.

  • rootObj: Das Objekt, auf dem der Report ausgeführt wird.
  • optarg: Entspricht der optionalen Adresse auf dem Druckdialog. Optionales Argument. Wenn nicht verwendet, Parameter mit None angeben.
  • berichtObj: Eine Vertec Bericht-Definition (Klasse Bericht) oder ein Pfad für das Office-Template. Falls ein Bericht Objekt angegeben, wird der Report aufgrund der Definition ausgeführt.
    Die Einstellungen des Bericht-Objekts für Speichern unter und Dialog anzeigen können via die entsprechenden Argumente dieser Methode noch übersteuert werden.
  • saveAs: Optional. Pfad zum Speichern des Berichts (falls Office-Bericht). Dieser String kann auch OCL Expressions (mit % getrennt) enthalten.
    Falls ein Leerstring angegeben wird, dann wird kein File gespeichert.
    Wenn None übergeben wird, werden die SaveAs-Einstellungen aus dem Report Objekt (berichtObj) übernommen.
  • showDialog: Anzeige von Dialog mit Speichern unter etc. (falls Office-Bericht). Optional. Mögliche Werte: True oder False. Ab Version 6.1.0.14 wird auch die Anzeige von Meldungen wie "existierendes File überschreiben" und "neuen Pfad erstellen" über diese Einstellung gesteuert. Wenn der Parameter nicht gesetzt wird, wird die entsprechende Einstellung aus dem Report Objekt (berichtObj) übernommen.
  • doPrint: Bericht direkt ausdrucken. Falls true, wird der Bericht direkt ausgedruckt. Bei Word-Berichten wird Word dann nicht angezeigt. Optional. Mögliche Werte: True oder False.
  • showApp: Gibt an, ob die Applikation offen angezeigt werden soll (wird nicht beachtet, wenn doPrint=True). Optional. Mögliche Werte: True oder False.

Einen Word-Report für Rechnung anzeigen, ohne Dialog und ohne ein File zu speichern:

vtcapp.executereport(rech, None, rechTempl, "", showDialog=False)
Die Variable rechTempl muss das Bericht Objekt für eine Rechnung enthalten, die Variabel rech das Rechnungsobjekt.

executeserverwordreport(rootObj, optarg, templatePath, [outputFormat, saveAs, showDialog, showApp])

Ab Version 6.1.0.11. Diese Methode dient dazu, Vertec-generierte Word-Reports ohne Bericht-Objekt auszuführen.

  • rootObj : Das Objekt, auf dem der Report ausgeführt wird.
  • optarg : Entspricht der optionalen Adresse auf dem Druckdialog. Optionales Argument. Wenn nicht verwendet, Parameter mit None angeben.
  • templatePath: Ein Pfad für das Word-Template.
  • outputFormat : Ein String für das Ausgabeformat. Akzeptiert: "DOCX" oder "PDF". Default: "DOCX"
  • saveAs : Pfad zum Speichern des Berichts als String. Dieser String kann auch OCL Expressions (mit % getrennt) enthalten. Falls ein Leerstring angegeben wird oder das Argument weggelassen wird, dann wird kein File gespeichert. Default: ""
  • showDialog : Anzeige von Dialog mit Speichern unter etc. als boolean. Default: False
  • showApp: : Boolean, der angibt, ob die Applikation offen angezeigt werden soll. Default: True
vtcapp.executeserverwordreport(argobject, None, r"C:\Program Files (x86)\Vertec\Reports\Deutsch\Brief.dot", "", "C:\\Dokumente\\Vertec\\Test", True, True)
executeurl(url)

Öffnet die angegebene URL auf dem Client (alle Apps).

Zum Beispiel eine Website im Browser öffnen:

vtcapp.executeurl("www.vertec.com")

Oder eine Vertec Breadcrumb URL:

vtcapp.executeurl("vertec://CK-676/eigene+Projekte-49/COMINSTALL-2880/")
generateinvoicenumber()

Erzeugt die nächste Vertec Rechnungsnummer gemäss Systemeinstellungen Rechnung / Honorarnote.

rech = argobject
rech.nummer = vtcapp.generateinvoicenumber()
getmemberwithsql(obj: object, membername: string, where: string, order: string): list of objectsSQL Statment auf einen Linktyp ausführen. SQL: Hole alle Offene Leistungen auf Projekt, die den Betrag>200 haben, ohne alle Offene Leistungen des Projektes zu laden. OCL: projekt.offeneleistung ->select(xwertext>200) würde mit offeneleistung gleich alle laden.
projekt = argobject 

li=vtcapp.getmemberwithsql(projekt, "offeneleistungen", "xwertext>200", "")
print len(li)

>>> 3
getobjectbyid(id: int or string): objectHolt das Objekt mit der entsprechenden ID
obj = vtcapp.getobjectbyid(62162)

oder

obj = vtcapp.getobjectbyid("62162")

Ist die ID nicht vorhanden, wird ein Fehler geworfen.

getpropertyvalue(propname: string): propertytypeHole Wert eines Propertys.
print vtcapp.getpropertyvalue("globaldokpfad") 

>>> C:\Programme\Vertec\Dokumente

getwithsql(klasse: string, where: string, order: string): list of objectsGlobales SQL Statment ausführen.
liste = vtcapp.getwithsql("Adresseintrag", "standardadresse like 'Badenerstr%'", "")
for adresse in liste:
print adresse
inputbox(caption: string, prompt: string, default: string): stringEinfaches Eingabefeld anzeigen.
  • caption: Titel des Forms
  • prompt: Einleitungstext
  • default: Default-Wert
print vtcapp.inputbox("Titel", "Geben Sie einen Text ein:", "")
>>>
test
log(category: string, level: int, msg: string)

Log Message in Vertec Logging System. Levels vorhanden:

  • 10: Debug Log
  • 20: Info Log
  • 30: Warning Log
  • 40: Error Log
  • 50: Fatal Log
projekt = argobject
leistung = projekt.eval("offeneleistungen->first")
if leistung:
try:
leistung.xwertext = 0
except:
vtcapp.log("Leistungen anpassen",\
30, "Keine Berechtigung")
msgbox(msg: string)Message Box anzeigen (Versionen vor 6.0)

Als Titel wird Information und als Dialogtyp (Kombination Button / Zeichen) immer Info verwendet.

vtcapp.msgbox("Das ist ein Test")

msgbox(text: string [, int buttons: int, title: string]): int

Message Box anzeigen (Versionen ab 6.0)

Die Funktion wurde der entsprechenden VisualBasic-Funktion (vertec.msgbox) angeglichen und unterstützt nun (optionale) Argumente für Buttons und Title.

Der Aufbau der Buttons und der Rückgabewerte funktioniert wie bei der VB-Variante gemäss Win32 MessageBox Funktion. Siehe Informationen dazu im Artikel msgbox/inputbox: Beschreibung der Parameter.

readinivalue(section: string, value: string, default: string): stringWerte lesen aus dem Vertec.ini File.
print vtcapp.readinivalue("database",\ "servername", "") 

>>> XY:C:\Programme\Vertec\DB\VertecDemo.fdb

scriptexecute(scripttext, argobject=None)

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.
projektListe = vtcapp.evalocl("Projekt.\
allinstances->orderby(code)")
scripttext = vtcapp.evalocl("scripteintrag->\
select(bezeichnung='Projekt kopieren')->\
first.scripttext")
vtcapp.scriptexecute(scripttext)
selectfromlist (caption: string, text: string, col1caption: string, col2caption: string, default: string, list: list of tuple): stringErstellt einen Auswahldialog gemäss den Angaben.
  • caption: Titel des Forms
  • text: Einleitungstext
  • col1caption: Spaltentitel 1
  • col2caption: Spaltentitel 2
  • default: Default Rückgabewert
  • list: Liste mit den Values
projektliste = []
projekte= vtcapp.evalocl("Projekt.\
allinstances->orderby(code)")

for projekt in projekte:
projektliste.append((projekt.code,\
projekt.betreffend))

print vtcapp.selectfromlist\
("Projekt auswählen",
"Wählen Sie das Projekt aus:", "Code",
"Betreffend", "", projektliste)

>>> COMINSTALL
setpropertyvalue(name, value)

Setzt eine Systemeinstellung. Der entsprechende Name ist jeweils bei den einzelnen Systemeinstellungen angegeben.

from datetime import date
vtcapp.setpropertyvalue('Sperrdatum', vtcapp.incmonth(date.today(), -1))

setresourceplanvalue
(bearbeiter, projekt, phase, date, intervalType, value)

Setzt einen Ressourcenplanwert. Verfügbar ab Vertec Version 5.7.0.16
  • intervalTyp: 0 = Tag, 1 = Woche, 2 = Monat
  • value: Wert in Minuten.
  • date: 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.
from datetime import date

bearbeiter = vtcapp.currentlogin()
projekt = argobject

vtcapp.setresourceplanvalue(bearbeiter, projekt, None, vtcapp.firstdayofmonth(date.today()), 0, 240)
showcustomdialog(dialogdefinition, initialwerte)Dialog-Funktion, mit welcher in Python Scripts Dialoge definiert und vom Script angezeigt werden können. Verfügbar ab Vertec Version 6.1.Eine detaillierte Beschreibung finden Sie im Artikel über die Python Dialoge.
showdetailform(obj: object)Form eines Objektes anzeigen
leistung = vtcapp.createobject("Offeneleistung")
vtcapp.showdetailform(leistung)
sqldateliteral(datum: date): stringDiese Methode ergibt das richtige Datumsformat für SQL-Abfragen, je nach verwendetem Datenbankserver, welches dann in ein getwithsql statement eingebaut werden kann.
datum = vtcapp.strtodate('30.05.17')
aktivitaeten = vtcapp.getwithsql('Aktivitaet', 'datum = %s' % vtcapp.sqldateliteral(datum), '')
for akt in aktivitaeten:
    print akt

>>>
Support, 30.05.2017, Support Frau Müller
Verkauf, 30.05.2017, Rechnung mit Leistungsliste (Word)
Verkauf, 30.05.2017, Rechnung mit Leistungsliste (Word)
Verkauf, 30.05.2017, Offerte (Word)
Verkauf, 30.05.2017, Offerte (Word)
Marketing, 30.05.2017, Informationen bezüglich KZU
>>>
sqlwhere(where: string): stringErzeugt eine SQL where clause, passend auf den aktuell verwendeten Datenbankserver, welche dann in ein getwithsql Statement eingebaut werden kann.
whereclause = vtcapp.sqlwhere("standardadresse like 'Dachsweg%'")
leistungen = vtcapp.sqlwherebetweendate('datum', vtcapp.firstdayofmonth(heute), heute)
print leistungen, whereclause

adressen = vtcapp.getwithsql("Adresseintrag", whereclause, "bold_id")
for adresse in adressen:
  print adresse

>>>
upper(standardadresse) starting with 'DACHSWEG'
Comtelsat AG
Comtelsat AG, Lanz André
Comtelsat AG, Huber Thomas
>>>
sqlwherebetweendate(abfrage:string, von: date, bis: date): string

Erzeugt eine SQL between clause mit einem Datumsintervall, passend auf den aktuell verwendeten Datenbankserver, welche dann in ein getwithsql Statement eingebaut werden kann.

from datetime import date

heute = date.today()
whereclause = vtcapp.sqlwherebetweendate('datum', vtcapp.firstdayofmonth(heute), heute)
print whereclause

leistungen = vtcapp.getwithsql("Leistung", whereclause, "datum")
for leistung in leistungen:
  print leistung

>>>
datum between '01.05.2017' and '30.05.2017'
COMINSTALL, 09.05.2017, BER Besprechung mit Hr. Müller
COMINSTALL, 16.05.2017, TM Telefon mit Hr. Müller
>>>
strtodate(strDate: string): dateWandelt einen String in ein Datum um.
print vtcapp.strtodate('1.10.09')

>>> 2009-10-01 00:00:00

strtominutes(wert: string): int

Übersetzt einen String in einen Minutenwert (Integer), unter Berücksichtigung der aktuell eingestellten Systemeinstellung Anzeige Minuten.

Anzeige Minuten ist Stunden:Minuten:

print vtcapp.strtominutes('1:30')
>>> 90

print vtcapp.strtominutes('1.50')
>>> 110

Anzeige Minuten ist Stunden.Dezimal:

print vtcapp.strtominutes('1.50')
>>> 90
translate(txt: string): stringÜbersetzt einen GUI Text in die aktuelle Vertec Sprache.

Die aktuelle Vertec-Sprache ist English:

vtcapp.translate("Leistung")
>>> Service
updatedatabase()Speichert Änderungen in die Datenbank.
vtcapp.updatedatabase()
validateobjects()Validiert neuerstelle Objekte. Diese sind, sofern sie keine Regeln verletzen, danach nicht mehr ungültig.
vtcapp.validateobjects()
versiontointeger(versionstring): intVerwandelt einen Vertec Versionsstring in eine Zahl, die sich zum Vergleich von verschiedenen Versionen eignet.

Bsp: "5.5.0.67" wird in 550067 umgesetzt, 
"5.5" in 550000,
"5" in 500000
xmlquery(query: string): QueryResponse

Erlaubt den Zugriff auf die XML Schnittstelle via Python Script.

Zeilenumbrüche und Einrückungen müssen in der xmlquery Methode nicht unbedingt berücksichtigt werden, man kann auch einen mehrzeiligen String anlegen.

vtcapp.xmlquery("""
 

   
      administrator
     
     

 

 
    30262
 
""")

Datumsfunktionen für Python

Ab Version 5.7 gibt es für Python folgende neue Datumsfunktionen. Sie alle befinden sich im Modul vtcapp.

FunktionErklärung
incmonth(datum, int): datuminkrementiert Monat (+ oder -) und liefert das neue Datum zurück
incyear(datum, int): datuminkrementiert das Jahr (+ oder -) und liefert das neue Datum zurück
incday(datum, int): datuminkrementiert den Tag (+ oder -) und liefert das neue Datum zurück
incminute(datum, int): datum

inkrementiert Minuten (+ oder -) und liefert neues Datum zurück.

Das Datum, das übergeben wird, muss im Format Datetime sein, also einen Zeitteil haben.

firstdayofmonth(datum): datumliefert das Datum des ersten Tages im selben Monat zurück
lastdayofmonth(datum): datumliefert das Datum des letzten Tages im selben Monat zurück
firstdayofyear(datum): datumliefert das Datum des ersten Tages im selben Jahr zurück
lastdayofyear(datum): datumliefert das Datum des letzten Tages im selben Jahr zurück
thismonday(datum): datumliefert das Datum des Montags in derselben Wochen zurück
formatminutes(integer): stringliefert Stunden-Minuten-Darstellung gemäss Einstellung in Vertec zurück
strtominutes(string): integerInterpretiert einen Stunden-Minuten string und liefert Anzahl Minuten gemäss Einstellung in Vertec
strtodate(string): datumInterpretiert einen Datumsstring gemäss Windows Ländereinstellungen (siehe Anmerkungen zur Verwendung von strtodate weiter unten).
datetostr(date): stringAb Version 6.1.0.14. Wandelt ein Datum in einen String um und gibt diesen gemäss Ländereinstellungen zurück.
ocldate(datum): stringLiefert OCL encodedate string aufgrund eines Datumswertes (siehe Beispiel)

Beispiel

import datetime
vtcapp.ocldate(datetime.date(2012,01,31))

liefert encodedate(2012,1,31) zurück.

Anmerkung zur Verwendung von strtodate

Die Verwendung von strtodate ist heikel, da der String je nach Windows Ländereinstellungen interpretiert wird. So liefert die Expression vtcapp.strtodate('31.01.2012') einen Fehler, wenn es sich nicht um deutsche Ländereinstellungen handelt.

Im Code sollte deshalb immer die Python Datumsfunktion datetime.date(year, month, day) verwendet werden (siehe obiges Beispiel). Soll jedoch beispielsweise vom User ein bestimmtes Datum über eine Inputbox abgefragt werden, kann man das so machen, dass man ihm einen Datumsvorschlag im richtigen Format präsentiert, welcher von ihm entsprechend abgeändert werden kann. Dafür wird das Datum gemäss lokalen Ländereinstellungen formatiert dargestellt mit strftime:

import datetime

# Frage den Benutzer nach dem Datum. Datum gemäss Windows-locale dargestellt.
res = vtcapp.inputbox('Vertec', 'Datum für die Berechnung', datetime.date.today().strftime('%x'))
print vtcapp.strtodate(res).date()

Das einzelne Vertec Datenobjekt

Für einzelne Objekte gibt es folgende Methoden:

Methode/FunktionBeschreibungBeispielcode

addtag(tagname)

Ab Version 6.1.0.10. Setzt auf dem Objekt einen Tag. Informationen dazu finden Sie im Artikel Tags auf User-Einträgen.

argobject.addtag('mytag')

checkright(recht: string, membername: string): boolean

Prüft, ob der angemeldete Benutzer das angegebene Recht auf dem angegebenen Membernamen besitzt.

Mögliche Rechte sind: 'read', 'write', 'create', 'delete', 'execute'

Rückgabewert: 1 = True, 0 = False

obj = argobject
if obj.checkright('read', 'offeneleistung'):
...

delete()

Löscht das Objekt in Vertec

obj.delete()

eval(OCL:string)

oder

Eval(OCL:string)

Evaluiert eine OCL-Expression auf dem Objekt

projektcode = argobject.eval("code")

evalocl(OCL:string)

Ab Vertec 6.1.0.10. Evaluiert eine OCL-Expression auf dem Objekt. Macht dasselbe wie eval, wurde eingeführt, damit es gleich heisst wie die globale Methode.

projektcode = argobject.evalocl("code")

getattr(object, name[, default])

Gibt den Wert eines Members zurück.

getattr(obj, "vorname")

ist äquivalent zu obj.vorname. Manchmal benötigt man getattr, weil man ein Member beispielsweise in einer Methode als Parameter bekommt und dann so abfragt.

Gibt es auf dem Objekt kein Member dieses Namens, gibt die Methode den default zurück, falls ein solcher angegeben ist. Ansonsten gibt es einen AttributeError.

getattr(obj, "vorname", "")
projekt = argobject
if hasattr(projekt, "offeneleistungen"):
liste = getattr(projekt, "offeneleistungen")
for leistung in liste:
print leistung.text

getkeystring(key): string

getkeybool(key): boolean

getkeycurr(key): currency

getkeyint(key): integer

getkeydate(key): datetime

Ab Vertec 6.1.0.10. Mit diesen Methoden wird auf die als Key-Values abgelegten Werte zugegriffen.

Details dazu finden Sie im Artikel Key-Values auf User-Einträgen.

>>> argobject.getkeydate('datum')
2017-02-03 00:00:00
getmemfootprint(): integer

Ab Version 5.8. Liefert als Resultat die Anzahl Bytes, welche das Objekt im Memory belegt (Memory Footprint).

Der Wert wird wie folgt bestimmt:

Instanz des Objekts

+ Summe der Instanzen aller Member

+ Grösse des Wertes jedes Members (bei Strings die Länge)

+ MemFootPrint aller owned linked Objekte (z.B. Phasen des Projekts).

Es ist zu beachten, dass es sich dabei um eine Annäherung handelt, da die Grenze, was bei einem Objekt alles gezählt werden muss, nicht genau gezogen werden kann.

Folgendes Script gibt den Memory-Bedarf aller Projekte im System aus:

r = vtcapp.evalocl("projekt")
for projekt in r:
print projekt.code + ' ' + \
str(projekt.getmemfootprint())
getmlvalue(membername:string, language:string): value

Die sogenannten Multilanguage-Attribute (MLStrings, 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)

Um ein solches Attribut zu setzen, kann die Methode setmlvalue() verwendet werden.

taetigkeit = argobject
print taetigkeit.getmlvalue("text", "FR")
>>>
Vacances
>>>

Wird das Member normal abgefragt, entspricht der Rückgabewert immer der aktuellen Vertec-Sprache:

print taetigkeit.text
>>>
Ferien/Urlaub
>>>
hasattr(object, name): boolean

Überprüft, ob ein Objekt ein entsprechendes Member hat.

obj = adresse
if hasattr(obj, "vorname"):
print obj.vorname
hastag(tagname): boolean

Ab Version 6.1.0.10. Prüft, ob ein Objekt einen entsprechenden Tag gesetzt hat.

Informationen dazu finden Sie im Artikel Tags auf User-Einträgen.

obj = argobject
if obj.hastag('mytag'):
...

istypeof(Classname:string)

oder

IsTypeOf(Classname:string): boolean

Prüft, ob das Objekt vom Typ Classname ist.

True oder False.

obj = argobject # das aktuelle Objekt \
ist eine Firma in Vertec
obj.IsTypeOf("Projekt")
>>> 0 # false

obj.istypeof("Firma")
>>> 1 # true

linkto(target, rolle)

Macht eine Verknüpfung via Linktyp vom Objekt zum übergebenen Objekt (target) mit der angegebenen Rolle.

Detaillierte Informationen zu diesem Thema finden Sie im Artikel Operatoren und Methoden für Links.

removetag(tagname)

Ab Version 6.1.0.10. Löscht den entsprechenden Tag von diesem Objekt.

Informationen dazu finden Sie im Artikel Tags auf User-Einträgen.

argobject.remove('mytag')
setattr(object, name, value)

Beschreibt das Attribut name des Objektes object mit dem Wert value.

So kann man beispielsweise durch die Zusatzfelder eines Objektes loopen und die gefundenen Attributnamen nutzen, um die Attribute zu beschreiben.

Dieser Code erstellt ein neues Objekt vom gleichen Typ wie das argobject und kopiert die Inhalte alle Zusatzfelder auf das neue Objekt.

source = argobject
target = vtcapp.createobject\
(source.eval('ocltype.asstring'))
zusatzfelder = source.zusatzfelder
for z in zusatzfelder:
zName = z.metazusatzfeld.fieldname

Nun weiss man den Namen des Zusatzfeldes, aber würde man es mit target.zName ansprechen, gäbe es eine Fehlermeldung "target has no attribute zName". Also verwendet man setattr:

setattr(target, zName, getattr(source, zName))
vtcapp.showdetailform(target)
setkeyvalue(key, value)

Ab Vertec 6.1.0.10. Mit dieser Methode werden kundenspezifische Werte als Key-Values auf User-Einträgen abgelegt.

Auf diese Werte kann später über die getkey-Methoden zugegriffen und Listen so performant gefiltert werden.

argobject.setkeyvalue("datum", "2017-02-03")
setmemberoutofdate(membername:string)

Wenn ein Wert frisch von Datenbank gelesen werden soll, muss das Feld out of date gesetzt werden.

Diese Methode macht dasselbe wie der Notif bei einer Modified message.

proj = argobject
proj.setmemberoutofdate('code')

sorgt dafür, dass beim nächsten Zugriff auf Projekt.code dieser Wert frisch aus der Datenbank geladen wird.

setmlvalue(membername:string, value:string, language:string)

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

  • Membername: Name des Members
  • Value: Der Wert für die angegebene Sprache
  • 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)

Um ein solches Attribut abzufragen, kann die Methode getmlvalue() verwendet werden.

taetigkeit = argobject
taetigkeit.setmlvalue("text", "Vacanze", "IT")

unlink(target, rolle)

Entfernt die Verknüpfung vom Objekt zum übergebenen Objekt (target) mit der angegebenen Link-Rolle.

Detaillierte Informationen zu diesem Thema finden Sie im Artikel Operatoren und Methoden für Links.
unload(): None

Entfernt das Objekt aus dem Vertec Objektspeicher.

Diese Methode wurde eingeführt, um bei Datenmigrationen den Memorybedarf steuern zu können. Sie muss jedoch mit äusserster Vorsicht verwendet werden, da anschliessende Zugriffe auf das entladene Objekt zu Fehlern führen können.

Wir raten von der Verwendung ab, ausser auf eigenes Risiko und wenn man genau weiss, was man tut.

Classname eines Objektes

Der Zugriff auf den classname funktioniert in Python nur über OCL:

obj.eval('ocltype.asstring')

Methoden auf einzelnen Objekten vom Typ "Projekt"

Methode/FunktionBeschreibungBeispielcode
entrytypeslookup(typidx, phase=None): Liste von Projekteintragstypen

Gibt eine Liste von Projekteintragstypen für das Projekt (und optional eine Phase) zurück

typeidx: 0: Tätigkeiten, 1: Spesentypen, 2: Auslagetypen.

proj = argobject
taetigkeitenliste = proj.entrytypeslookup(0, None)
phaseslookup(user, entrytype=None): Liste von Projektphasen

Gibt eine Liste von Projektphasen für den angegebenen User (und optional eines Projekteintragstyps) zurück.

proj = argobject
bearbeiter= vtcapp.currentlogin()
phasenliste = proj.phaseslookup(bearbeiter, None)
projektbearbeiterisassigned(user): boolean

Gibt an, ob der angegebene User berechtigt ist, auf diesem Projekt Leistungen etc. zu erzeugen.

proj = argobject
bearbeiter= vtcapp.currentlogin()
if proj.projektbearbeiterisassigned(bearbeiter):
  ...

Methoden auf einzelnen Objekten vom Typ "Projektbearbeiter"

Methode/FunktionBeschreibungBeispielcode
changepassword(newpassword:string)Ändert das Passwort des Bearbeiters. Nur erlaubt, falls der Bearbeiter selbst angemeldet oder Administrator ist.
bearb = argobject
bearb.changepassword('Ndlsije56!')
ispasswordvalid(password:string)

Prüft, ob das Passwort das korrekte (aktuelle) Passwort für den Benutzer ist.

bearb = argobject
ir bearb.ispasswordvalid('Ndlsije56!'):
...

Methoden auf einzelnen Objekten vom Typ "Rechnung"

Methode/FunktionBeschreibungBeispielcode
buchen([raiseException])

Ab Version 5.8. Bucht eine Rechnung in die Buchhaltung.

Das Argument raiseException ist ein Boolean (Wahr/Falsch), welcher angibt, ob Fehler beim Buchen bzw. beim Stornieren gemeldet werden sollen.

raiseException ist optional, Default-Wert ist True.

Wenn raiseException False ist, dann werden Fehler beim Buchen ignoriert, die Rechnung ist dann einfach nicht gebucht.

rechnung = argobject
rechnung.buchen()
importZahlungen()

Ab Version 5.8. Importiert die Zahlungen zur aktuellen Rechnung. Funktioniert nur, wenn die Debitorenschnittstelle den Zahlungsabgleich unterstützt.

argobject.importzahlungen()
makeoffen([raiseException])

Ab Version 5.8. Setzt eine verrechnete Rechnung wieder auf offen (Verrechnen rückgängig).

Das Argument raiseException ist ein Boolean (Wahr/Falsch), welcher angibt, ob Fehler beim Verrechnen bzw. beim Verrechnen rückgängig gemeldet werden sollen.

raiseException ist optional, Default-Wert ist True.

Wenn raiseException False ist, dann werden Fehler beim Verrechnen rückgängig ignoriert, die Rechnung bleibt dann einfach verrechnet.

rechnung = argobject
rechnung.makeoffen(False)
makeverrechnet([raiseException])

Ab Version 5.8. Verrechnet eine offene Rechnung.

Das Argument raiseException ist ein Boolean (Wahr/Falsch), welcher angibt, ob Fehler beim Verrechnen bzw. beim Verrechnen rückgängig gemeldet werden sollen.

raiseException ist optional, Default-Wert ist True.

Wenn raiseException False ist, dann werden Fehler beim Verrechnen ignoriert, die Rechnung bleibt dann einfach offen.

rechnung = argobject
rechnung.makeverrechnet(False)
stornieren([raiseException])

Ab Version 5.8. Storniert eine gebuchte Rechnung.

Das Argument raiseException ist ein Boolean (Wahr/Falsch), welcher angibt, ob Fehler beim Buchen bzw. beim Stornieren gemeldet werden sollen.

raiseException ist optional, Default-Wert ist True.

Wenn raiseException False ist, dann werden Fehler beim Buchen ignoriert, die Rechnung ist dann einfach nicht storniert.
rechnung = argobject
rechnung.stornieren()

Methoden auf einzelnen Objekten vom Typ "Projekteintrag"

Unter dem Begriff Projekteintrag werden Leistungen, Spesen und Auslagen zusammengefasst.

Methode/FunktionBeschreibungBeispielcode
makeoffen()

Ab Version 5.8. Setzt eine verrechnete Leistung, Spese oder Auslage auf offen.

Das funktioniert nur, wenn sich die Leistung, Spese oder Auslage nicht auf einer Rechnung befindet, ansonsten wird ein Fehler geworfen.

argobject.makeoffen()
makeverrechnet()

Ab Version 5.8. Setzt eine offene Leistung, Spese oder Auslage auf verrechnet.

Das funktioniert nur, wenn sich die Leistung, Spese oder Auslage nicht auf einer Rechnung befindet, ansonsten wird ein Fehler geworfen.

argobject.makeverrechnet()

Methoden auf einzelnen Objekten vom Typ "Leistung"

Methode/FunktionBeschreibungBeispielcode
updatesatz()Ab Version 6.1.0.14. Stundensatz wird neu berechnet (aus Tarifsystem).

Benötigt Berechtigung Projekt-Administrator oder Super.

argobject.updatesatz()

Methoden auf einzelnen Objekten vom Typ "Aktivitaet"

Methode/FunkionBeschreibungBeispielcode
setpfad(pfad: string)Ab Version 6.1.0.14. Setzt den Dokumentenpfad auf der Aktivität.

Benötigt Schreibrechte auf der Aktivität.

argobject.setpfad('C:\\Dokumente\\text.txt')

Methoden auf einzelnen Objekten vom Typ "Waehrung"

Methode/FunktionBeschreibungBeispielcode
getkursto(waehrung: object, date: date): currencyAb Version 6.1.0.14. Gibt den Umrechnungskurs zum entsprechenden Datum zurück.
chf.getkursto(eur, vtcapp.currentdate())

Das Modul "vtcforms"

Dieses Modul wurde verwendet, um eigene Forms zu erzeugen und anzuzeigen. Es hat folgende Funktionen:

Methode/FunktionBeschreibung
Application()Das Application-Objekt. Wird verwendet, um eine Messagebox anzuzeigen.

vtcForms-Dialoge, welche ab Vertec 6.0 nur in der Classic App und der Desktop App lauffähig sind, werden auf Version 6.2 eingestellt. Sie werden vom in Version 6.1 eingeführten neuen Dialog-Mechanismus abgelöst, welcher auch in den Cloud Clients lauffähig ist.