enums

class Enum[source]

Custom enumeration class to support class attributes as options.

Example

>>> class Toppings(Enum):
...    CHEESE = "Cheese"
...    SALAMI = "Salami"
>>> topping_choice = Toppings.CHEESE
classmethod options()[source]

Provide a sorted list of options.

classmethod values()[source]

Provide a (sorted) list of values.

class Multiplicity[source]

The various multiplicities that are accepted by KE-chain.

For more information on the representation in KE-chain, please consult the KE-chain Part documentation.

Variables
  • ZERO_ONE – Multiplicity 0 to 1

  • ONE – Multiplicity 1

  • ZERO_MANY – Multiplicity 0 to infinity

  • ONE_MANY – Multiplicity 1 to infinity

class Category[source]

The various categories of Parts that are accepted by KE-chain.

For more information on the representation in KE-chain, please consult the KE-chain Part documentation.

Variables
  • INSTANCE – Category of Instance

  • MODEL – Category of Model

class Classification[source]

The various classification of Parts that are accepted by KE-chain.

For more information on the representation in KE-chain, please consult the KE-chain Part documentation.

Variables
  • PRODUCT – Classification of the part object is Product

  • CATALOG – Classification of the part object is a CATALOG

class PropertyType[source]

The various property types that are accepted by KE-chain.

For more information on the representation in KE-chain, please consult the KE-chain Property documentation.

Variables
  • CHAR_VALUE – a charfield property (single line text)

  • TEXT_VALUE – text property (long text, may span multiple lines)

  • BOOLEAN_VALUE – a boolean value property (True/False)

  • INT_VALUE – integer property (whole number)

  • FLOAT_VALUE – floating point number property (with digits)

  • DATETIME_VALUE – a datetime value property

  • ATTACHMENT_VALUE – an attachment property

  • LINK_VALUE – url property

  • REFERENCE_VALUE – a reference property, a UUID value referring to other part model

New in version 1.14.

Variables
  • SINGLE_SELECT_VALUE – single select list property (choose from a list)

  • REFERENCES_VALUE – a multi reference property, a list of UUID values referring to other part models

New in version 3.6.

Variables
  • ACTIVITY_REFERENCES_VALUE – Activity References Property

  • SCOPE_REFERENCES_VALUE – Scope References Property

  • SERVICE_REFERENCES_VALUE – Service Referenes Property

  • TEAM_REFERENCES_VALUE – Team References Property

  • USER_REFERENCES_VALUE – User References Property

  • FORM_REFERENCES_VALUE – Form References Property

  • CONTEXT_REFERENCES_VALUE – Context References Property

  • JSON_VALUE – Generic JSON storage Property

  • GEOJSON_VALUE – GEOJSON property to store map data

  • WEATHER_VALUE – Weather JSON property compatible with the response of weatherapi.com

  • DATE_VALUE – Date value

  • TIME_VALUE – Time value

  • DURATION_VALUE – Duration value

New in version 3.19.

Variables

STATUS_REFERENCES_VALUE – Status References Property

class ActivityType[source]

The various Activity types that are accepted by KE-chain.

New in version 2.0.

Variables
  • TASK – a normal task

  • PROCESS – a subprocess (container) containing other tasks

class ActivityClassification[source]

The classification of Activities that are accepted by KE-chain.

New in version 2.0.

Changed in version 3.2: Add ‘APP’ environment for KE-chain versions > 3.1

Changed in version 3.14: Add ‘FORM’ envornment for KE-chain versions > v2021.10

Variables
  • WORKFLOW – Classification of the activity is WORKFLOW

  • CATALOG – Classification of the activity is CATALOG

  • APP – Classification of the activity is APP

  • FORM – Classification of the activity is FORM

class ActivityRootNames[source]

The classification of Activities that are accepted by KE-chain.

New in version 2.0.

Changed in version 3.2: Add ‘APP’ environment for KE-chain versions > 3.1

Changed in version 3.14: Add ‘FORM’ environment for KE-chain versions >= v2021.10

Variables
  • WORKFLOW_ROOT – Root of the activity is WORKFLOW_ROOT

  • CATALOG_ROOT – Root of the activity is CATALOG_ROOT (below are CATALOG tasks)

  • APP_ROOT – Root of the activity is APP_ROOT (below are APP ‘tasks’ ie. ‘screems’)

class WidgetNames[source]

The various Names of the Widget that can be configured.

Changed in version 3.14: Added FORMMETAPANEL for KE-chain versions >= v2021.10

Variables
  • SUPERGRIDWIDGET – superGridWidget

  • PROPERTYGRIDWIDGET – propertyGridWidget

  • HTMLWIDGET – htmlWidget

  • FILTEREDGRIDWIDGET – filteredGridWidget

  • SERVICEWIDGET – serviceWidget

  • NOTEBOOKWIDGET – notebookWidget

  • ATTACHMENTVIEWERWIDGET – attachmentViewerWidget

  • TASKNAVIGATIONBARWIDGET – taskNavigationBarWidget

  • JSONWIDGET – jsonWidget

# KE-chain 3 only :cvar SIGNATUREWIDGET: signatureWidget :cvar CARDWIDGET: cardWidget :cvar METAPANELWIDGET: metaPanelWidget :cvar FORMMETAPANEL: formMetaPanelWidget :cvar MULTICOLUMNWIDGET: multiColumnWidget :cvar PROGRESSWIDGET: progressWidget :cvar TASKSWIDGET: tasksWidget :cvar SERVICECARDWIDGET: serviceCardWidget :cvar DASHBOARDWIDGET: ‘dashboardWidget’ :cvar SCOPEMEMBERS: ‘scopeMembersWidget’

class WidgetTypes[source]

The various widget types for the widget definitions available to the widget api.

Changed in version 3.14: Added FORMMETAPANEL for KE-chain versions >= v2021.10

Variables
  • UNDEFINED – Undefined Widget

  • PROPERTYGRID – Propertygrid widget

  • SUPERGRID – Supergrid widget

  • HTML – Html widget

  • FILTEREDGRID – Filteredgrid widget

  • SERVICE – Service widget

  • NOTEBOOK – Notebook widget

  • ATTACHMENTVIEWER – Attachmentviewer widget

  • TASKNAVIGATIONBAR – Tasknavigationbar widget

  • JSON – Json widget

  • METAPANEL – Metapanel widget

  • FORMMETAPANEL – The FormMetapanel widget

  • MULTICOLUMN – Multicolumn widget

  • SCOPE – Scope widget

  • THIRDPARTY – Thirdparty widget

  • PROGRESS – Progress widget

  • SIGNATURE – Signature widget

  • CARD – Card widget

  • TASKS – Tasks widget

  • WEATHER – Weather widget

  • SERVICECARD – Servicecard widget

  • DASHBOARD – Dashboard widget

  • SCOPEMEMBERS – Scopemembers widget

class ActivityStatus[source]

The various Activity statuses that are accepted by KE-chain.

Variables
  • OPEN – status of activity is open

  • COMPLETED – status of activity is completed

class ScopeStatus[source]

The various status of a scope.

Changed in version 3.0: The TEMPLATE ScopeStatus is deprecated in KE-chain 3

Variables
  • ACTIVE – Status of a scope is active (default)

  • CLOSED – Status of a scope is closed

  • TEMPLATE – Status of a scope is a template (not actively used)(deprecated in KE-chain 3.0)

  • DELETING – Status of a scope when the scope is being deleted

class ScopeCategory[source]

The various categories of a scope.

Variables
  • LIBRARY_SCOPE – The scope is a library scope

  • USER_SCOPE – The scope is a normal user scope

  • TEMPLATE_SCOPE – The scope is a template scope

class ServiceType[source]

The file types of sim script.

Variables
  • PYTHON_SCRIPT – service is a python script

  • NOTEBOOK – service is a jupyter notebook

class ServiceEnvironmentVersion[source]

The acceptable versions of python where services run on.

Variables
  • PYTHON_3_6 – Service execution environment is a python 3.6 container (unsupported)

  • PYTHON_3_7 – Service execution environment is a python 3.7 container

  • PYTHON_3_8 – Service execution environment is a python 3.8 container

  • PYTHON_3_9 – Service execution environment is a python 3.9 container

  • PYTHON_3_10 – Service execution environment is a python 3.10 container

  • PYTHON_3_6_NOTEBOOKS – execution environment is a python 3.6 container with jupyter notebook preinstalled (unsupported)

  • PYTHON_3_8_NOTEBOOKS – execution environment is a python 3.8 container with jupyter notebook preinstalled

  • PYTHON_3_9_NOTEBOOKS – execution environment is a python 3.9 container with jupyter notebook preinstalled

  • PYTHON_3_10_NOTEBOOKS – execution environment is a python 3.10 container with jupyter notebook preinstalled

class ServiceScriptUser[source]

The acceptable usertypes under which a (trusted) service is run.

Variables
  • KENODE_USER – Run as “kenode” user. Equivalent to a manager in a scope.

  • TEAMMANAGER_USER – Run as “kenode_team”. Equivalent to a manager in a team. (disabled until available)

  • CONFIGURATOR_USER – Run as “kenode_configurator”. Equivalent to GG:Configurator.

class ServiceExecutionStatus[source]

The acceptable states of a running service.

Variables
  • LOADING – Execution is in LOADING state (next RUNNING, FAILED)

  • RUNNING – Execution is in RUNNING state (next COMPLETED, FAILED, TERMINATING)

  • COMPLETED – Execution is in COMPLETED state

  • FAILED – Execution is in FAILED state

  • TERMINATING – Execution is in TERMINATING state (next TERMINATED)

  • TERMINATED – Execution is in TERMINATED state

class TeamRoles[source]

Roles that exist for a team member.

Variables
  • MEMBER – A normal team member

  • MANAGER – A team member that may manage the team (add or remove members, change team)

  • OWNER – The owner of a team

class ScopeRoles[source]

Roles that exist for a member of a scope.

Variables
  • MANAGER – owner of the scope, has full rights

  • SUPERVISOR – supervisor member of a scope, has the rights as leadmember and rights to manage catalog tasks.

  • LEADMEMBER – elevated member, has assignment rights, no rights on App tasks or Catalog tasks.

  • MEMBER – normal member, only has viewing rights

class ScopeMemberActions[source]

Actions to be performed on the members of a scope.

Variables
  • ADD – add a member to the scope

  • REMOVE – delete a member from the scope

class ContextType[source]

Types of Contexts.

Variables
  • STATIC_LOCATION – Geolocation / Featurecollection context with a geolocation.

  • TIME_PERIOD – Time Period Context with start_date and due_date

  • TEXT_LABEL – generic textual label

class ContextGroup[source]

Context may have a context_group.

..versionadded: 3.11

This is for context API versions 1.2.0 or later.

Variables
  • UNDEFINED – UNDEFINED

  • DISCIPLINE – Discipline, in nl: Discipline

  • ASSET – Asset, in nl: Object, Kunstwerk

  • DEPARTMENT – Department, in nl: Onderdeel, Afdeling

  • PERIOD – Workperiod, in nl: Werkperiode

  • LOCATION – Location, in nl: Locatie

  • PHASE – Phase, in nl: Fase

  • REQUIREMENT – Requirement, in nl: Eis

  • EXTERNALID – External identifier, to be used to provide a generic link to an external application

  • WORKPACKAGE – Workpackage, in nl: Werkpakket

class KechainEnv[source]

Environment variables that can be set for pykechain.

Variables
  • KECHAIN_URL – full url of KE-chain where to connect to eg: ‘https://<some>.ke-chain.com’

  • KECHAIN_TOKEN – authentication token for the KE-chain user provided from KE-chain user account control

  • KECHAIN_USERNAME – the username for the credentials

  • KECHAIN_PASSWORD – the password for the credentials

  • KECHAIN_SCOPE – the name of the project / scope. Should be unique, otherwise use scope_id

  • KECHAIN_SCOPE_ID – the UUID of the project / scope.

  • KECHAIN_FORCE_ENV_USE – set to ‘true’, ‘1’, ‘ok’, or ‘yes’ to always use the environment variables.

  • KECHAIN_SCOPE_STATUS – the status of the Scope to retrieve, defaults to None to retrieve all scopes

  • KECHAIN_CHECK_CERTIFICATES – if the certificates of the URL should be checked.

class SortTable[source]

The acceptable sorting options for a grid/table.

Variables
  • ASCENDING – Table is sorted in ASCENDING ORDER

  • DESCENDING – Table is sorted in DESCENDING ORDER

class Alignment[source]

The alignment options for attachment viewer, navigation bar widgets and service widgets.

Variables
  • LEFT – Aligned to the left

  • CENTER – Aligned to the center

  • RIGHT – Aligned to the right

class NavigationBarAlignment[source]

The acceptable alignment options for a Navigation Bar Widget.

class SidebarItemAlignment[source]

The acceptable alignment options for sidebar button.

Variables
  • TOP – “top”

  • BOTTOM – “bottom”

class SidebarButtonAlignment[source]

Compatibility enumeration class for the SidebarItemAlignment.

class SidebarType[source]

The types that can exist as a Sidebar Item.

Variables
  • BUTTON – a button,

  • CARD – a card

class PaperSize[source]

The acceptable paper sizes options for a downloaded PDF.

Variables
  • A0 – Paper of size A0

  • A1 – Paper of size A1

  • A2 – Paper of size A2

  • A3 – Paper of size A3

  • A4 – Paper of size A4

class PaperOrientation[source]

The acceptable paper orientation options for a downloaded PDF.

Variables
  • PORTRAIT – Paper of orientation ‘portrait’

  • LANDSCAPE – Paper of orientation ‘landscape’

class PropertyVTypes[source]

The VTypes (or validator types) that are allowed in the json.

This corresponds to the various validator classes which SHOULD be named:

vtype[0].upper() + vtype[1:] eg: ‘numbericRangeValidator’ has an implementation class of ‘NumericRangeValidator’

New in version 2.2.

Variables
  • NONEVALIDATOR – noneValidator - No validation is done

  • NUMERICRANGE – numericRangeValidator

  • BOOLEANFIELD – booleanFieldValidator

  • REQUIREDFIELD – requiredFieldValidator

  • EVENNUMBER – evenNumberValidator

  • ODDNUMBER – oddNumberValidator

  • REGEXSTRING – regexStringValidator

  • SINGLEREFERENCE – ‘singleReferenceValidator’

  • FILEEXTENSION – ‘fileExtensionValidator’

  • FILESIZE – ‘fileSizeValidator’

class ValidatorEffectTypes[source]

The effects that can be attached to a validator.

New in version 2.2.

Variables
  • NONE_EFFECT – noneEffect

  • VISUALEFFECT – visualEffect

  • TEXT_EFFECT – textEffect

  • ERRORTEXT_EFFECT – errorTextEffect

  • HELPTEXT_EFFECT – helpTextEffect

class PropertyRepresentation[source]

The Representation configuration to display a property value.

New in version 3.0.

Changed in version 3.11: added geocoordinate in line with KE-chain v2021.5.0

Variables
  • DECIMAL_PLACES – Amount of decimal places to show the number

  • SIGNIFICANT_DIGITS – Number (count) of significant digits to display the number

  • LINK_TARGET – configuration of a link to open the link in a new browsertab or not.

  • BUTTON – options to represent the choices of a select-list

  • THOUSANDS_SEPARATOR – option to display the thousand separator

  • AUTOFILL – option to autofill the content of the property

  • GEOCOORDINATE – option to display an alternative representation for the geocoordinate

  • USE_PROPERTY_NAME – option to display the name of a property for a part actvity ref prop

class GeoCoordinateConfig[source]

GeoCoordinate Configuration Enumerations.

Variables
  • APPROX_ADDRESS – represent the coordinate as approximate address (lookup by Google)

  • RD_AMERSFOORT – represent the coordinate as Amersfoort / RN New (epsg: 28992)

  • DD – represent the coordinate as Decimal Degrees (WGS84, epsg:4326)

  • DMS – represent the coordinate as as Degrees Minutes Seconds (WGS84, epsg:4326)

class OtherRepresentations[source]

Other representations used in KE-chain.

Variables

CUSTOM_ICON – different font-awesome icons

class ShowColumnTypes[source]

The columns that can be shown in a Property grid.

New in version 2.3.

Variables
  • UNIT – unit

  • DESCRIPTION – description

class ScopeWidgetColumnTypes[source]

The columns that can be shown in a Scope widget grid.

New in version 3.0.

Variables
  • PROJECT_NAME – Name

  • START_DATE – Start date

  • DUE_DATE – Due date

  • PROGRESS – Progress

  • STATUS – Status

  • TAGS – Tags

class FilterType[source]

The type of pre-filters that can be set on a Multi Reference Property.

New in version 3.0.

Variables
  • GREATER_THAN_EQUAL – ‘gte’

  • LOWER_THAN_EQUAL – ‘lte’

  • CONTAINS – ‘icontains’

  • EXACT – ‘exact’

class ProgressBarColors[source]

Some basic colors that can be set on a Progress Bar inside a Progress Bar Widget.

New in version 3.0.

Variables
  • BLACK – ‘#000000’

  • WHITE – ‘#FFFFFF’

  • RED – ‘FF0000’

  • LIME – ‘#00FF00’

  • BLUE – ‘#0000FF’

  • YELLOW – ‘#FFFF00’

  • CYAN – ‘#00FFFF’

  • MAGENTA – ‘#FF00FF’

  • SILVER – ‘#C0C0C0’

  • GRAY – ‘#808080’

  • MAROON – ‘#800000’

  • OLIVE – ‘#808000’

  • GREEN – ‘#008000’

  • PURPLE – ‘#800080’

  • TEAL – ‘#008080’

  • NAVY – ‘#000080’

  • DEFAULT_COMPLETED – ‘#339447’

  • DEFAULT_IN_PROGRESS – ‘#FF6600’

  • DEFAULT_NO_PROGRESS – ‘#EEEEEE’

  • DEFAULT_IN_PROGRESS_BACKGROUND – ‘#FC7C3D’

class LinkTargets[source]

Target for the CardWidget link and Link property representations.

New in version 3.0.

Variables
  • SAME_TAB – “_self”

  • NEW_TAB – “_blank”

class CardWidgetLinkTarget[source]

Target for the CardWidget, remaining for backwards compatibility.

class CardWidgetLinkValue[source]

Link Value for the CardWidget.

New in version 3.0.

Variables
  • EXTERNAL_LINK – “External link”

  • TASK_LINK – “Task link”

  • NO_LINK – “No link”

class CardWidgetImageValue[source]

Image for the CardWidget.

New in version 3.0.

Variables
  • CUSTOM_IMAGE – “Custom image”

  • NO_IMAGE – “No image”

class KEChainPages[source]

URL names of built-in KE-chain pages.

Variables
  • DETAIL – “detail”

  • FORMS – “forms”

  • TASKS – “activities”

  • WORK_BREAKDOWN – “activitytree”

  • CATALOG_FORMS – “catalogforms”

  • CONTEXTS – “contexts”

  • WORKFLOWS – “workflows”

  • DATA_MODEL – “productmodel”

  • EXPLORER – “product”

  • SERVICES – “scripts”

class SubprocessDisplayMode[source]

URL variations to vary the display of a subprocess activity.

Variables
  • ACTIVITIES – “activities”

  • TREEVIEW – “treeview”

class URITarget[source]

Side-bar button redirect options.

Variables
  • INTERNAL – “internal”

  • EXTERNAL – “external”

  • NEW – “_new”

  • SELF – “_self”

  • BLANK – “_blank”

  • PARENT – “_parent”

  • TOP – “_top”

class FontAwesomeMode[source]

Options to display the same icon.

Source: https://fontawesome.com/how-to-use/on-the-web/setup/getting-started

Variables
  • SOLID – “solid”

  • REGULAR – “regular”

  • LIGHT – “light”

class SidebarAccessLevelOptions[source]

Options for access level options for the sidebar.

Variables
  • IS_MEMBER – “is_member”

  • IS_LEAD_MEMBER – “is_leadmember”

  • IS_SUPERVISOR – “is_supervisor”

  • IS_MANAGER – “is_manager”

class MinimumAccessLevelOptions[source]

Options for minumum access level options for the sidebar.

class MaximumAccessLevelOptions[source]

Options for maximum access level options for the sidebar.

class SelectListRepresentations[source]

Options in which a single-select list property options are displayed.

Variables
  • DROP_DOWN – “dropdown”

  • CHECK_BOXES – “checkboxes”

  • BUTTONS – “buttons”

class ImageFitValue[source]

Options to fit an image on a CardWidget or AttachmentViewerWidget.

This is a subset from the object-fit property in HTML.

Variables
  • CONTAIN – scale the image to fit within the widget

  • COVER – scale the image to cover the entire widget

class WidgetTitleValue[source]

Options to configure the title of a widget.

Variables
  • DEFAULT – Use the default title of the widget type.

  • NO_TITLE – Show no title.

  • CUSTOM_TITLE – Show a custom title text.

class NotificationStatus[source]

Options to retrieve a Notification based on its status.

normal lifecycle: - DRAFT, when a message is first saved to the backend and the status is still in draft.

next states: READY

  • READY: when the message is ready for processing, it is complete and is to be processed

    next states: PROCESSING

  • PROCESSING: when the message is in the process of being send out

    next states: COMPLETED, FAILED

  • COMPLETED: when the message is successfully sent out

    next states: ARCHIVED

  • FAILED: when the message is not successfully sent out

    next states: ARCHIVED

  • ARCHIVED: when the message is archives and waiting for its deletion against a certain

    retention policy next states: None

Variables
  • ARCHIVED – “archived” notifications

  • COMPLETED – “completed” notifications

  • DRAFT – “draft” notifications

  • FAILED – “failed” notifications

  • PROCESSING – “processing” notifications

  • READY – “ready” notifications

class NotificationEvent[source]

Options to retrieve a Notification based on its event.

Variables
  • SHARE_ACTIVITY_LINK – notifications generated by sharing the link of an Activity

  • EXPORT_ACTIVITY_ASYNC – notifications generated by exporting an Activity

  • SHARE_ACTIVITY_PDF – notifications generated by sharing the pdf of an Activity

class NotificationChannels[source]

Options to retrieve a Notification based on its channel.

Variables
  • EMAIL – email notification

  • APP – app notification

class LanguageCodes[source]

Options for the language setting of a user.

Variables
  • ENGLISH – English

  • FRENCH – French

  • GERMAN – German

  • DUTCH – Dutch

  • ITALIAN – Italian

class ImageSize[source]

Options for the Image Size the picture would be saved as from an Attachment Property.

Variables
  • SQXS – SQXS (100, 100) # pixels square

  • XS – XS (100, ) # pixels width

  • S – S (320, )

  • SQS – SQS (320, 320)

  • M – M (640, )

  • SQM – SQM (640, 640)

  • L – L (1024, )

  • SQL – SQL (1024, 1024)

  • XL – XL (2048, )

  • SQXL – SQXL (2048, 2048)

  • XXL – XXL (4096, )

  • SQXXL – SQXXL (4096, 4096)

class FormCategory[source]

Options for the Category of a Form.

Variables
  • MODEL – Model

  • INSTANCE – Instance

class WorkflowCategory[source]

Options for the Category of a Workflow.

Variables
  • CATALOG – Catalog Workflow (immutable)

  • DEFINED – Defined Workflow belonging to a scope

class TransitionType[source]

Options for the Type of a Transition.

Variables
  • INITIAL – Initial transition, the initial transition to follow when the form is created.

  • GLOBAL – Global transition, possibility to transition to all statuses from any

  • DIRECTED – A Directed transition, a transition with a specific from -> to direction

class StatusCategory[source]

Category of statuses.

Variables
  • UNDEFINED – Undefined status

  • TODO – Todo status

  • INPROGRESS – In progress status

  • DONE – Done status