Vertec Python module “vtcmodel”

The Vertec Python Module vtcmodel allows to query information about the data model behind the business objects. It is also available in Resctict Scripting mode and includes the method:

vtcmodel.gettypeinfo(object): Typeinfo

• object: A single Vertec object or as of Vertec 6.8.0.12 also a class name as a string
  • Case insensitive
  • The English or German class name can be used regardless of the current Model Language  

Gets the information of the given Vertec object or class and returns a Typeinfo Python object.

The Typeinfo object has the following properties:

The Member object has the following properties:

Members can be both attributes (normal fields) and associations (links to other objects). Depending on whether it is an attribute or an association, the Member object has slightly different properties. This is noted in the respective row.  

Some of these properties can also be seen in the Vertec Model Browser on the right hand side when you select a member in the list.    

Example script

The example script can be run on a project in the Vertec Script Editor.  

import vtcmodel

typeinfo = vtcmodel.gettypeinfo(argobject) # argobject is a project
print("Class name (actual model language): {}".format(typeinfo.name)) # Projekt/Project
print("Class name (model): {}".format(typeinfo.defaultname)) # Project
print("Stored in DB: {}".format(typeinfo.persistent)) # True

members = typeinfo.members # List of all "member" objects

member = typeinfo.memberbyname("Active") # Info about member "active"
print("Member name (actual model language): {}".format(member.name)) # aktiv/active
print("Member name (model): {}".format(member.defaultname)) # active
print("Value type: {}".format(member.valuetype)) # Boolean (string)
print("Stored in DB: {}".format(member.persistent)) # True
print("Derived: {}".format(member.derived)) # False
print("Null/Empty allowed: {}".format(member.allownull)) # False
print("Is attribute: {}".format(member.isattribute)) # True
print("Is Linkrole / Association: {}".format(member.isrole)) # False
print("Is single role: {}".format(member.issinglerole)) # False
print("Is multi role: {}".format(member.ismultirole)) # False
print("Column name in DB: {}".format(member.columnname)) # Active
print("Length: {}".format(member.length)) # 255, only relevant on Strings
print("Backlink on 'Project' ClassInfo: {}".format(member.classinfo.name)) # Projekt/Project

role_member = typeinfo.memberbyname("Customer") # Info about the association to the customer
# Attributes like above, except for "valuetype" and "derived", instead:
print("Link class: {}".format(role_member.linkclass)) # None
print("Ordered: {}".format(role_member.ordered)) # True
print("Name of the member on the other side: {}".format(role_member.otherend.name)) # projekte/projects