Customizer Settings¶

The settings described in this section are required to specify how the customizer should execute the payload. They can either be specified as environment variables, or as customizerSettings in the payload when using the customizer API.

Sample .env¶

# Logfile for Customizer execution
# CUST_LOG_FILE=/tmp/customizing.log

# Location where AdminSettings xml files are located
# CUST_SETTINGS_DIR=/settings/

# CUST_PAYLOAD_DIR=/payload/

# Location of the payload file. File can be in YAML or in Terraform TFVARS Format.
# CUST_PAYLOAD=annotation=NoneType required=False default='/payload/' deprecated=Truepayload.yaml

# Location of the payload file in gz format, unzip format must be either YAML or Terraform TFVARS.
# CUST_PAYLOAD_GZ=annotation=NoneType required=False default='/payload/' deprecated=Truepayload.yml.gz.b64

# CUST_PAYLOAD_EXTERNAL=/payload-external/

# Nickname of folder to upload payload and log files
# CUST_TARGET_FOLDER_NICKNAME=deployment

# CUST_RM_SETTINGS_DIR=/settings/

# Stop the payload processing when an error during the transport package deployment occurs. This can be useful for debugging, to identify missing dependencies.
# STOP_ON_ERROR=False

# Check for previous execution of a payload section, set to False to force the execution
# STATUS_FILE_CHECK=True

# PLACEHOLDER_VALUES={}

# Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using cProfile. Result is a log file with the cProfile results, as well as a dump of the profiling session. The files are located in the logdir. Profiling is disabled by default.
# PROFILING=False

# Headless Browser for the BrowserAutomation
# HEADLESS_BROWSER=True

# Username for the OTDS admin user
# OTDS__USERNAME=admin

# Password for the OTDS admin user
# OTDS__PASSWORD=

# Client ID for the OTDS admin user
# OTDS__CLIENT_ID=

# Client Secret for the OTDS admin user
# OTDS__CLIENT_SECRET=

# Ticket for the OTDS admin user
# OTDS__TICKET=

# Name of the admin partition in OTDS
# OTDS__ADMIN_PARTITION=otds.admin

# Enable the OTDS Audit
# OTDS__ENABLE_AUDIT=True

# Switch to disable the default OTDS password policy
# OTDS__DISABLE_PASSWORD_POLICY=True

# URL of the OTDS service
# OTDS__URL=

# Internal URL of the OTDS service
# OTDS__URL_INTERNAL=

# Password for the OTDS bind user to LDAP
# OTDS__BIND_PASSWORD=

# Username for the OTCS admin user
# OTCS__USERNAME=admin

# Password for the OTCS admin user
# OTCS__PASSWORD=

# Base path of the OTCS installation
# OTCS__BASE_PATH=/cs/cs

# Support path of the OTCS installation
# OTCS__SUPPORT_PATH=/cssupport

# URL of the OTCS service
# OTCS__URL=

# URL of the OTCS frontend service, if not specified, it will be set to the same value as url
# OTCS__URL_FRONTEND=

# URL of the OTCS backend service, if not specified, it will be set to the same value as url
# OTCS__URL_BACKEND=

# Name of the default Partition in OTDS
# OTCS__PARTITION=Content Server Members

# Name of the OTCS resource in OTDS
# OTCS__RESOURCE_NAME=cs

# Enable/Disable maintenance mode during payload processing.
# OTCS__MAINTENANCE_MODE=False

# Default license feature to be added to Users in OTDS
# OTCS__LICENSE_FEATURE=X3

# temporary download directory for payload processing
# OTCS__DOWNLOAD_DIR=/tmp

# URL of the FEME endpoint
# OTCS__FEME_URI=ws://feme:4242

# Update the OTCS Admin user and rename to Terrarium Admin.
# OTCS__UPDATE_ADMIN_USER=True

# Upload the configuration files of the payload to OTCS.
# OTCS__UPLOAD_CONFIG_FILES=True

# Upload the status files of the payload to OTCS.
# OTCS__UPLOAD_STATUS_FILES=True

# Upload the log file of the payload to OTCS.
# OTCS__UPLOAD_LOG_FILE=True

# Enable/Disable OTAC integration
# OTAC__ENABLED=False

# Admin account for OTAC
# OTAC__USERNAME=dsadmin

# Password of the Admin Account
# OTAC__PASSWORD=

# URL of the OTAC service
# OTAC__URL=

# Internal URL of the OTAC service
# OTAC__URL_INTERNAL=

# Known OTAC servers to add to OTAC
# OTAC__KNOWN_SERVER=

# Enable/Disable the OTPD integration
# OTPD__ENABLED=False

# Password of the API user to configure OTPD
# OTPD__PASSWORD=

# URL of the OTPD service
# OTPD__URL=

# Path to the OTPD import file
# OTPD__DB_IMPORTFILE=

# OTPD__TENANT=Successfactors

# Enable/Disable the OTIV integration
# OTIV__ENABLED=False

# Path to the OTIV license file.
# OTIV__LICENSE_FILE=/payload/otiv-license.lic

# Name of the license feature.
# OTIV__LICENSE_FEATURE=FULLTIME_USERS_REGULAR

# Name of the product for the license.
# OTIV__PRODUCT_NAME=Viewing

# Description of the product for the license.
# OTIV__PRODUCT_DESCRIPTION=OpenText Intelligent Viewing

# Name of the resource for OTIV
# OTIV__RESOURCE_NAME=iv

# Enable/Disable the K8s integration
# K8S__ENABLED=True

# Path to the kubeconfig file
# K8S__KUBECONFIG_FILE=/root/.kube/config

# Name of the namespace
# K8S__NAMESPACE=default

# Name of the OTAWP statefulset
# K8S__STS_OTAWP=appworks

# Name of the OTAWP configmap
# K8S__CM_OTAWP=appworks-config-ymls

# Name of the OTPD pod
# K8S__POD_OTPD=otpd-0

# Name of the OTAC pod
# K8S__POD_OTAC=otac-0

# Name of the OTCS-FRONTEND service
# K8S__SVC_OTCS_FRONTEND=otcs-frontend

# Name of the OTCS-ADMIN service
# K8S__SVC_OTCS_ADMIN=otcs-admin-0

# Name of the OTCS-FRONTEND statefulset
# K8S__STS_OTCS_FRONTEND=otcs-frontend

# K8S__STS_OTCS_FRONTEND_REPLICAS=

# Name of the OTCS-ADMIN statefulset
# K8S__STS_OTCS_ADMIN=otcs-admin

# K8S__STS_OTCS_ADMIN_REPLICAS=

# Name of the OTCS-DA statefulset
# K8S__STS_OTCS_DA=otcs-da

# K8S__STS_OTCS_DA_REPLICAS=

# Name of the otxecm ingress
# K8S__INGRESS_OTXECM=otxecm-ingress

# K8S__MAINTENANCE_SERVICE_NAME=customizer

# K8S__MAINTENANCE_SERVICE_PORT=5555

# Enable/Disable the OTAWP integration
# OTAWP__ENABLED=False

# Username of the OTAWP Admin user
# OTAWP__USERNAME=sysadmin

# Password of the OTAWP Admin user
# OTAWP__PASSWORD=

# The name of the organization (kind of tenant in AppWorks)
# OTAWP__ORGANIZATION=system

# Path to the OTAWP license file.
# OTAWP__LICENSE_FILE=/payload/otawp-license.lic

# Name of the Product for the license
# OTAWP__PRODUCT_NAME=APPWORKS_PLATFORM

# Product description to be added in OTDS.
# OTAWP__PRODUCT_DESCRIPTION=OpenText Appworks Platform

# Name of the Resource for OTAWP
# OTAWP__RESOURCE_NAME=awp

# Name of the Access Role for OTAWP
# OTAWP__ACCESS_ROLE_NAME=Access to awp

# Protocol of the public OTAWP endpoint.
# OTAWP__PUBLIC_PROTOCOL=https

# Public URL address of the OTAWP service
# OTAWP__PUBLIC_URL=

# OTAWP__PORT=8080

# Protocol for the OTAWP service.
# OTAWP__PROTOCOL=http

# Password of the M365 tenant Admin.
# M365__PASSWORD=

# Enable/Disable the Microsoft 365 integration.
# M365__ENABLED=False

# Tenant ID of the Microsoft 365 tenant
# M365__TENANT_ID=

# Client ID for the Microsoft 365 tenant.
# M365__CLIENT_ID=

# Client Secret for the Microsoft 365 tenant.
# M365__CLIENT_SECRET=

# Base domain for the Microsoft 365 tenant.
# M365__DOMAIN=O365_DOMAIN

# M365__SKU_ID=c7df2760-2c81-4ef7-b578-5b5392b571df

# Automatically update the Teams App to the latest version if already exists.
# M365__UPDATE_TEAMS_APP=False

# Name of the Teams App
# M365__TEAMS_APP_NAME=OpenText Extended ECM

# External ID of the Teams App
# M365__TEAMS_APP_EXTERNAL_ID=dd4af790-d8ff-47a0-87ad-486318272c7a

# M365__SHAREPOINT_APP_ROOT_SITE=

# M365__SHAREPOINT_APP_CLIENT_ID=

# M365__SHAREPOINT_APP_CLIENT_SECRET=

# M365__AZURE_STORAGE_ACCOUNT=

# M365__AZURE_STORAGE_ACCESS_KEY=

# M365__AZURE_FUNCTION_URL=

# M365__AZURE_FUNCTION_URL_NOTIFICATION=

# Enable/Disable Core Share integration
# CORESHARE__ENABLED=False

# Admin username for Core Share
# CORESHARE__USERNAME=

# Admin password for Core Share
# CORESHARE__PASSWORD=

# Base URL of the Core Share Instance
# CORESHARE__BASE_URL=https://core.opentext.com

# OTDS URL of the Core Share Instance
# CORESHARE__SSO_URL=https://sso.core.opentext.com

# Client ID for the Core Share integration
# CORESHARE__CLIENT_ID=

# Client Secret for the Core Share integration
# CORESHARE__CLIENT_SECRET=

# Content Aviator enabled
# AVIATOR__ENABLED=False

# OAuth Client ID for Content Aviator
# AVIATOR__OAUTH_CLIENT=

# OAuth Client Secret for Content Aviator
# AVIATOR__OAUTH_SECRET=

# Base URL for Content Aviator
# AVIATOR__BASE_URL=http://csai-chat-svc:3000/

# Knowledge Discovery enabled
# OTKD__ENABLED=False

# URL of the Nifi Server
# OTKD__URL=

# Admin username for Knowledge Discovery (Nifi)
# OTKD__USERNAME=admin

# Admin password for Knowledge Discovery (Nifi)
# OTKD__PASSWORD=

# Enable Aviator Search configuration
# AVTS__ENABLED=False

# Admin username for Aviator Search
# AVTS__USERNAME=

# Admin password for Aviator Search
# AVTS__PASSWORD=

# OTDS Client ID for Aviator Search
# AVTS__CLIENT_ID=

# OTDS Client Secret for Aviator Search
# AVTS__CLIENT_SECRET=

# AVTS__BASE_URL=

# Enable/Disable the OTMM integration
# OTMM__ENABLED=False

# Username of the API user to connect to OTMM
# OTMM__USERNAME=

# Password of the API user to connect to OTMM
# OTMM__PASSWORD=

# Client ID of the API user to connect to OTMM
# OTMM__CLIENT_ID=

# Client Secret of the API user to connect to OTMM
# OTMM__CLIENT_SECRET=

# URL of the OTMM service
# OTMM__URL=

# Enable/Disable the SAP integration
# SAP__ENABLED=False

# Username of the SAP user (used for RFC and OData calls)
# SAP__USERNAME=

# Password of the SAP user
# SAP__PASSWORD=

# Base URL of the SAP system for OData REST API calls, e.g. 'https://s4.example.com:44300'
# SAP__BASE_URL=

# Verify the TLS certificate of the SAP system for OData calls
# SAP__VERIFY_SSL=True

# SAP client ('Mandant'), used for RFC and OData
# SAP__CLIENT=100

# Logon language as two-character ISO code, used for RFC and OData
# SAP__LANG=EN

# SAP system ID, e.g. 'TE1'. Used for the RFC logon and - by convention - as the name of the OTCS external system of this SAP system
# SAP__SYSTEM_ID=

# SAP system number (RFC only)
# SAP__SYSTEM_NUMBER=00

# Hostname of the application server for direct application server logon (RFC only)
# SAP__ASHOST=

# Hostname of the message server for logon with load balancing (RFC only)
# SAP__MSHOST=

# Port of the message server (RFC only)
# SAP__MSPORT=3601

# Logon group for logon with load balancing (RFC only)
# SAP__GROUP=PUBLIC

# RFC destination (RFC only)
# SAP__DESTINATION=

# RFC trace level: 0=off, 1=brief, 2=verbose, 3=detailed, 4=full
# SAP__TRACE=3

# Path to the PEM-encoded, unencrypted RSA private key (at least 2048 bits) of pyxecm's SAML 2.0 identity provider. It signs the SAML assertions for principal propagation into SAP (SAP.get_saml_assertion()). Whoever holds it can get an SAP access token for every user the SAP-side NameID mapping reaches - mount it from a secret store. Created once per deployment (see docs/pyxecm-customizer/sap-authentication.md). Requires the 'saml' extra. Empty = principal propagation disabled.
# SAP__SAML_IDP_PRIVATE_KEY_FILE=

# Path to the PEM-encoded X.509 certificate of saml_idp_private_key_file. The SAP administrator imports it in transaction SAML2 as the signing certificate of the trusted identity provider. Checked against the private key and its expiry date at startup.
# SAP__SAML_IDP_CERTIFICATE_FILE=

# Entity ID (provider name) of pyxecm's SAML 2.0 identity provider, as registered in transaction SAML2, e.g. 'pyxecm-idp'. Required for principal propagation.
# SAP__SAML_ISSUER=

# Provider name of the SAP system's local SAML 2.0 provider (transaction SAML2, 'Local Provider' tab), e.g. 'S4HCLNT100'. Required for principal propagation.
# SAP__SAML_AUDIENCE=

# NameID format of the SAML assertions - must match the identity federation of pyxecm's trusted provider in transaction SAML2. Default: e-mail address (the SAP user is found by the e-mail address of the user).
# SAP__SAML_NAMEID_FORMAT=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

# OAuth 2.0 client ID for principal propagation, registered in transaction SOAUTH2 - the user name of the SU01 system user that represents pyxecm (see SAP.get_oauth_access_token()).
# SAP__OAUTH_CLIENT_ID=

# Password of the SU01 system user of oauth_client_id (SOAUTH2 client authentication 'Password'). It authenticates pyxecm as application - it is not an end user's password.
# SAP__OAUTH_CLIENT_SECRET=

# Space-separated SAP OAuth 2.0 scope IDs requested for the access tokens, e.g. 'API_MAINTENANCEORDER_0002 API_MAINTNOTIFICATION_0001' - one per OData service that is called with the token. Required for principal propagation: S/4HANA answers a token request without scope with 'invalid_scope' (it does not fall back to the scopes of the OAuth client in SOAUTH2).
# SAP__OAUTH_SCOPE=

Documentation¶

`CUST_LOG_FILE`¶

Optional, default value: /tmp/customizing.log

Logfile for Customizer execution

`CUST_SETTINGS_DIR`¶

Optional, default value: /settings/

Location where AdminSettings xml files are located

`CUST_PAYLOAD_DIR`¶

Optional, default value: /payload/

`CUST_PAYLOAD`¶

Optional, default value: annotation=NoneType required=False default='/payload/' deprecated=Truepayload.yaml

Location of the payload file. File can be in YAML or in Terraform TFVARS Format.

`CUST_PAYLOAD_GZ`¶

Optional, default value: annotation=NoneType required=False default='/payload/' deprecated=Truepayload.yml.gz.b64

Location of the payload file in gz format, unzip format must be either YAML or Terraform TFVARS.

`CUST_PAYLOAD_EXTERNAL`¶

Optional, default value: /payload-external/

`CUST_TARGET_FOLDER_NICKNAME`¶

Optional, default value: deployment

Nickname of folder to upload payload and log files

`CUST_RM_SETTINGS_DIR`¶

Optional, default value: /settings/

`STOP_ON_ERROR`¶

Optional, default value: False

Stop the payload processing when an error during the transport package deployment occurs. This can be useful for debugging, to identify missing dependencies.

`STATUS_FILE_CHECK`¶

Optional, default value: True

Check for previous execution of a payload section, set to False to force the execution

`PLACEHOLDER_VALUES`¶

Optional, default value: {}

`PROFILING`¶

Optional, default value: False

Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using cProfile. Result is a log file with the cProfile results, as well as a dump of the profiling session. The files are located in the logdir. Profiling is disabled by default.

`HEADLESS_BROWSER`¶

Optional, default value: True

Headless Browser for the BrowserAutomation

`OTDS__USERNAME`¶

Optional, default value: admin

Username for the OTDS admin user

`OTDS__PASSWORD`¶

Optional, default value: None

Password for the OTDS admin user

`OTDS__CLIENT_ID`¶

Optional, default value: None

Client ID for the OTDS admin user

`OTDS__CLIENT_SECRET`¶

Optional, default value: None

Client Secret for the OTDS admin user

`OTDS__TICKET`¶

Optional, default value: None

Ticket for the OTDS admin user

`OTDS__ADMIN_PARTITION`¶

Optional, default value: otds.admin

Name of the admin partition in OTDS

`OTDS__ENABLE_AUDIT`¶

Optional, default value: True

Enable the OTDS Audit

`OTDS__DISABLE_PASSWORD_POLICY`¶

Optional, default value: True

Switch to disable the default OTDS password policy

`OTDS__URL`¶

Optional, default value: None

URL of the OTDS service

`OTDS__URL_INTERNAL`¶

Optional, default value: None

Internal URL of the OTDS service

`OTDS__BIND_PASSWORD`¶

Optional, default value: None

Password for the OTDS bind user to LDAP

`OTCS__USERNAME`¶

Optional, default value: admin

Username for the OTCS admin user

`OTCS__PASSWORD`¶

Optional, default value: None

Password for the OTCS admin user

`OTCS__BASE_PATH`¶

Optional, default value: /cs/cs

Base path of the OTCS installation

`OTCS__SUPPORT_PATH`¶

Optional, default value: /cssupport

Support path of the OTCS installation

`OTCS__URL`¶

Optional, default value: None

URL of the OTCS service

`OTCS__URL_FRONTEND`¶

Optional, default value: None

URL of the OTCS frontend service, if not specified, it will be set to the same value as url

`OTCS__URL_BACKEND`¶

Optional, default value: None

URL of the OTCS backend service, if not specified, it will be set to the same value as url

`OTCS__PARTITION`¶

Optional, default value: Content Server Members

Name of the default Partition in OTDS

`OTCS__RESOURCE_NAME`¶

Optional, default value: cs

Name of the OTCS resource in OTDS

`OTCS__MAINTENANCE_MODE`¶

Optional, default value: False

Enable/Disable maintenance mode during payload processing.

`OTCS__LICENSE_FEATURE`¶

Optional, default value: X3

Default license feature to be added to Users in OTDS

`OTCS__DOWNLOAD_DIR`¶

Optional, default value: /tmp

temporary download directory for payload processing

`OTCS__FEME_URI`¶

Optional, default value: ws://feme:4242

URL of the FEME endpoint

`OTCS__UPDATE_ADMIN_USER`¶

Optional, default value: True

Update the OTCS Admin user and rename to Terrarium Admin.

`OTCS__UPLOAD_CONFIG_FILES`¶

Optional, default value: True

Upload the configuration files of the payload to OTCS.

`OTCS__UPLOAD_STATUS_FILES`¶

Optional, default value: True

Upload the status files of the payload to OTCS.

`OTCS__UPLOAD_LOG_FILE`¶

Optional, default value: True

Upload the log file of the payload to OTCS.

`OTAC__ENABLED`¶

Optional, default value: False

Enable/Disable OTAC integration

`OTAC__USERNAME`¶

Optional, default value: dsadmin

Admin account for OTAC

`OTAC__PASSWORD`¶

Optional, default value: None

Password of the Admin Account

`OTAC__URL`¶

Optional, default value: None

URL of the OTAC service

`OTAC__URL_INTERNAL`¶

Optional, default value: None

Internal URL of the OTAC service

`OTAC__KNOWN_SERVER`¶

Optional, default value: ``

Known OTAC servers to add to OTAC

`OTPD__ENABLED`¶

Optional, default value: False

Enable/Disable the OTPD integration

`OTPD__PASSWORD`¶

Optional, default value: ``

Password of the API user to configure OTPD

`OTPD__URL`¶

Optional, default value: None

URL of the OTPD service

`OTPD__DB_IMPORTFILE`¶

Optional, default value: ``

Path to the OTPD import file

`OTPD__TENANT`¶

Optional, default value: Successfactors

`OTIV__ENABLED`¶

Optional, default value: False

Enable/Disable the OTIV integration

`OTIV__LICENSE_FILE`¶

Optional, default value: /payload/otiv-license.lic

Path to the OTIV license file.

`OTIV__LICENSE_FEATURE`¶

Optional, default value: FULLTIME_USERS_REGULAR

Name of the license feature.

`OTIV__PRODUCT_NAME`¶

Optional, default value: Viewing

Name of the product for the license.

`OTIV__PRODUCT_DESCRIPTION`¶

Optional, default value: OpenText Intelligent Viewing

Description of the product for the license.

`OTIV__RESOURCE_NAME`¶

Optional, default value: iv

Name of the resource for OTIV

`K8S__ENABLED`¶

Optional, default value: True

Enable/Disable the K8s integration

`K8S__KUBECONFIG_FILE`¶

Optional, default value: /root/.kube/config

Path to the kubeconfig file

`K8S__NAMESPACE`¶

Optional, default value: default

Name of the namespace

`K8S__STS_OTAWP`¶

Optional, default value: appworks

Name of the OTAWP statefulset

`K8S__CM_OTAWP`¶

Optional, default value: appworks-config-ymls

Name of the OTAWP configmap

`K8S__POD_OTPD`¶

Optional, default value: otpd-0

Name of the OTPD pod

`K8S__POD_OTAC`¶

Optional, default value: otac-0

Name of the OTAC pod

`K8S__SVC_OTCS_FRONTEND`¶

Optional, default value: otcs-frontend

Name of the OTCS-FRONTEND service

`K8S__SVC_OTCS_ADMIN`¶

Optional, default value: otcs-admin-0

Name of the OTCS-ADMIN service

`K8S__STS_OTCS_FRONTEND`¶

Optional, default value: otcs-frontend

Name of the OTCS-FRONTEND statefulset

`K8S__STS_OTCS_FRONTEND_REPLICAS`¶

Optional, default value: None

`K8S__STS_OTCS_ADMIN`¶

Optional, default value: otcs-admin

Name of the OTCS-ADMIN statefulset

`K8S__STS_OTCS_ADMIN_REPLICAS`¶

Optional, default value: None

`K8S__STS_OTCS_DA`¶

Optional, default value: otcs-da

Name of the OTCS-DA statefulset

`K8S__STS_OTCS_DA_REPLICAS`¶

Optional, default value: None

`K8S__INGRESS_OTXECM`¶

Optional, default value: otxecm-ingress

Name of the otxecm ingress

`K8S__MAINTENANCE_SERVICE_NAME`¶

Optional, default value: customizer

`K8S__MAINTENANCE_SERVICE_PORT`¶

Optional, default value: 5555

`OTAWP__ENABLED`¶

Optional, default value: False

Enable/Disable the OTAWP integration

`OTAWP__USERNAME`¶

Optional, default value: sysadmin

Username of the OTAWP Admin user

`OTAWP__PASSWORD`¶

Optional, default value: None

Password of the OTAWP Admin user

`OTAWP__ORGANIZATION`¶

Optional, default value: system

The name of the organization (kind of tenant in AppWorks)

`OTAWP__LICENSE_FILE`¶

Optional, default value: /payload/otawp-license.lic

Path to the OTAWP license file.

`OTAWP__PRODUCT_NAME`¶

Optional, default value: APPWORKS_PLATFORM

Name of the Product for the license

`OTAWP__PRODUCT_DESCRIPTION`¶

Optional, default value: OpenText Appworks Platform

Product description to be added in OTDS.

`OTAWP__RESOURCE_NAME`¶

Optional, default value: awp

Name of the Resource for OTAWP

`OTAWP__ACCESS_ROLE_NAME`¶

Optional, default value: Access to awp

Name of the Access Role for OTAWP

`OTAWP__PUBLIC_PROTOCOL`¶

Optional, default value: https

Protocol of the public OTAWP endpoint.

`OTAWP__PUBLIC_URL`¶

Optional, default value: ``

Public URL address of the OTAWP service

`OTAWP__PORT`¶

Optional, default value: 8080

`OTAWP__PROTOCOL`¶

Optional, default value: http

Protocol for the OTAWP service.

`M365__PASSWORD`¶

Optional, default value: ``

Password of the M365 tenant Admin.

`M365__ENABLED`¶

Optional, default value: False

Enable/Disable the Microsoft 365 integration.

`M365__TENANT_ID`¶

Optional, default value: ``

Tenant ID of the Microsoft 365 tenant

`M365__CLIENT_ID`¶

Optional, default value: ``

Client ID for the Microsoft 365 tenant.

`M365__CLIENT_SECRET`¶

Optional, default value: ``

Client Secret for the Microsoft 365 tenant.

`M365__DOMAIN`¶

Optional, default value: O365_DOMAIN

Base domain for the Microsoft 365 tenant.

`M365__SKU_ID`¶

Optional, default value: c7df2760-2c81-4ef7-b578-5b5392b571df

`M365__UPDATE_TEAMS_APP`¶

Optional, default value: False

Automatically update the Teams App to the latest version if already exists.

`M365__TEAMS_APP_NAME`¶

Optional, default value: OpenText Extended ECM

Name of the Teams App

`M365__TEAMS_APP_EXTERNAL_ID`¶

Optional, default value: dd4af790-d8ff-47a0-87ad-486318272c7a

External ID of the Teams App

`M365__SHAREPOINT_APP_ROOT_SITE`¶

Optional, default value: ``

`M365__SHAREPOINT_APP_CLIENT_ID`¶

Optional, default value: ``

`M365__SHAREPOINT_APP_CLIENT_SECRET`¶

Optional, default value: ``

`M365__AZURE_STORAGE_ACCOUNT`¶

Optional, default value: None

`M365__AZURE_STORAGE_ACCESS_KEY`¶

Optional, default value: None

`M365__AZURE_FUNCTION_URL`¶

Optional, default value: None

`M365__AZURE_FUNCTION_URL_NOTIFICATION`¶

Optional, default value: None

`CORESHARE__ENABLED`¶

Optional, default value: False

Enable/Disable Core Share integration

`CORESHARE__USERNAME`¶

Optional, default value: ``

Admin username for Core Share

`CORESHARE__PASSWORD`¶

Optional, default value: None

Admin password for Core Share

`CORESHARE__BASE_URL`¶

Optional, default value: https://core.opentext.com

Base URL of the Core Share Instance

`CORESHARE__SSO_URL`¶

Optional, default value: https://sso.core.opentext.com

OTDS URL of the Core Share Instance

`CORESHARE__CLIENT_ID`¶

Optional, default value: ``

Client ID for the Core Share integration

`CORESHARE__CLIENT_SECRET`¶

Optional, default value: ``

Client Secret for the Core Share integration

`AVIATOR__ENABLED`¶

Optional, default value: False

Content Aviator enabled

`AVIATOR__OAUTH_CLIENT`¶

Optional, default value: ``

OAuth Client ID for Content Aviator

`AVIATOR__OAUTH_SECRET`¶

Optional, default value: ``

OAuth Client Secret for Content Aviator

`AVIATOR__BASE_URL`¶

Optional, default value: http://csai-chat-svc:3000/

Base URL for Content Aviator

`OTKD__ENABLED`¶

Optional, default value: False

Knowledge Discovery enabled

`OTKD__URL`¶

Optional, default value: None

URL of the Nifi Server

`OTKD__USERNAME`¶

Optional, default value: admin

Admin username for Knowledge Discovery (Nifi)

`OTKD__PASSWORD`¶

Optional, default value: ``

Admin password for Knowledge Discovery (Nifi)

`AVTS__ENABLED`¶

Optional, default value: False

Enable Aviator Search configuration

`AVTS__USERNAME`¶

Optional, default value: ``

Admin username for Aviator Search

`AVTS__PASSWORD`¶

Optional, default value: ``

Admin password for Aviator Search

`AVTS__CLIENT_ID`¶

Optional, default value: ``

OTDS Client ID for Aviator Search

`AVTS__CLIENT_SECRET`¶

Optional, default value: ``

OTDS Client Secret for Aviator Search

`AVTS__BASE_URL`¶

Optional, default value: None

`OTMM__ENABLED`¶

Optional, default value: False

Enable/Disable the OTMM integration

`OTMM__USERNAME`¶

Optional, default value: ``

Username of the API user to connect to OTMM

`OTMM__PASSWORD`¶

Optional, default value: None

Password of the API user to connect to OTMM

`OTMM__CLIENT_ID`¶

Optional, default value: None

Client ID of the API user to connect to OTMM

`OTMM__CLIENT_SECRET`¶

Optional, default value: None

Client Secret of the API user to connect to OTMM

`OTMM__URL`¶

Optional, default value: None

URL of the OTMM service

`SAP__ENABLED`¶

Optional, default value: False

Enable/Disable the SAP integration

`SAP__USERNAME`¶

Optional, default value: ``

Username of the SAP user (used for RFC and OData calls)

`SAP__PASSWORD`¶

Optional, default value: ``

Password of the SAP user

`SAP__BASE_URL`¶

Optional, default value: None

Base URL of the SAP system for OData REST API calls, e.g. 'https://s4.example.com:44300'

`SAP__VERIFY_SSL`¶

Optional, default value: True

Verify the TLS certificate of the SAP system for OData calls

`SAP__CLIENT`¶

Optional, default value: 100

SAP client ('Mandant'), used for RFC and OData

`SAP__LANG`¶

Optional, default value: EN

Logon language as two-character ISO code, used for RFC and OData

`SAP__SYSTEM_ID`¶

Optional, default value: ``

SAP system ID, e.g. 'TE1'. Used for the RFC logon and - by convention - as the name of the OTCS external system of this SAP system

`SAP__SYSTEM_NUMBER`¶

Optional, default value: 00

SAP system number (RFC only)

`SAP__ASHOST`¶

Optional, default value: ``

Hostname of the application server for direct application server logon (RFC only)

`SAP__MSHOST`¶

Optional, default value: ``

Hostname of the message server for logon with load balancing (RFC only)

`SAP__MSPORT`¶

Optional, default value: 3601

Port of the message server (RFC only)

`SAP__GROUP`¶

Optional, default value: PUBLIC

Logon group for logon with load balancing (RFC only)

`SAP__DESTINATION`¶

Optional, default value: ``

RFC destination (RFC only)

`SAP__TRACE`¶

Optional, default value: 3

RFC trace level: 0=off, 1=brief, 2=verbose, 3=detailed, 4=full

`SAP__SAML_IDP_PRIVATE_KEY_FILE`¶

Optional, default value: ``

Path to the PEM-encoded, unencrypted RSA private key (at least 2048 bits) of pyxecm's SAML 2.0 identity provider. It signs the SAML assertions for principal propagation into SAP (SAP.get_saml_assertion()). Whoever holds it can get an SAP access token for every user the SAP-side NameID mapping reaches - mount it from a secret store. Created once per deployment (see docs/pyxecm-customizer/sap-authentication.md). Requires the 'saml' extra. Empty = principal propagation disabled.

`SAP__SAML_IDP_CERTIFICATE_FILE`¶

Optional, default value: ``

Path to the PEM-encoded X.509 certificate of saml_idp_private_key_file. The SAP administrator imports it in transaction SAML2 as the signing certificate of the trusted identity provider. Checked against the private key and its expiry date at startup.

`SAP__SAML_ISSUER`¶

Optional, default value: ``

Entity ID (provider name) of pyxecm's SAML 2.0 identity provider, as registered in transaction SAML2, e.g. 'pyxecm-idp'. Required for principal propagation.

`SAP__SAML_AUDIENCE`¶

Optional, default value: ``

Provider name of the SAP system's local SAML 2.0 provider (transaction SAML2, 'Local Provider' tab), e.g. 'S4HCLNT100'. Required for principal propagation.

`SAP__SAML_NAMEID_FORMAT`¶

Optional, default value: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

NameID format of the SAML assertions - must match the identity federation of pyxecm's trusted provider in transaction SAML2. Default: e-mail address (the SAP user is found by the e-mail address of the user).

`SAP__OAUTH_CLIENT_ID`¶

Optional, default value: ``

OAuth 2.0 client ID for principal propagation, registered in transaction SOAUTH2 - the user name of the SU01 system user that represents pyxecm (see SAP.get_oauth_access_token()).

`SAP__OAUTH_CLIENT_SECRET`¶

Optional, default value: ``

Password of the SU01 system user of oauth_client_id (SOAUTH2 client authentication 'Password'). It authenticates pyxecm as application - it is not an end user's password.

`SAP__OAUTH_SCOPE`¶

Optional, default value: ``

Space-separated SAP OAuth 2.0 scope IDs requested for the access tokens, e.g. 'API_MAINTENANCEORDER_0002 API_MAINTNOTIFICATION_0001' - one per OData service that is called with the token. Required for principal propagation: S/4HANA answers a token request without scope with 'invalid_scope' (it does not fall back to the scopes of the OAuth client in SOAUTH2).

Customizer Settings¶

Sample .env¶

Documentation¶

CUST_LOG_FILE¶

CUST_SETTINGS_DIR¶

CUST_PAYLOAD_DIR¶

CUST_PAYLOAD¶

CUST_PAYLOAD_GZ¶

CUST_PAYLOAD_EXTERNAL¶

CUST_TARGET_FOLDER_NICKNAME¶

CUST_RM_SETTINGS_DIR¶

STOP_ON_ERROR¶

STATUS_FILE_CHECK¶

PLACEHOLDER_VALUES¶

PROFILING¶

HEADLESS_BROWSER¶

OTDS__USERNAME¶

OTDS__PASSWORD¶

OTDS__CLIENT_ID¶

OTDS__CLIENT_SECRET¶

OTDS__TICKET¶

OTDS__ADMIN_PARTITION¶

OTDS__ENABLE_AUDIT¶

OTDS__DISABLE_PASSWORD_POLICY¶

OTDS__URL¶

OTDS__URL_INTERNAL¶

OTDS__BIND_PASSWORD¶

OTCS__USERNAME¶

OTCS__PASSWORD¶

OTCS__BASE_PATH¶

OTCS__SUPPORT_PATH¶

OTCS__URL¶

OTCS__URL_FRONTEND¶

OTCS__URL_BACKEND¶

OTCS__PARTITION¶

OTCS__RESOURCE_NAME¶

OTCS__MAINTENANCE_MODE¶

OTCS__LICENSE_FEATURE¶

OTCS__DOWNLOAD_DIR¶

OTCS__FEME_URI¶

OTCS__UPDATE_ADMIN_USER¶

OTCS__UPLOAD_CONFIG_FILES¶

OTCS__UPLOAD_STATUS_FILES¶

OTCS__UPLOAD_LOG_FILE¶

OTAC__ENABLED¶

OTAC__USERNAME¶

OTAC__PASSWORD¶

OTAC__URL¶

OTAC__URL_INTERNAL¶

OTAC__KNOWN_SERVER¶

OTPD__ENABLED¶

OTPD__PASSWORD¶

OTPD__URL¶

OTPD__DB_IMPORTFILE¶

OTPD__TENANT¶

OTIV__ENABLED¶

OTIV__LICENSE_FILE¶

OTIV__LICENSE_FEATURE¶

OTIV__PRODUCT_NAME¶

OTIV__PRODUCT_DESCRIPTION¶

OTIV__RESOURCE_NAME¶

K8S__ENABLED¶

K8S__KUBECONFIG_FILE¶

K8S__NAMESPACE¶

K8S__STS_OTAWP¶

K8S__CM_OTAWP¶

K8S__POD_OTPD¶

K8S__POD_OTAC¶

K8S__SVC_OTCS_FRONTEND¶

K8S__SVC_OTCS_ADMIN¶

K8S__STS_OTCS_FRONTEND¶

K8S__STS_OTCS_FRONTEND_REPLICAS¶

K8S__STS_OTCS_ADMIN¶

K8S__STS_OTCS_ADMIN_REPLICAS¶

K8S__STS_OTCS_DA¶

K8S__STS_OTCS_DA_REPLICAS¶

K8S__INGRESS_OTXECM¶

K8S__MAINTENANCE_SERVICE_NAME¶

K8S__MAINTENANCE_SERVICE_PORT¶

OTAWP__ENABLED¶

`CUST_LOG_FILE`¶

`CUST_SETTINGS_DIR`¶

`CUST_PAYLOAD_DIR`¶

`CUST_PAYLOAD`¶

`CUST_PAYLOAD_GZ`¶

`CUST_PAYLOAD_EXTERNAL`¶

`CUST_TARGET_FOLDER_NICKNAME`¶

`CUST_RM_SETTINGS_DIR`¶

`STOP_ON_ERROR`¶

`STATUS_FILE_CHECK`¶

`PLACEHOLDER_VALUES`¶

`PROFILING`¶

`HEADLESS_BROWSER`¶

`OTDS__USERNAME`¶

`OTDS__PASSWORD`¶

`OTDS__CLIENT_ID`¶

`OTDS__CLIENT_SECRET`¶

`OTDS__TICKET`¶

`OTDS__ADMIN_PARTITION`¶

`OTDS__ENABLE_AUDIT`¶

`OTDS__DISABLE_PASSWORD_POLICY`¶

`OTDS__URL`¶

`OTDS__URL_INTERNAL`¶

`OTDS__BIND_PASSWORD`¶

`OTCS__USERNAME`¶

`OTCS__PASSWORD`¶

`OTCS__BASE_PATH`¶

`OTCS__SUPPORT_PATH`¶

`OTCS__URL`¶

`OTCS__URL_FRONTEND`¶

`OTCS__URL_BACKEND`¶

`OTCS__PARTITION`¶

`OTCS__RESOURCE_NAME`¶

`OTCS__MAINTENANCE_MODE`¶

`OTCS__LICENSE_FEATURE`¶

`OTCS__DOWNLOAD_DIR`¶

`OTCS__FEME_URI`¶

`OTCS__UPDATE_ADMIN_USER`¶

`OTCS__UPLOAD_CONFIG_FILES`¶

`OTCS__UPLOAD_STATUS_FILES`¶

`OTCS__UPLOAD_LOG_FILE`¶

`OTAC__ENABLED`¶

`OTAC__USERNAME`¶

`OTAC__PASSWORD`¶

`OTAC__URL`¶

`OTAC__URL_INTERNAL`¶

`OTAC__KNOWN_SERVER`¶

`OTPD__ENABLED`¶

`OTPD__PASSWORD`¶

`OTPD__URL`¶

`OTPD__DB_IMPORTFILE`¶

`OTPD__TENANT`¶

`OTIV__ENABLED`¶

`OTIV__LICENSE_FILE`¶

`OTIV__LICENSE_FEATURE`¶

`OTIV__PRODUCT_NAME`¶

`OTIV__PRODUCT_DESCRIPTION`¶

`OTIV__RESOURCE_NAME`¶

`K8S__ENABLED`¶

`K8S__KUBECONFIG_FILE`¶

`K8S__NAMESPACE`¶

`K8S__STS_OTAWP`¶

`K8S__CM_OTAWP`¶

`K8S__POD_OTPD`¶

`K8S__POD_OTAC`¶

`K8S__SVC_OTCS_FRONTEND`¶

`K8S__SVC_OTCS_ADMIN`¶

`K8S__STS_OTCS_FRONTEND`¶

`K8S__STS_OTCS_FRONTEND_REPLICAS`¶

`K8S__STS_OTCS_ADMIN`¶

`K8S__STS_OTCS_ADMIN_REPLICAS`¶

`K8S__STS_OTCS_DA`¶

`K8S__STS_OTCS_DA_REPLICAS`¶

`K8S__INGRESS_OTXECM`¶

`K8S__MAINTENANCE_SERVICE_NAME`¶

`K8S__MAINTENANCE_SERVICE_PORT`¶

`OTAWP__ENABLED`¶

`OTAWP__USERNAME`¶

`OTAWP__PASSWORD`¶

`OTAWP__ORGANIZATION`¶