Vertec Python Funktionen

argobject

Aktuelles Vertec Objekt. Diese Variable ist immer verfügbar, der Aufruf kann also ohne vtcapp. erfolgen.

project = argobject

bigetdata(source, dimensions, measures, from, till, currency=None)

Ab Vertec 6.8. Python Funktion für die Abfrage von Business Intelligence (BI) Daten. 

Die genaue Beschreibung finden Sie im Artikel Python Funktion für die Abfrage von BI Daten

projects = vtcapp.currentlogin().evalocl("ownprojects->select(active)")
result = vtcapp.bigetdata(projects, ["Project"], ["FeesExt"], None, None)
for project in projects:
    print("Fee: {}".format(result.get_value(project, "FeesExt")))

checkcreate(classname:string): int

Prüft, ob in der aktuellen Session die Berechtigung zum Erstellen von Objekten der angegebenen Klasse besteht.

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

>>> vtcapp.checkcreate('Project')
1

checkfeature(featurecode: string): boolean

Prüft, ob ein bestimmtes Feature lizenziert ist.

Die Featurecodes sind gemäss Vertec Featurematrix (z.B. fcPhases für Phasen).

Rückgabewert ist False oder True

>>> vtcapp.checkfeature('fcPhases')
True

convertwordtopdf(wordDoc: string): string

Wandelt ein Word-Dokument vom Typ .docx in ein PDF um.

(name, file) = vtcapp.requestfilefromclient("Dokument wählen", r"C:", "Word|*.docx")
pdfDoc = vtcapp.convertwordtopdf(file)
vtcapp.sendfile(pdfDoc, 'aFilename.pdf' , True)

createoutlookmail(to, subject, body="", cc="", bcc="", attachments=[], show=True, onBehalfOf="")

Python Methode ab Version 6.4.0.4, welche es ermöglicht, auf dem Client via Outlook eine E-Mail Nachricht zu erstellen.

Funktioniert mit der Cloud App (und der Desktop App) und Outlook als lokalem Windows Client. 

Wenn Sie mit der Web App oder dem New Outlook arbeiten, kann die Methode sendmail() verwendet werden (das "New Outlook" für Windows ist kein lokaler Windows Client, sondern ein Web Client, eingepackt in ein Windows Programm. Der Versand via createoutlookmail() funktioniert damit nicht). 

• to: String. Empfängeradressen, mit ; getrennt, falls mehrere.
• subject: String. Betreff der E-Mail.
• body:
  • String. Der eigentliche E-Mail-Text. Kann HTML oder plaintext sein. HTML wird als solches erkannt und dann in Form einer Outlook HTML Mail erstellt.
  • Ab Version 6.5.0.21 kann auch ein Word-Dokument verwendet werden (siehe Beispiel unten).

Optional:

• body: Ist ab Version 6.7 optional. Falls body nicht angegeben, ein Leerstring oder None ist, wird in der angelegten E-Mail nichts gesetzt.
• cc: String, Optional, Keyword*. Cc-Adressen, mit ; getrennt, falls mehrere.
• bcc: String, Optional, Keyword*. Bcc-Adressen, mit ; getrennt, falls mehrere.
• attachments: Liste von Tuples, Optional, Keyword. Liste von Attachments als Tuple von zwei Strings[(Name des Files, Inhalt)], siehe Beispiel unten.
• show: Boolean, Optional, Keyword*. Bei True wird die E-Mail erstellt und angezeigt, bei False wird die E-Mail im "Enwürfe"-Ordner gespeichert und nicht angezeigt. Default-Wert ist True.
• onBehalfOf: String, Optional. Versendet das E-Mail mit einem abweichenden Absender. Beispiel: vtcapp.createoutlookmail("myemail@company.com", "Subject", onBehalfOf="noreply@vertec.com") öffnet eine E-Mail mit dem Absender noreply@vertec.com.

*Keyword bedeutet, dass Sie die optionalen Werte mit dem Parameter als Keyword, z.B. CC="abc@vertec.com" angeben können. So benötigen Sie keine bestimmte Anzahl Kommas als Platzhalter für nicht angegebene optionalen Werte.

Beispiele:

• Einfachster Fall, Body als String:

  vtcapp.createoutlookmail("myemail@company.com", "aSubject", "Dies ist der einfachste Fall")

• Verwendung von Word-Dokumenten als Body:

Hinweis: Verwenden Sie in Ihren Word-Dokumenten Tabellen und vermeiden Sie Tabstopps, da diese im E-Mail nicht verarbeitet werden können.

1. Das entsprechende Word-Dokument muss geladen werden:

   (name, file) = vtcapp.requestfilefromclient("Dokument wählen", r"C:", "Word|*.docx")

2. Mit der Methode die E-Mail generieren:

   vtcapp.createoutlookmail('myemail@company.com', 'aSubject', file)

• show (per keyword angegeben):

  vtcapp.createoutlookmail("myemail@company.com", "aSubject", "aBodyText", show=False)

• Attachments:

  activity = argobject
  attachments=[('File1.txt', 'This is the content of file 1'),('Anhang.pdf', activity.content)] 
  vtcapp.createoutlookmail("myemail@company.com", "aSubject", "Eine E-Mail mit Attachments", attachments=attachments, show=False)

  Der Attachmentname darf nicht leer sein.
• Body in HTML

  html="<html><body><p>Hallo</p><p>Dies ist eine Outlook Nachricht in HTML.</p><p>Es ist ziemlich einfach, verwenden Sie HTML BODY und P (Paragraph) wie hier dargestellt, und schon entsteht eine strukturierte E-Mail.</p><p>Möchten Sie <b>fettgedruckten</b>, <i>kursiven</i>, <u>unterstrichenen</u> Text, verwenden Sie die entsprechenden Tags.<span style=\"color: red\"> Sie können auch eine andere Farbe verwenden.</span></p><p>Freundliche Grüsse</p><p>Ihr Vertec Team</p></body></html>" 
  vtcapp.createoutlookmail("myemail@company.com", "aSubject", html)

createlist(classname, [list]): list

• 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 Liste direkt aufgrund einer anderen Liste. Wird das Argument nicht gesetzt, ist die erzeugte Liste leer und kann via append() oder extend() Methode gefüllt werden (siehe Auflistung der verfügbaren Methoden auf Vertec-Listen).

Die Python-Methoden evalocl(), getwithsql() und getmemberwithsql() liefern automatisch Vertec-Listen zurück, siehe Vertec-Listen.

mylist = vtcapp.createlist('Project')
mylist.append(argobject)

oder mit Angabe von list:

mylist = vtcapp.createlist("Project", vtcapp.currentlogin().evalocl("ownprojects"))
mylist2 = list.evalocl("self->select(active)")

createobject(klasse: string)

leistung = vtcapp.createobject("OpenService")

currentlogin(): User

user = vtcapp.currentlogin()

currentobject

myobject = currentobject

disableevents()

Ab Vertec 6.7.0.7 stattdessen immer DisabledEvents() verwenden.

Mit disableevents() kann das Eventsscripting ausgeschaltet werden. Dies betrifft dann die gesamte Vertec-Session (andere Vertec-Sessions sind nicht betroffen).

Wird dann verwendet, wenn ein gewisses Attribut angepasst werden soll, welches sonst einen Event ausführen würde.

Muss mit enableevents() wieder eingeschaltet werden. 

Benötigt erweiterte Berechtigungen. Ist im Python-Editor aus Sicherheitsgründen nicht erlaubt. 

try:
    vtcapp.disableevents()
    invoice.entrydate = vtcapp.currentdate()
finally:
    vtcapp.enableevents()

DisabledEvents()

Ab Version 6.7.0.7. Muss mit with aufgerufen werden:

with vtcapp.DisabledEvents():

Innerhalb dieser Methode ist das Eventsscripting ausgeschaltet. Dies betrifft dann die gesamte Vertec-Session (andere Vertec-Sessions oder Desktop Apps sind nicht betroffen).

Wird z.B. dann verwendet, wenn ein gewisses Attribut angepasst werden soll, welches sonst einen Event ausführen würde.

Benötigt erweiterte Berechtigungen. Ist im Python-Editor aus Sicherheitsgründen nicht erlaubt.

with vtcapp.DisabledEvents():
    invoice.entrydate= vtcapp.currentdate()

evalocl(expression: string): expressiontype

vtcapp.evalocl("user->select(active)")

evaloclstring(obj: object, expStr: string): string

>>> vtcapp.evaloclstring(argobject,"Bearbeiter: %name% ist %level.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 dann global mit evalocl() abgefragt werden.

Als Variablenname darf self nicht verwendet werden, da dies ein Schlüsselwort ist. Bei Verwendung erscheint eine Fehlermeldung.

vtcapp.evaltovariable(argobject, "invoices->first", "varInvoice")

>>> vtcapp.evalocl("varInvoice")
25050018, IT Consulting

executefile(command: string, [argumentString: string])

Funktion zum Aufrufen von Dateien via Vertec Desktop App und Vertec Cloud App.

Es werden auch Kommandozeilen-Parameter unterstützt. Dafür können optional Argumente übergeben werden. Der bisherige, einfache Fall funktioniert weiterhin.

Das Parameterparsing ist wie folgt:

• Im command findet kein Parsing statt. Leerzeichen werden als Teil des Pfades interpretiert.
• Im argumentString findet das Parsing statt, dort trennen Leerzeichen die Argumente, ausser sie befinden sich innerhalb von doppelten Anführungszeichen "".

Es können nur Dateien vom Typ .doc, .docx, .xls, .xlsx, .pdf, .csv, .txt, .zip, .png, .jpg, .jpeg, .bmp, .gif, .eml und ab Vertec 6.5.0.15 .ics direkt ausgeführt werden (gleiche Whitelist wie bei sendfile()). Bei allen anderen kommt ein Dialog mit der Frage, ob Vertec die Datei öffnen darf:

• Falls Ja, werden Pfad und Name der Datei gemerkt, und der Dialog erscheint beim erneuten Aufruf dieser Datei nicht mehr.
  Das geschieht durch einen Eintrag in der Registry im Key: HKEY_CURRENT_USER\Software\Vertec\ExecuteFileWhiteList. Das Whitelisting bezieht sich nur auf die ausführbare Datei samt Pfad, nicht auf etwaige Argumente.
• Falls Nein, besteht kein Schreibzugriff auf diesen Teil der Registry und die Datei kann nicht gemerkt werden. Es wird eine Warnung ins Logfile geschrieben (Vertec.Cloud.log bzw. Vertec.Desktop.log)

Beispiele

Öffnen eines Word-Files:

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.

Öffnen eines Files in Notepad++, mit Kommandozeilen-Parameter:

vtcapp.executefile('notepad++.exe', r'-lpython "C:\Dokumente\Mein Script.py"')

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:

pfad = r'S:\Dokumente\Kontakte\Bistro Cooper'
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 wird und es einen Fehler gibt.

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

Erlaubt den Aufruf und das Ausführen von Berichten aufgrund eines Bericht-Objekts.
Eine Tabelle über die Verfügbarkeit mit den verschiedenen Systemen finden Sie im Abschnitt weiter unten.

• rootObj: Das Objekt, auf dem der Bericht ausgeführt wird. Es kann nur ein einzelnes Objekt, keine Liste angegeben werden.
• optarg: Entspricht der optionalen Adresse auf dem Druckdialog. Optionales Argument. Wenn nicht verwendet, Parameter mit None angeben.
• berichtObj: Eine Vertec Bericht-Definition (Klasse Bericht). Der Bericht wird aufgrund dieser 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. Dieser String kann auch OCL Expressions (mit % getrennt) enthalten.
  • Pfad (inkl. Dateiname) zum Speichern des Berichts bei Dokumentspeicherung Dateisystem oder DMS.
  • Dateiname zum Speichern des Berichts bei Dokumentspeicherung Intern.
  • Falls ein Leerstring angegeben wird, dann wird keine Datei gespeichert.
  • Wenn None übergeben wird, werden die Speichern unter Einstellungen aus dem Bericht-Objekt (berichtObj) übernommen.
• showDialog: Optional. Zeigt den Druckdialog vor der Ausführung. Mögliche Werte: True oder False.
  Die Anzeige von Meldungen wie "existierende Datei überschreiben" und "neuen Pfad erstellen" werden über diese Einstellung gesteuert. Wenn der Parameter nicht gesetzt wird, wird die entsprechende Einstellung aus dem Bericht-Objekt (berichtObj) übernommen.
• doPrint: Optional. Dieser Wert wird nur bei Office-generierten Legacy-Berichten vor Version 6.6.0.8 berücksichtigt. Mögliche Werte: True oder False. Falls True, wird der Bericht direkt ausgedruckt, ohne dass sich die entsprechende Office-Applikation öffnet.
• showApp: Optional. Gibt an, ob der Bericht geöffnet und angezeigt werden soll. Mögliche Werte: True oder False.

Beispiele

Einen Word-Bericht für Rechnung anzeigen, ohne Dialog und ohne eine Datei zu speichern:

rechTempl = vtcapp.evalocl("report->select(entryid='BerichtScriptInvoiceWithList')->first")
vtcapp.executereport(argobject, None, rechTempl, "", showDialog=False)

Ab Version 6.4.0.8 gibt die Methode den Bericht-Output als Byte-String zurück. Dieser kann weiterverarbeitet und beispielsweise als Attachment an eine E-Mail gehängt werden via vtcapp.createoutlookmail().

rechTempl = vtcapp.evalocl("report->select(entryid='BerichtScriptInvoiceWithList')->first")
pdf = vtcapp.executereport(argobject, None, rechTempl, "", showDialog=False)
vtcapp.createoutlookmail("myemail@company.com", "aSubject", "aBody", attachments=[('rechnung.pdf', pdf)])

executereport2(rootObj, optarg, berichtObj, [saveAs, showDialog, doPrint, showApp]): (bericht, aktivität)

Ab Version 6.4.0.22. Erlaubt den Aufruf und das Ausführen von Berichten aufgrund eines Bericht-Objekts.

Die Methode gibt ein Tupel bestehend aus dem Bericht-Output als Byte-String sowie der zugehörigen Aktivität zurück.

Für die Beschreibung der Parameter siehe executereport() hier oberhalb.

Eine Tabelle über die Verfügbarkeit mit den verschiedenen Systemen finden Sie im Abschnitt weiter unten.

rechTempl = vtcapp.evalocl("report->select(entryid='BerichtScriptInvoiceWithList')->first")
reportdoc, activity = vtcapp.executereport2(argobject, None, rechTempl)

Der Rückgabewert der Methode ist ein Tuple:

• Inhalt des resultierenden Bericht-Dokuments ist (Byte-String).
• Das angelegte Aktivitäts-Objekt oder None. Eine Aktivität wird nur erzeugt, wenn ein Bericht gespeichert wird.

executeurl(url)

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

Die URL muss vom Client aus erreichbar sein. In der Web App muss es sich um einen öffentlich erreichbaren Pfad handeln, ein Zugriff auf den lokalen Client ist nicht möglich.

Zum Beispiel eine Website im Browser öffnen:

vtcapp.executeurl("https://www.vertec.com")

Oder eine Vertec Breadcrumb URL:

vtcapp.executeurl("vertec://CK-676/Own+projects-49/COMINSTALL-2880/")

dasselbe funktioniert auch als Kurzversion, in der nur die IDs angegeben sind:

vtcapp.executeurl("vertec://676/49/2880/")

extractplaintext(file, extension [optional]): string

Ab Vertec 6.8. Wird verwendet, um (unformatierten) Text aus Dateien zu extrahieren.

Die Methode prüft, ob die übergebene Datei (bytearray) eine der folgenden Typen darstellt:

• PDF
• DOC(X)
• EML/MIME
• XLS(X)
• PPTX

Wenn ja, extrahiert sie den Text dieser Dateien und gibt ihn als plaintext (string) zurück.

Stellt das Bytearray keinen der genannten Dateitypen dar, oder schlägt das Auslesen des Inhalts fehl, zum Beispiel weil die Datei ungültig ist oder es sich um ein passwortgeschützes PDF handelt, wird ein Leerstring ausgegeben.

Optionale Extension (ab Version 6.8.0.6): Mit Angabe einer Extension wird der Dateityp nicht aufgrund der übergebenen Datei ermittelt, sondern via Extension angegeben. Damit sind folgende Dateitypen gültig:  .pdf, .doc(x), .eml/mime und .txt, sowie ab Version 6.8.0.7 .xls(x) und pptx. Für TXT-Dateien wird der Inhalt als einfache Textdatei interpretiert. Ist eine Extension angegeben und die übergebene Datei lässt sich nicht als solche interpretieren, wird anstelle eines Leerstrings eine Fehlermeldung ausgegeben.

Dokumentspeicherung Intern:

file = argobject.content
text = vtcapp.extractplaintext(file)

Dokumentspeicherung Filesystem/DMS:

filename, file = vtcapp.requestfilefromclient("Datei auswählen", r"C:\Dokumente", "PDF|*.pdf|DOCX|*.docx|EML|*.eml|MIME|*.msg")
text = vtcapp.extractplaintext(file)

fetchlinkmembers(objectlist, membername): objectlist

# Loop durch die Phasen von Projekten, welche mindestens eine Phase "erteilt" haben
projekte = vtcapp.getwithsql("Project", "bold_id IN (SELECT project FROM phase WHERE status=1)", "")
vtcapp.fetchlinkmembers(projekte, "phases")
for projekt in projekte:
    x = projekt.evalocl("phases->select(status=1)")

generateinvoicenumber()

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

invoice = argobject
invoice.number = vtcapp.generateinvoicenumber()

getcurrentobject()

Liefert das im Baum selektierte Objekt zurück und kann mithilfe von OCL Call Operatoren aus OCL aufgerufen werden.

getmailattachment(content, idx): bytestring

Ab Version 6.5. Erlaubt den Download eines E-Mail Attachments einer Aktivität.

Liefert als Rückgabewert den Inhalt des Attachments als Byte-String zurück.

Da die Namen der Attachments nicht zwingend eindeutig sind, muss es per Idx identifiziert werden.

activity = argobject
filecontent = vtcapp.getmailattachment(activity.content, 0)

getmailattachments(content): list(string)

Ab Version 6.5. Liefert eine Liste der Attachment-Namen einer Aktivität.

filenames = vtcapp.getmailattachments(activity.content)

getmemberwithsql(obj: object, membername: string, where: string, order: string): list of objects

Erlaubt die Abfrage von Members eines Objekts per SQL.

Der ausführende Benutzer muss über Administratorenrechte oder über das SQL Query Recht verfügen.

Für die Erteilung von temporären Administratorenrechte steht die Variante der erweiterten Berechtigungen zur Verfügung.

project = argobject
servicelist = vtcapp.getmemberwithsql(project, "openservices", "xfeeext>200", "") 

getobjectbyentryid(classname: string, entryid: string): object

Ab Version 6.6.0.2. Holt das Objekt mit der angegebenen Klasse und Eintrag Id.

Es müssen immer beide Parameter angegeben werden.

Falls die Klasse classname nicht existiert oder nicht vom Typ Eintrag erbt, wird ein Fehler geworfen.

Falls keine oder mehrere Objekte gefunden werden, wird ein Fehler geworfen.

Hinweis: Die Objekte werden intern via SQL geladen. Somit werden nur bereits in der Datenbank gespeicherte Objekte gefunden. Bei neu angelegten Objekten muss zuerst ein vtcapp.updatedatabase() abgesetzt werden, damit das Objekt mit dieser Methode gefunden wird.

folder = vtcapp.getobjectbyentryid("Folder", "KeywordFolderAdministration")

getobjectbyid(id: int, string or long*): object

Holt das Objekt mit der angegebenen Internen Id.

Ist die Id nicht vorhanden, wird ein Fehler geworfen.

Hinweis: Die Objekte werden intern via SQL geladen. Somit werden nur bereits in der Datenbank gespeicherte Objekte gefunden. Bei neu angelegten Objekten muss zuerst ein vtcapp.updatedatabase() abgesetzt werden, damit das Objekt mit dieser Methode gefunden wird.

* Ab Vertec 6.7.0.4.

obj = vtcapp.getobjectbyid(62162)

oder

obj = vtcapp.getobjectbyid("62162")

getpropertyvalue(propname: string): value

Gibt den Wert der Systemeinstellung (Property) mit dem angegebenen Namen zurück.

Der Rückgabewert richtet sich nach dem Typ des Propertys.

mycompany = vtcapp.getpropertyvalue("company")

getvertecserveraddress(): string

Liefert die Adresse, unter welcher der Vertec Cloud Server aus dem Internet verfügbar ist.

myurl = vtcapp.getvertecserveraddress()

Öffnet direkt das Vertec App Portal im Browser:

vtcapp.executeurl(vtcapp.getvertecserveraddress())

getwithsql(klasse: string, where: string, order: string, [idfilterfeld: string, objectlist: list]): list of objects

Dieses globale SQL Statement dient dazu, Listen, die gefiltert werden sollen, performance-optimiert direkt auf der Datenbank zu filtern (siehe dazu den Artikel Performanceoptimierter Zugriff auf Vertec Objekte).

Ein Aufruf via getwithsql() ist nur dann sinnvoll, wenn eine Where-Klausel benötigt wird. Für ungefilterte Listen verwenden Sie statt getwithsql() bitte evalocl().

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

• klasse: Klassenname als String.
• where: SQL WHERE-Klausel. Diese kann auch mithilfe der Methoden sqlwhere() und sqlwherebetweendate() erstellt werden.
• order: SQL Sortierexpression, üblicherweise ein Feldname der angegebenen Klasse.
  Kann nur verwendet werden, wenn kein idfilterfeld/objectlist angegeben wird.

• idfilterfeld: Name des Members, nach welchem die Liste gefiltert werden soll.
• objectlist: Liste der Objekte, nach welchen im unter idfilterfeld angegebenen Feld gesucht werden soll.

In Vertec Versionen vor 6.7.0.9 (vor Firebird 5) muss bei Listen (nicht die Ergebnisliste, sondern die Filterkriterienliste, im Beispiel rechts also die projekte) von mehr als 1500 Einträgen zwingend mit diesen Filterkriterien gearbeitet werden, da sonst eine Fehlermeldung erscheint.

Ohne optionale Filterkriterien:

projektlist = vtcapp.getwithsql("Project", "bold_id IN (SELECT project FROM phase WHERE status=1)", "code")

Mit optionalen Filterkriterien:

projekte = argobject.evalocl("ownProjects")
leistungen = vtcapp.getwithsql("OpenService","", "entrydate", "project", projekte) 

getwithsqlbymember(klasse: string, member: string, expression: string, order [optional]: string): list of objects

• klasse: Klassenname als String.
• member: Membername als String
• expression: Vergleichs-String (ohne Delimiter). Er kann % Platzhalter enthalten, etwaige String-Delimiter innerhalb
  des Strings werden escaped. Der Vergleich ist case-insensitiv.
• order: SQL Sortierexpression, üblicherweise ein Feldname der angegebenen Klasse.

Beim Aufruf der Funktion wird die Berechtigung des aktuellen Bearbeiters auf dem für die Selektion verwendeten Member geprüft. Der Benutzer muss klassenweites Lese-Recht auf dem Member haben, damit die Suche funktioniert. Andernfalls gibt es einen Fehler.

projektliste = vtcapp.getwithsqlbymember("Project", "Code", "COM%")

importconfigset(xmltext: string/file): string

Vor Vertec 6.7.0.7:

importconfigset(xmltext: string/file)

Importiert ein Config Set in Vertec und wendet es an.

Als xmltext wird gültiger XML-Text als String (UTF-8) oder ein Config Set übergeben.

Ab Vertec 6.7.0.7 gibt die Funktion einen String zurück, welcher mögliche Fehler während des Imports enthält.

(name, file) = vtcapp.requestfilefromclient("Config Set wählen", r"C:", "XML|*.xml")
vtcapp.importconfigset(file)

Oder als XML-String:

xml="""<?xml version="1.0" encoding="utf-8"?>
<configset name="test" author="test"> <requirements /> <references/> 
<objects/> <settings> <system-setting name="GlobalDokPfad">C:\Dokumente</system-setting>
</settings></configset>""".encode('utf-8')
vtcapp.importconfigset(xml)

indexall([clean:boolean])

Ab Vertec 6.8. Indiziert alle Objekte für die Volltextsuche neu. 

Wird clean angegeben, wird der bereits vorhandene Index weggeworfen und neu erstellt.

vtcapp.indexall()

behält den aktuellen Index und ergänzt ihn durch die geänderten Objekte.

vtcapp.indexall(True)

wirft den vorhandenen Index weg und erstellt ihn komplett neu. 

indexclass(classname: string)

Ab Vertec 6.8. Indiziert Objekte der angegebenen Klasse für die Volltextsuche neu.

Sind für die mit classname übergebene Klasse Indexkonfigurationen hinterlegt bzw. bei der Klasse Aktivitaet die Systemeinstellungen für das Indizieren von Dokumenten oder E-Mails gesetzt, werden mit dieser Funktion alle Objekte dieser Klasse neu indiziert.

Sind diese Voraussetzungen nicht erfüllt, dann wird nichts gemacht.

vtcapp.indexclass("Project")

indexlist(objectlist)

Ab Vertec 6.8. Die Methode nimmt eine Liste von Objekten entgegen und indiziert diese für die Volltextsuche neu. 

Objekte, für die kein Index geschrieben werden soll, werden automatisch aussortiert.

Es kann auch ein einzelnes Objekt als Liste übergeben werden.

Einzelnes Objekt indizieren:

vtcapp.indexlist([argobject])

Liste indizieren:

list = argobject.entries
vtcapp.indexlist(list)

 indexactivities(type: integer)

Ab Vertec 6.8. Mit dieser Methode können Aktivitäten einer bestimmten Art (type) für die Volltextsuche neu indiziert werden. 

Als type wird einer der folgenden Werte übergeben:

• 0: Es werden Aktivitäten ohne Dokument oder Email neu indiziert
• 1: Es werden alle Dokumente neu indiziert
• 2: Es werden alle Emails (inl. Attachments) neu indiziert

vtcapp.indexactivities(1)

indiziert alle Dokumente neu.

indexstatus(): dict

Ab Vertec 6.8. Gibt Informationen über den Status der Indizierung für die Volltextsuche als Dictionary mit folgenden Informationen aus:

• IsAvailable: Boolean. True, wenn der Server erreicht wurde, sonst False.
• OperationRunning: Boolean. True: Es läuft aktuell eine "komplexe" Operation. Nur vorhanden, wenn eine Verbindung zum Index Server besteht.
• ProcessedObjectCount: Integer. Anzahl bereits verarbeiteter Objekte. Nur vorhanden, wenn eine "komplexe" Operation läuft.
• TotalObjectCount: Integer. Gesamtanzahl der zu verarbeitenden Objekte. Nur vorhanden, wenn eine "komplexe" Operation läuft.
• StatusMessage: String. Aktueller Status des Indexers.
• PercentCompletion: Double. Abgeschlossen in Prozent (von 0 bis 1). Nur vorhanden, wenn eine "komplexe" Operation läuft.

Diese Informationen werden auch in den System Info im neuen Bereich Indexing ausgegeben.

Komplexe Operationen sind indexall(), indexclass() und indexactivities()). Es kann nur eine komplexe Operation aufs Mal gestartet werden. Wird versucht, eine weitere zu starten, quittiert der Vertec Cloud Server das mit einem Fehler. indexlist() kann gleichzeitig gestartet werden, wenn sie jedoch läuft, kann keine zusätzliche komplexe Operation gestartet werden. 

print vtcapp.indexstatus()
{u'OperationRunning': False, u'IsAvailable': True, u'StatusMessage': u'idle'}

indexabort()

Ab Vertec 6.8. Bricht eine aktuell laufende Indizierung für die Volltextsuche ab. 

Das Queuing der Objekte wird abgebrochen, bereits gequeute Objekte werden noch fertig indiziert.

vtcapp.indexabort()

inputbox(caption: string, prompt: string[, default: string]): string

• caption: Titel des Forms
• prompt: Einleitungstext
• default: Optional. Default-Wert

Der Aufbau der Buttons und der Rückgabewerte funktioniert gemäss Artikel msgbox/inputbox: Beschreibung der Parameter.

vtcapp.inputbox("aTitle", "Geben Sie einen Text ein:")

log(category: string, level: int, msg: string)

Log Message in Vertec Logging System. Mögliche Levels:

• 10: Debug Log
• 20: Info Log
• 30: Warning Log
• 40: Error Log
• 50: Fatal Log

Weitere Informationen finden Sie im Artikel Logging.

project = argobject
service = project.evalocl("openServices->first")
if service:
    try:
        service.xfeext = 0
    except:
        vtcapp.log("Change Service", 30, "Access denied on xfeeext")

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

Zeigt eine Message Box an.

Die Funktion unterstützt (optionale) Argumente für Buttons und Titel.

Buttons und Rückgabewerte funktionieren gemäss Artikel msgbox/inputbox: Beschreibung der Parameter.

vtcapp.msgbox("Dies ist mein Text", 1, "Vertec")

msgtomime(msgcontent): mimecontent

Ab Version 6.5.0.11. Wandelt .msg Dateien ins MIME Format um.

 Das frühere Vertec Outlook Addin speicherte E-Mails als .msg Datei und verknüpfte sie mit Aktivitäten.

Mit der Vertec Outlook App werden E-Mails auf den Aktivitäten im MIME Format direkt im content abgelegt.

Bestehende E-Mails als .msg Dateien, z.B. aus der Anwendung mit dem Vertec Outlook Addin, können mittels nebenstehendem Script umgewandelt werden. Das Script funktioniert nur ohne Restrict Scripting, also nicht im Cloud Abo, und nicht mit Sharepoint-Pfaden. Es wird auf einer Liste von Aktivitäten (aktueller Container) ausgeführt und wandelt alle .msg Dateien um (die E-Mails werden von den Laufwerkpfaden ins Vertec migriert).

import os 

for act in argobject.eintraege: 
    if act.effpfad and os.path.exists(act.effpfad): 
        try: 
            f = open(act.effpfad, 'rb')
            act.content = vtcapp.msgtomime(f.read()) 
        except Exception as e: 
            print('error on activity %s: %s' % (act, e)) 
        else: 
            print('path is empty or doesn\'t exist on activity %s' % act)

pdfcombine(doc1:string, doc2:string): string

Diese Methode fügt 2 PDF Dokumente zusammen. Die PDF Dokumente werden dabei als Byte-String übergeben.

newpdf = vtcapp.pdfcombine(pdf1, pdf2)

pdfextract(doc:string, pagefrom:int, pagetill:int): string

newpdf = vtcapp.pdfextract(pdf1, pagefrom, pagetill)

pdfpagecount(doc:string): int

pages = vtcapp.pdfpagecount(pdf1)

processbi(von: String, bis: String, generator: String)

Methode zur Berechnung von BI Daten für das Business Intelligence Modul.

Entspricht der Berechnung der BI Daten auf einer Kennzahl und löst die Berechnung des als Parameter mitgegebenen Generators aus.

Von- und Bis-Datum werden als String im Format "Jahr-Monat" angegeben.

Der Generator muss gleich angegeben werden wie bei den Kennzahlen, also "<Modulname>.<Generatorname>", siehe Beispiel.

Benötigt Administrator-Rechte.

Diese Methode kann z.B auch über eine geplante Aufgabe automatisiert werden.

Für die Berechnung aller Generatoren aller aktiven Kennzalen siehe die Methode vtcapp.standardprocessbi() weiter unten.

Beispiel: Von Januar 2018 bis und mit Februar 2020:

vtcapp.processbi("2018-01", "2020-02", "OffersGenerator.OffersGenerator")

querycallback(state): dict

Sobald dieser durchgeführt wurde, liefert die Funktion einen Dictionary mit allen mitgelieferten Parametern (inkl. State) zurück. Solange der Callback noch nicht durchgeführt wurde, wird None zurückgegeben. Bereits erfolgreich abgefragte Callbacks können nicht erneut abgefragt werden, da die Registrierung dann nicht mehr vorhanden ist.
Beim Abfragen via querycallback in einer Schleife (polling) sollte unbedingt eine Verzögerung mit Hilfe von time.sleep Aufrufen eingebaut werden, damit die Session nicht blockiert wird.

Beispielcode:

state=vtcapp.registercallback()
# nur zur Demonstration: der Aufruf sollte natürlich über einen OAuth Authentifizierungs Server gehen
vtcapp.executeurl("https://myserver.vertec-mobile.com/callback?State=%s&message=ASecretMessage" % state)
time.sleep(3.0) # kurz warten bis browser offen
values=vtcapp.querycallback(state)
print(values["message"])

readinvoicedocument(binaryData)

Die Python Funktion readinvoicedocument akzeptiert die Formate PDF, JPG und PNG von Kreditorbelegen und verarbeitet den darin enthaltenen QR-Code, den sie als Datenobjekt zurückgibt. Es wird auch EPC-QR-Code unterstützt.

*Optionale Daten: werden nur ausgegeben, wenn der QR-Code zusätzliche Informationen enthält.

Das Datenobjekt kann schliesslich mit print() ausgegeben werden.

Zudem kann die Funktion auch in einer geplanten Aufgabe verwendet werden.

Beispielscript:

name, kreditorbeleg = vtcapp.requestfilefromclient("Belegdokument auswählen", r"C:\Dokumente", "*.pdf;*.jpg;*.png")
belegdaten = vtcapp.readinvoicedocument(kreditorbeleg)
lieferanten = vtcapp.getwithsqlbymember("Adresseintrag", "name", belegdaten.Name)
lieferant = lieferanten[0]
currency = vtcapp.getwithsqlbymember("Waehrung", "bezeichnung", belegdaten.Currency)[0]

kreditor=vtcapp.createobject("Kreditor")
kreditor.lieferant = lieferant

if not kreditor.documentdata:
    kreditor.documentdata = vtcapp.createobject("DocumentData")
kreditor.documentdata.data = kreditorbeleg

kreditor.esrteilnehmer = belegdaten.Account
kreditor.esrcode = belegdaten.Reference
kreditor.waehrung = currency
kreditor.betragbrutto = belegdaten.Amount

if hasattr(belegdaten, 'DocumentNumber'):
    kreditor.nummer = belegdaten.DocumentNumber

if hasattr(belegdaten, 'DocumentDate'):
    kreditor.datum = belegdaten.DocumentDate

if hasattr(belegdaten, 'DueDate'):
    kreditor.xfaelligdatum = belegdaten.DueDate

if len(kreditor.auslagen) == 1:
    outlay = kreditor.auslagen[0]
    outlay.anzahl = None
    outlay.xwertintfwbrutto = belegdaten['Amount']

registercallback(): string

Registriert auf dem Cloud Server einen Callback zum Übertragen eines Authentisierungscodes. Dieser wird z.B. bei der Authentisierung via OAuth benötigt. Rückgabewert ist ein zufällig generierter State-String, welcher beim Callback übergeben werden muss, damit dieser akzeptiert wird. Der Callback wird als http get Anfrage auf den Cloud Server durchgeführt, als Beispiel https://mein.vertec-cloud.com/callback?state=<statestring>&code=<authentisierungscode>. Die mit dem Callback übertragenen Parameter können anschliessend via vtcapp.querycallback abgefragt werden.

Beispielcode:

state=vtcapp.registercallback()
# nur zur Demonstration: der Aufruf sollte natürlich über einen OAuth Authentifizierungs Server gehen
vtcapp.executeurl("https://myserver.vertec-mobile.com/callback?State=%s&message=ASecretMessage" % state)
time.sleep(3.0) # kurz warten bis browser offen
values=vtcapp.querycallback(state)
print(values["message"])

rendertemplate(templateString, data): unicode string

Das templateString Argument kann ein String oder Unicode-String sein und kann Jinja2 spezifische Markups enthalten.

Zur Übergabe der Daten stehen als weitere Argumente der Funktion folgende Möglichkeiten zur Verfügung:

• Python Dictionary mit String-Werten als Keys. Definiert damit die im Template verfügbaren Variablen.
• Beliebige Anzahl von Keyword Argumenten, welche die im Template verfügbaren Variablen definieren.
• Kein weiteres Argument, das Template wird dann ohne Daten verarbeitet.

Die wichtisten Strukturen sind die folgenden:

• Ein Block ist mit {% ... %} eingefasst. Er enthält eine Control-Anweisung oder eine Variablen-Zuweisung.
  • {% if proj.code == "ABC" %} ... {% endif %}. Ein If Statement in einem Block wird verwendet, um einen Bereich des Templates konditional auszugeben. Ein if muss durch ein endif abgeschlossen werden. Optional ist auch ein {% else %} dazwischen erlaubt.
  • {% for proj in projects %} ... {% endfor %}. Ein for Statement erlaubt die Wiederholung (Iterierung) eines Template Bereichs. Muss durch endfor abgeschlossen werden.

• Eine Expression wird mit {{ ... }} abgetrennt. Eine Expression wird im Context des Templates ausgewertet und als String in die Ausgabe des Templates gemischt.

# Beispiel Code für Ausgabe einer Projektliste

templateText = """
My own projects
===============
{% for proj in projects %}
Project: {{ proj.code }}, {{ proj.beschrieb }}
{% endfor %}
===============
"""

projects = vtcapp.evalocl("timSession->first.login.eigProjekte")
rendered_text = vtcapp.rendertemplate(templateText, projects = projects)

print rendered_text

renewdatabaseindexstatistics()

vtcapp.renewdatabaseindexstatistics()

requestfilefromclient(dialogTitle: string, directory: string, filter: string [, fileName: string]): (filename, file)

Das Format kann pro Filter mehrere Dateitypen enthalten.

• dialogTitle: Titel des Dialogs
• directory: Pfad des im Dialog zu öffnenden Verzeichnisses. Falls es den Pfad nicht gibt, wird der Desktop angezeigt.
• filter: Filterausdruck, um die Auswahl von Dateien im Dialog einzugrenzen. Der Filterausdruck ändert sich mit Version 6.3.0.12, bitte Beispiele rechts beachten.
• fileName: Absoluter Pfad der hochzuladenden Datei. Dieser Parameter ist optional. Wird er angegeben, so wird in Versionen vor 6.5.0.11 kein Dialog angezeigt.
  Ab Vertec 6.5.0.11 erscheint ein Dialog, der den Benutzer darauf aufmerksam macht, dass Vertec diese Datei lesen will, was dieser mit Ja oder Nein quittieren kann. Bei Nein wird der Vorgang abgebrochen und eine Exception geworfen.

Die Methode gibt ein Tupel bestehend aus Dateinamen und Dateiinhalt zurück (vor Version 6.4.0.22 gibt die Methode gibt ein Tupel bestehend aus absolutem Dateipfad inkl. Dateinamen und dem Dateiinhalt zurück).

Die Maximalgrösse der hochzuladenden Datei beträgt 50 MB.
Es existiert eine Blacklist von Verzeichnissen, aus der keine Dateien angefordert werden dürfen, z.B. die Windows-Umgebungsvariable SYSTEMROOT (typischerweise C:\Windows).

Klickt der User im Dialog auf Abbrechen, erscheint in Python die Fehlermeldung: RuntimeError: The file upload was canceled by the user.

Web App

Wird ein clientseitiger Pfad angegeben (Parameter abspath), erscheint in der Web App eine Fehlermeldung.

Das Startverzeichnis (Parameter path) wird ignoriert.

In Versionen vor 6.4.0.8 kann der Datei-Dialog keinen benutzerdefinierten Dialogtitel anzeigen. Der Parameter title wird erst ab Version 6.4.0.8 berücksichtigt.

Beim Filter wird die Bezeichnung nicht angezeigt, es heisst lediglich "Alle unterstützen Typen (...)" und dann die Endungen jeweils einzeln.

vtcapp.requestfilefromclient("Hallo Welt", r"C:\MyDirectory", "Python|*.py|Text|*.txt|XML|*.xml")

1. Wildcard muss angegeben werden (*.py anstatt .py)
2. Filterausdruck besteht aus Filterpaaren, wobei jedes Filterpaar zwingend Name und Ausdruck benötigt.
3. Sowohl zwischen den Paaren als auch innerhalb eines Paars zwischen Name und Ausdruck müssen Pipes als Trennzeichen verwendet werden.
4. Im Falle mehrerer Dateiendungen müssen diese durch Semikola anstatt Kommata getrennt werden:

   vtcapp.requestfilefromclient("Hallo Welt", r"C:\MyDirectory", "Office Documents|*.docx;*.xlsx|Text|*.txt|XML|*.xml")
   Öffnet einen Dialog mit dem Titel "Hallo Welt" im Verzeichnis C:\MyDirectory, welcher den Upload von Office-, TXT- oder XML-Dateien erlaubt .

Es wird auch eine einfache Syntax unterstützt:

vtcapp.requestfilefromclient("Hallo Welt", r"C:\MyDirectory", "*.txt")
Öffnet einen Dialog mit dem Titel "Hallo Welt" im Verzeichnis C:\MyDirectory, welcher den Upload von TXT-Dateien erlaubt.

vtcapp.requestfilefromclient("Hallo Welt", r"C:\MyDirectory", "*.txt;*.xml")
Öffnet einen Dialog mit dem Titel "Hallo Welt" im Verzeichnis C:\MyDirectory, welcher den Upload von TXT- oder XML-Dateien erlaubt.

vtcapp.requestfilefromclient("", "", "", r"C:\MyDirectory\MyFile.txt")
Lädt die Datei hoch.

vtcapp.requestfilefromclient("Hallo Welt", r"C:\Windows\System32", "*.dll")
Wirft eine Fehlermeldung, da nicht auf dieses Verzeichnis zugegriffen werden darf

vtcapp.requestfilefromclient("", "", "", r"C:\Windows\System32\cmd.exe")
Wirft eine Fehlermeldung, da nicht auf dieses Verzeichnis zugegriffen werden darf

Variante vor Vertec 6.3.0.12:

vtcapp.requestfilefromclient("Hallo Welt", r"C:\MyDirectory", "Python|.py,Text|.txt,XML|.xml")
Öffnet einen Dialog mit dem Titel "Hallo Welt" im Verzeichnis C:\MyDirectory, welcher den Upload von PY-, TXT- oder XML-Dateien erlaubt.

roundcurrency(betrag, waehrung=None): float

Rundet den angegebenen Betrag unter Berücksichtigung der Systemeinstellung Projekt > Kaufmännische Rundungsregeln verwenden.

Wird optional eine Währung mitgegeben, wird zusätzlich der darauf eingetragene Wert Runden auf berücksichtigt.

Ohne Währungsangabe:

amount = argobject.total
vtcapp.roundcurrency(amount)
5105.89

Mit Währungsangabe:

amount = argobject.total
curr = argobject.waehrung
vtcapp.roundcurrency(amount, curr)
5105.9

search(term:string, [language:string, withsuggestions:boolean, datetimefrom: date, datetimeto:date, onlyactive:boolean]): SearchResult

Führt eine Volltextsuche in den indizierten Objekten durch.

• term: Der eigentliche Suchbegriff.
• language: Optional. Hier kann ein Länderkürzel für die Suche angegeben werden. Die Sprache wird nur berücksichtigt, wenn sie auch indiziert wird (siehe Systemeinstellungen Volltextsuche). Wird ein anderer Wert oder None übergeben, erfolgt die Suche in der Standardsprache. 
• withsuggestions: Optional. True oder False. Hier kann angegeben werden, ob ähnliche Begriffe berücksichtig werden sollen. Standard ist False.
• datetimefrom, datetimeto: Optional. Werden hier von- und/oder bis-Datum angegeben, werden die Resultate nach diesen Daten gefiltert.

• onlyactive: Optional, ab Version 6.8.0.3. True oder False. Damit kann definiert werden, ob nur aktive oder auch inaktive Objekte gefunden werden sollen. Standardmässig werden über die Suche nur aktive Objekte angezeigt. Der Standard dieser Funktion ist also True. Um auch inaktive Objekte anzuzeigen, muss diese Eigenschaft auf False gesetzt werden.

Die Methode verwendet Keyword Arguments, die optionalen Parameter können also wie folgt übergeben werden:

• Ohne Keyword, dann muss die Reihenfolge eingehalten werden:

  vtcapp.search("keller", "EN", False)

• Mit Keyword (= Parametername), dann spielt die Reihenfolge keine Rolle:

  vtcapp.search("keller", "EN", onlyactive=True, datetimeto=vtcapp.currentdate())

Zurückgegeben wird ein Python Objekt vom Typ SearchResult. Dieses enthält folgende Eigenschaften:

• objects: Alle mit der Suche gefundenen Businessobjekte (als BoldObjectListAdapter).
• totalhitsapprox: Anzahl der gefundenen Resultate.
• items: Liste von SearchResultItems mit folgenden Eigenschaften:
  • object: Das einzelne Businessobjekt
  • score: Relevanzwert
  • fields: Fundort (in English)
  • date: Datum aus dem Index
  • fragments: Liste von Textfragmenten.

Eine Suche gibt maximal 500 Businessobjekte aus (SearchResultItems). Diese sind absteigend sortiert nach Relevanz (score).

results = vtcapp.search("keller", "EN", False, datetimeto=vtcapp.currentdate())
for item in results.items:
    print item, item.fragments

Mit .objects bekommt man direkt eine Liste von Vertec Objekten. 

results = vtcapp.search("consulting")
projects = results.objects.evalocl("self->select(oclIsTypeOf(Project))")

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.

proj = vtcapp.getobjectbyentryid("Projekt", "TemplateProject")
scripttext = vtcapp.evalocl("scripteintrag->select(bezeichnung='Projekt kopieren')->first.scripttext")
vtcapp.scriptexecute(scripttext, proj)

selectaddress()

selectphase()

selectproject()

selectobjectintree()

Ab Version 6.4.0.21. Ermöglicht den Aufruf der verschiedenen Such- und Auswahldialoge für Adressen, Projekte, Phasen und den Baum direkt aus Python.

Die Methoden unterstützen die folgenden optionalen Keyword Argumente:

• selectaddress(string title, string classname, string filter)
  • title: Dialog Titel (Default: Adressen auswählen)
  • classname: Adressklasse, in der gesucht wird, z.B Firma. (Default: Adresseintrag)
  • filter: Zusätzliche SQL Filter Bedingung (Default: leer), z.B. nur auf aktive Objekte
  Der Suchdialog für Adressen verwendet die Standard-Suchdefinition gemäss Systemeinstellungen.
• selectphase(string title, string filter)
  • title: Dialog Titel (Default: Phasen auswählen)
  • filter: Zusätzliche SQL Filter Bedingung (Default: leer), z.B. nur auf aktive Objekte
• selectproject(string title, string filter)
  • title: Dialog Titel (Default: Projekte auswählen)
  • filter: Zusätzliche SQL Filter Bedingung (Default: leer), z.B. nur auf aktive Objekte
• selectobjectintree(string title, list entrylist, string browsefilter, string selectfilter)
  • title: Dialog Titel (Default: Objekte auswählen)
  • entrylist: Liste von Vertec Objekten, welche im Dialog als Root Elemente dargestellt werden.
  • browsefilter: Komma-delimited Filter für Objekttypen (z.B Ordner, Expressionordner)
  • selectfilter: Der Selectfilter bestimmt, auf welchen Einträgen (Klassen und deren Subklassen) man den Dialog bestätigen kann und somit "auswählt", auch Komma-delimited.

Rückgabewert ist das ausgewählte Objekt.

adresse= vtcapp.selectaddress(title="Adressauswahl", classname="Kontakt", filter="vorname like '%S%'")

projekt = vtcapp.selectproject(title="Projektauswahl", filter="code like '%S%'")

phase= vtcapp.selectphase(title="Phasenauswahl", filter="code like '%S%'")

Kontakte = argobject.subordner
Kontaktordner = list(Kontakte)
Kontaktordner.append(argobject)
selected=vtcapp.selectobjectintree("Objekt wählen",Kontaktordner, "Ordner, Kontakt", selectfilter="Kontakt")

selectfromlist (caption: string, text: string, col1caption: string, col2caption: string, default: string, list: list of tuple): string

• caption: Titel des Forms
• text: Einleitungstext
• col1caption: Spaltentitel 1
• col2caption: Spaltentitel 2
• default: Standard Rückgabewert bzw. vorselektierte Zeile *)
• list: Liste mit den Werten, die zur Auswahl angezeigt werden

*) Um eine Zeile vorzuselektieren, müssen die Tuples der Listenzeilen aus 3 Elementen bestehen. Das dritte Element ist dann der Rückgabewert, wenn die Zeile ausgewählt wird (diese dritte Spalte ist unsichtbar).

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

*) vtcapp.selectfromlist("","","","","2",[("one","eins","1"),("two","zwei","2")])

sendfile(file: string, filename: string, [showsavedialog: boolean], [openfile: boolean]): boolean

Sendet eine Datei oder einen String (als Datei) an einen Client.

Die Methode funktioniert auch im Restrict Scripting Modus.

• file: Hier kann ein String als Dateiinhalt oder ein Python Datei-Object übergeben werden.
• filename: Name der Datei, falls es gespeichert wird.
• showsavedialog: Optional. Standard = False. Desktop und Cloud App. Die übertragene Datei soll auf dem Client je nach Anforderung und Möglichkeiten des Clients gespeichert oder gleich ausgeführt werden.
  Ein gesetztes showsavedialog Argument bewirkt, dass ein Speichern-Dialog angezeigt wird. Standardmässig wird dabei der Desktop als Speicherort angezeigt.
  Falls showsavedialog=false ist, wird die Datei im Temp-Folder des Clients gespeichert, eine bestehende Datei wird dabei überschrieben. Das ist sinnvoll im Zusammenhang mit openfile=true, dann wird die Datei in Temp gespeichert und gleich geöffnet.

Ab Vertec 6.5.0.11 ist das Unterdrücken eines Dialogs nur noch für die folgenden Dateitypen (Endungen) möglich. Whitelist:

.doc, .docx, .xls, .xlsx, .pdf, .csv, .txt, .zip, .png, .jpg, .jpeg, .bmp, .gif, .eml und ab Vertec 6.5.0.15 .ics.
Bei allen Dateitypen, die sich nicht auf dieser Whitelist befinden, erscheint eine Fehlermeldung.

• openfile: Optional. Desktop und Cloud App. Wenn true, wird die Datei nach dem Speichern geöffnet. Standard ist true.

Die Kombination showsavedialog=false und openfile=false ist nicht sinnvoll, da so die Datei im Temp-Verzeichnis gespeichert wird und sonst nichts passiert.

Mit der Web App als Client erscheint die Datei immer als Download im Webbrowser. Die Argumente showsavedialog und openfile haben keine Bedeutung.

Die Methode hat einen Rückgabewert und liefert True oder False zurück:

• True, falls die Datei gespeichert wurde,
• False, falls die Datei nicht gespeichert wurde,
• Die Web App liefert immer True zurück, da dort nicht überprüft werden kann, ob die Datei gespeichert wurde. Bei der Verwendung der Web App empfehlen wir, im Browser den automatischen Download einzuschalten.

Beispiel eines einfachen Projektexports:

projekte = argobject.evalocl("eintraege.list")
projektstr = ""
for projekt in projekte:
    projektstr += projekt.code + "\r\n"
vtcapp.sendfile(projektstr, 'projekte.txt', True, True)

Beispiel wie ein lokal vorliegendes Bild geschickt werden kann:

filename = r"C:\Arbeitsverzeichnis\python_editor.png"
# opening for [r]eading as [b]inary
with open(filename, 'rb') as afile:
    vtcapp.sendfile(afile, 'aFilenameHere.jpg', True, True)

Dateien sollten explizit geschlossen werden nach Gebrauch. Ansonsten werden sie erst vom Garbage Collector geschlossen oder im Fehlerfall sogar erst bei der nächsten Exception. Es wird empfohlen, open mit with zu verwenden wie im obigen Beispiel.

sendmail(to, subject, body, [cc, bcc, fromSender, attachments])

Ermöglicht den E-Mail-Versand aus Vertec mit den unter Systemeinstellungen E-Mail beschriebenen Voraussetzungen. Die Methode kann mit allen Apps verwendet werden.

• to: String. Empfängeradressen.
  • Mithilfe eines Semikolon ; können auch mehrere Adressen angegeben werden, ohne Abstand zwischen den Adressen und dem Semikolon.
• subject: String. Betreff der E-Mail.
• body:
  • String: Der eigentliche E-Mail-Text. Kann HTML oder plaintext sein. HTML wird als solches erkannt und dann in Form einer Outlook HTML Mail erstellt.
  • Ab Version 6.5.0.21 kann auch ein Word-Dokument verwendet werden (siehe Beispiel unten).

Optional:

• fromSender: String. falls null oder leer wird der Absender aus den Systemeinstellungen genommen. Berechtigungen etc. werden nicht überprüft, es muss sichergestellt werden, dass der User berechtigt ist, unter diesem Absender E-Mails zu versenden, sonst funktioniert das clientseitig nicht.
  • Hinweis: kann im Cloud Abo ohne eigenen SMTP nicht übersteuert werden.
• cc: String. Falls befüllt als CC Empfänger.
• bcc: String. Falls befüllt als BCC Empfänger.
• attachment: [(Name der Datei, Inhalt)]: Falls ausgefüllt, wird der Anhang an die E-Mail angehängt.

Beispiele:

• Einfachster Fall, Body als String: 

vtcapp.sendmail("dokumentation@vertec.com", "Dokumentation", "Dies ist der einfachste Fall")

• Verwendung von Word-Dokumenten als Body:
  Hinweis: Verwenden Sie in Ihren Word-Dokumenten Tabellen und vermeiden Sie Tabstopps, da diese im E-Mail nicht verarbeitet werden können.

1. Das entsprechende Word-Dokument muss erstellt und gelesen werden:

in_file = open("C:\<yourPath>\BeispielWordFürEmail.docx", "rb")
dataFileData = in_file.read()

2. Mit der Methode die E-Mail generieren: 

vtcapp.sendmail('dokumentation@vertec.com', 'Test E-Mail from Word', dataFileData)

setpropertyvalue(name, value)

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

vtcapp.setpropertyvalue('Sperrdatum', vtcapp.incmonth(vtcapp.currentdate(), -1))

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

Nur Vertec Versionen vor 6.6. Ab Vertec Version 6.6 verwenden Sie dafür die setresourceplanvalue Methoden auf Bearbeitern, Projekten oder Projektphasen.

Setzt einen Ressourcenplanwert.

• 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.

bearbeiter = vtcapp.currentlogin()
projekt = argobject

vtcapp.setresourceplanvalue(bearbeiter, projekt, None, vtcapp.firstdayofmonth(vtcapp.currentdate()), 0, 240)

showcustomdialog(dialogdefinition, initialwerte)

Dialog-Funktion, mit welcher in Python Scripts Dialoge definiert und vom Script angezeigt werden können.

showdetailform(obj: object)

leistung = vtcapp.createobject("Offeneleistung")
vtcapp.showdetailform(leistung)

standardprocessbi()

Methode für die Brechnung von BI Daten für das Business Intelligence Modul.

Entspricht der Durchführung der standardmässig mitgelieferten geplanten Aufgabe und löst die Berechnung aller Generatoren auf allen aktiven Kennzahlen aus.

Benötigt Administrator-Rechte.

Für die Berechnung einzelner Generatoren siehe die Methode vtcapp.processbi() weiter oben.

vtcapp.standardprocessbi()

strtominutes(string): integer

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

sqldateliteral(datum: date): string

aktivitaeten = vtcapp.getwithsql('Aktivitaet', 'datum = %s' % vtcapp.sqldateliteral(vtcapp.currentdate()), '')
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): string

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 Klausel mit einem Datumsintervall, passend auf den aktuell verwendeten Datenbankserver, welche dann in ein getwithsql Statement eingebaut werden kann.

heute = vtcapp.currentdate()
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
>>> 

syncpayments()

Ab Version 6.4.0.22. Führt einen globalen Zahlungsabgleich durch.

Falls keine Debitorenschnittstelle mit Zahlungsabgleich installiert ist, meldet die Methode einen Fehler.

vtcapp.syncpayments()

Die Methode kann beispielsweise als geplante Aufgabe registriert werden.

SystemContext()

Ab Version 6.6.

Aktiviert innerhalb des Scripts die erweiterten Berechtigungen.

• Muss mit dem with-Statement aufgerufen werden.
• Ist im Python-Editor aus Sicherheitsgründen nicht erlaubt.

with vtcapp.SystemContext():
    ...Code der vom Systemcontext profitiert.

translate(txt: string[, language:string]): string

Übersetzt einen GUI Text in die aktuelle Vertec Sprache.

Die aktuelle Vertec-Sprache ist English:

>>> vtcapp.translate("Leistung")
Service

Ab Version 6.5.0.20:

>>> vtcapp.translate('Offer', 'DD')
Angebot

updatedatabase()

vtcapp.updatedatabase()

validateobjects()

Validiert neuerstelle Objekte. Diese sind, sofern sie keine Regeln verletzen, danach nicht mehr ungültig.

vtcapp.validateobjects()

versiontointeger(versionstring): int

Bsp: "5.5.0.67" wird in 550067 umgesetzt, 
"5.5" in 550000, 
"5" in 500000