Advanced settings empower organizations to tailor their EPC to their specific needs, allowing for enhanced functionality and customization. Within this topic, we’ll explore how to access these settings, as well as extensive details on each available setting enabling you to fine-tune your experience with EPC. Get started by selecting a section below or searching for a specific setting.
How to Access & Edit Advanced Settings
- Ensure you have EPC System Administrator access.
- Go to the ‘System Admin’ section within the ellipsis menu on the right side of the navigation bar.
- Click the ‘Advanced’ tab to access advanced settings.
- Scroll to the desired setting
- Click on the setting’s corresponding ‘pen’ icon () to edit it.
Settings
- AI_FEATURES_IN_UI
- Choose the AI functionalities displayed in your EPC system. Default: empty.
- If the field is left empty, no AI features will be displayed in the UI, regardless of whether a ChatGPT key is entered.
- Input ‘generate’ in the field to exclusively display generation options.
- Input ‘improve’ to exclusively show improvement options.
- Input ‘generate, improve’ to display both functionalities.
- API_KEY
- Set to a random UUID to allow API key usage.
- APPS_URL
- Configuration of the URL of the external apps added to the Module Explorer
- BOOK_FORCE_PDF
- Force PDF output of object book/SOP generation
- CHATGPT_KEY
- Configuration parameter for the A.I process and rich text generation. Copy and paste the ChatGPT API key into this field. To learn how to obtain your API key, please click on either of the previous links. If you prefer the A.I. features not to appear to users, remove the API key from this field.
- CHATGPT_MODEL
- Configuration parameter for the A.I process and rich text generation. While the default ChatGPT model available in EPC is 3.5, you can modify it to gpt-4 or any other available ChatGPT model in this field.
- CHATGPT_NMBR_TOKEN
- Specify the desired limit for the number of tokens (words) that the A.I. will generate when a user makes a request in the A.I. process and rich text generation features by entering a value in this field. We recommend a minimum of 2000 tokens for optimal results.
- CHECK_NOTIFICATION_INTERVAL
- The time interval that EPC checks for changes generating user notifications. Denomination: Milliseconds.
- CHECK_SERVER_AVAILABILITY_IN_BROWSER
- Enable/Disable Server Availability Notifications.
- COGNOS_URL
- Cognos server URL. This setting is essential to utilize the Process Validation & Translation feature. Required Format: https://YOURCOGNOS.com/reporting/bi/ Note: make sure there is a slash (/) after bi.
- DBP_TASK_LIST_URL
- This setting is where you enter the URL of your Digital Business Platform task list, and it’s a necessary step for the proper functioning of the ‘Training’ feature. Once you add the DPB URL to this setting, a new ‘DBP’ tab will appear within the To Do module. This tab displays the DBP Application, allowing users to seamlessly access the DBP platform directly within EPC.
- DEFAULT_EMPTY_LANE_CREATE
- Number of empty lanes created automatically in the graph when creating a new process. Required Format: 0 to 9.
- DESCRIPTION_DEFAULT_DOCUMENT
- Default description that will be applied when creating a document.
- DESCRIPTION_DEFAULT_FLOW_OBJECT
- Default description that will be applied when creating a flow object.
- DESCRIPTION_DEFAULT_PROCESS
- Default description that will be applied when creating a process.
- DEV_CONFIG
- For Interfacing internal use only.
- DISABLE_NOTIFICATION_MINOR_VERSION
- If set to true, Required Format: true or false.
- DISABLE_RELATIONSHIPS_FILTERING
- If set to true, non-readable relationships won’t be filtered. This means it will return relationships even if the user doesn’t have access to view them. However, if the user attempts to access the object linked through the non-readable relationship, an error will occur. Required Format: true or false.
- DOCUMENT_CONTROLLED_COPIES
- If set to true, the download and print authorizations will be enabled. Default: false.
- DOCUMENT_INJECT_COVER_PAGE
- Configuration parameter for the automatic custom cover page injection feature. If set to true, the first page of future EPC documents created will be replaced by the chosen template’s (DOCUMENT_INJECT_HEADERS_FOOTERS) cover page. Default: false Required Format: true or false.
- DOCUMENT_INJECT_CUSTOM_PROPERTIES
- Configuration parameter for the embedded dynamic custom properties feature. If set to true, embed custom property information (in Word documents) will automatically update each time a document is created or saved after making changes. Default: false Required Format: true or false.
- DOCUMENT_INJECT_HEADERS_FOOTERS
- Configuration parameter for the automatic custom cover page injection. feature. Copy and paste the UID of the desired template document in this field. Default: empty Required Format: UID value, e.g.: 59E401AE-BC80-4DEF-84FF-6FE7260A5B1B.
- DOCUMENT_MAX_SIZE
- Maximum size of documents that can be stored in EPC.
- ENABLES_FLOWCHART_STENCIL
- Enable the use of flowchart shapes in the graph editor. Required Format: true or false.
- ENABLE_GOOGLE_ANALYTICS
- Enable the integration of Google Analytics data in the Home Page widgets. Required Format: true or false.
- ENABLE_HARMONIZATION
- Enable data association harmonization. Required Format: true or false.
- ENABLE_LANGUAGE_IN_URL
- Enables the language to be specified in URLs, a great tool for organizations that work with multiple content languages.
Required Format: true or false. - ENABLE_MASS_APPROVAL/dt>
- Enables user to mass approve in the To Do module. Required Format: true or false.
- ENABLE_MASS_CONFIRMATION
- Enables users to mass confirm in the To Do module. Required Format: true or false.
- ENABLE_MASS_ENDORSEMENT
- Enables users to mass endorse in the To Do module. Required Format: true or false.
- ENABLE_NAV_BAR_ERROR
- Description to come.
- ENABLE_SWIMANE_RESIZE
- If set to false, it will prevent Modelers from being able to resize lanes in Swimlanes processes, i.e. no action the Modeler takes will affect the size of the lane. Additionally, users won’t be able to add Phases to their process maps if this setting is set to false. Required Format: true or false. Default: true.
- ENABLE_TRACK_CHANGES
- Enables the tracking of changes in documents. Required Format: true or false.
- epc.inbound.url
- URL prefix where EPC is deployed.
- epc.license
- Your EPC license.
- epc.signature.enabled
- Enables the digital signature option in approval cycles. Required Format: true or false.
- epc.sysadmin.email
- EPC system administrator email.
- FILE_PREVIEW_MAX_FILE_SIZE
- Maximum size of files that can be previewed. Requires Format: numbers.
- GOOGLE_ANALYTICS_BLACK_LIST
- List of REGEX match to be excluded from information sent to Google Analytics.
- GRAPH_HIGHLIGHT_COLOR
- Color of path highlights in process graph. Required Format: hex color code. Default: #ffff00.
- GRAPH_HIGHLIGHT_THICKNESS
- Thickness of the highlight band in process graphs. Required Format: number, 1 to 9. Default: 3
- GRAPH_SHAPE_AUTO_RESIZE
- If this setting is set to true, task shapes will automatically resize to accommodate the full task name. If set to false, task names will dynamically truncate based on the shape size. Required Format: true or false.Default: true.
- HAMONIZATION_CONTROL_DEFAULT
- Default data harmonization value set in all objects. Required Format: high, medium or low. Default: low.
- HIDE_PERSONAL_INFO_TO_NON_SYSTEM_USERS
- Enables to hide personal identifiable information from non-admin users.
- IDENTIFIER_SORT_ALGORITHM
- Enables to choose the way Identifier columns are sorted in all List views. Required Format: ALPHANUMERIC or NUMERIC Default: NUMERIC.
- Numeric Sorting: EPC will group digit only values and sort them numerically, as well as order them by character length, e.g.: 1, 2, 10, 10, 11, 20.
- Alphanumeric Sorting: items are arranged in a way that considers both letters and numbers. This means that letters come before numbers in the sorting order, e.g.: A1, A10, A2, B1, B2, 10A.
- IMPORT_USER_SIZE
- Number of users that can be imported as resources. Required Format: number. Default: 1000.
- INHERIT_APPROVAL_CREATE
- Newly created objects inherit parent’s approval cycles. Required Format: true or false.Default: false.
- NHERIT_ENDORSEMENT_CREATE
- Newly created objects inherit parent’s endorsement cycles. Required Format: true or false.Default: false.
- INHERIT_IMPLEMENTER_CREATE
- Newly created objects inherit parent’s IR implementer. Required Format: true or false.Default: false.
- JIRA_AUTHORIZATION
- Authorization header when calling Jira.
- JIRA_USER_ACCOUNT
- Jira user account ID used for authorization.
- mail.debug
- For Interfacing internal use only.
- mail.enabled
- Enable email notifications. Required Format: true or false. Default: true.
- mail.from
- Email server configuration: choose the custom name that will appear as the sender when EPC sends notification emails to users.
- mail.password
- Password to use when connecting to the mail server. Can be plain text or encrypted.
- mail.smtp.auth
- Set to ‘true’ to attempt to authenticate the user using the AUTH command. Default: false
- mail.smtp.encryption
- Set to ‘tls’ to switch to TLS-protected connection.
- mail.smtp.host
- Host name of the mail server. E.g.: mail.example.com
- mail.smtp.port
- Port number of the mail server.
- mail.transport.protocol
- The message transport protocol.
- mail.user
- Username to use when connecting to the mail server.
- MAP_PAGE_BREAK_DEFAULT
- Enables to select the default ‘Map Page Break Option’ for object book generation.
- MICROSOFT_APP_CLIENT_ID
- Edit with MS 365 integration parameter. This setting is essential to utilize the Edit in Microsoft 365 feature. For procedures on how to integrate this feature to your EPC, click here.
- MICROSOFT_APP_CLIENT_SECRET
- Edit with MS 365 integration parameter. This setting is essential to utilize the Edit in Microsoft 365 feature. For procedures on how to integrate this feature to your EPC, click here.
- MICROSOFT_SYNC_CLOSE_DELAY
- Number of seconds to wait after Microsoft 365 tab had been closed to be synchronized with OneDrive. This setting is used in the Edit in Microsoft 365 feature. For procedures on how to integrate this feature to your EPC, click here.
- MICROSOFT_TENANT
- Edit with MS 365 integration parameter. This setting is essential to utilize the Edit in Microsoft 365 feature. For procedures on how to integrate this feature to your EPC, click here.
- MSTEAMS_APP_CLIENT_ID
- MS Teams Bot integration parameter. This setting is essential to utilize the collaboration feature using MS Teams. For procedures on how to integrate this feature to your EPC, click here.
- MSTEAMS_APP_CLIENT_SECRET
- MS Teams Bot integration parameter. This setting is essential to utilize the collaboration feature using MS Teams. For procedures on how to integrate this feature to your EPC, click here.
- MSTEAMS_TENANT
- MS Teams Bot integration parameter. This setting is essential to utilize the collaboration feature using MS Teams. For procedures on how to integrate this feature to your EPC, click here.
- ONE_RESOURCE_APPROVES_ENDORSES_FOR_ENTIRE_ROLE
- Only one resource is required to approve/endorse per role. Required Format: true or false. Default: false.
- PASSPORT_AZURE
- Azure Active Directory Authentication protocol settings for Single Sign-On (SSO) Login.
- PASSPORT_COGNITO
- Cognito Authentication protocol settings for Single Sign-On (SSO) Login.
- PASSPORT_JUST_IN_TIME
- Just In Time Authentication protocol settings for Single Sign-On (SSO) Login.
- PASSPORT_KERBEROS
- KERBEROS Authentication protocol settings for Single Sign-On (SSO) Login.
- PASSPORT_KERBEROS_KEYTAB
- Kerberos KEYTAB file in Base 64 format.
- PASSPORT_LDAP
- LDAP Login protocol settings for authentication.
- PASSPORT_NTLM
- NTLM Authentication protocol settings for Login.
- PASSPORT_SAML
- SAML Authentication protocol settings for Login.
- PASSPORT_STRATEGY_TO_USE
- Which login protocol to use. Protocols: Local, KERBEROS, LDAP, NTLM, SAML
- PRIVATE_CACHE_URL
- Address of internal cache port.
- PROCESS_SET_MAX_GRAPH_SIZE
- Number of processes to display on a Graph Set before clicking the “Display All” button.
- PURGE_PERIOD
- Default time where archived objects can be purged from the system Denomination: years. Required Format: number. Default: 13
- REMINDER_INTERVAL
- Interval between reminders. Default: 1.
- REMINDER_NEXT_DATE
- Minimal date on which to send reminders.
- REMOVE_AUTO_LAYOUT_BUTTON
- Removes the auto-layout button from the graph editor window. Required Format: true or false. Default: false.
- S3_ACCESS_KEY_ID
- Amazon S3 access key ID for external storage of files.
- S3_BUCKET_NAME
- Amazon S3 bucket name for external storage of files.
- S3_REFRESH_DELAY
- Frequency en seconds for pushing to external storage.
- S3_REGION
- Amazon S3 region for external storage of files.
- S3_SECRET_ACCESS_KEY
- Amazon S3 secret access key for external storage of files.
- S3_STORAGE_PREFIX
- Amazon S3 object key prefix for external storage of files.
- SEARCH_CUSTOM_EXTENSIONS
- Search custom file content extensions to index.
- SEARCH_EXCLUDED_ATTRIBUTES
- List of attribute IDs to exclude from search indexing. Required Format: separate the values by a comma and only the first 36 chars of each ID is relevant.
- SEARCH_LIST_FILTERING
- Enables to use ElasticSearch to make lists. Required Format: true or false. Default: false.
- SEARCH_MAX_FILE_SIZE
- The maximum file size to be featured within the search engine. Denomination: bytes. Default: 20,971,520 Bytes or 20 megabytes. Note: Increasing the file size will slow down search functionality.
- SEARCH_HIGHLIGHT_FILE_CONTENT
- Enables the highlighting of matching content from search queries. Required Format: true or false. Default: true. Example: If you search ‘Change Management’, the words ‘Change’ and ‘Management’ will be highlighted in the search result page, as shown below:
- SEARCH_QUERY_HIGHLIGHT_UDAS
- Enables the highlight of UDAs that match the content from search queries. Requires Format: true or false. Default: true. Example: When searching for ‘Canada,’ any UDAs matching the term ‘Canada’ will be highlighted in the search results.
- SEARCH_SERVER_PASSWORD
- Password of the search server.
- SEARCH_SERVER_URL
- URL of the search server.
- SEARCH_SERVER_USERNAME
- Username of the search server.
- SECRET_EXPIRY_DELAY
- Enables to customize the validity duration of the digital signature’s secret code. Denomination: minutes. Required Format: numbers. Default: 10. If this field is left empty, the validity duration will default to 10 minutes.
- SESSION_REFRESH
- Session activity refresh. Denomination: minutes. Required Format: numbers.
- SESSION_TIMEOUT
- Time after which users will be disconnected from their session after no activity. Denomination: minutes. Required Format: numbers.
- SORT_SERIAL_NUMBER_NUMERIC
- If this setting is set to true, the SSN will be sorted by numbers, ignoring the prefix. If the setting is set to false, the SSN will be sorted by the text of the prefix. Required Format: true or false. Default: true.
- WEB_CACHE_MAX_FILE_SIZE_DAILY
- Maximum file size for max-age of 1 day. Required Format: numbers. Default: 10M
- WEB_CACHE_MAX_FILE_SIZE_HOURLY
- Maximum file size for max-age of 1 hour. Required Format: numbers. Default: 50M
- WEB_CACHE_MAX_FILE_SIZE_WEEKLY
- Maximum file size for max-age of 1 week. Required Format: numbers. Default: 1M
- WEB_SERVICES_LOGGER_DEFAULT_LEVEL
- Minimum log level. Required Format: error, warn, info, verbose, debug or silly. Default: warn.
- WEB_SERVICES_LOGGER_PER_MODULE
- Setting to be enabled if System Admins want different log levels for different modules.
- WEBTOKEN_EXPIRES_IN
- The time interval by which the web token expires. Default: 10000d.
As minimum requirements, we recommend 2 GB of RAM for the Web App Search docker. Some search settings (SEARCH_FETCH_DELAY_BETWEEN_PAGES, SEARCH_FETCH_ITEM_PER_PAGE, SEARCH_MAX_FILE_SIZE) are interrelated and must be edited consequently so as to correctly manage available RAM and avoid Search Docker RAM overload. An Out Of Memory issue on the docker can lead to Web App slow-down or complete unresponsiveness.
As shown in the above table for System Settings, default search index parameters will load 25 objects per page every 1000 Milliseconds. Each object of the page will be loaded into RAM while indexing. With a default maximum file size of 20,917,520 Bytes (20 Mb), this means there is a maximum potential RAM load of (25 objects * 20 Mb) 500 Mb occupied by a search index. This will leave ample space for adequate search performance during indexing without substantially affecting the total total time period required to fully index the specific environment.
We highly recommend that any combinations of these parameters not exceed half of the allocated RAM for the search docker. For safe measure we have defined them to occupy 25% of recommended RAM. If you wish to adjust any of these three parameters, especially “SEARCH_MAX_FILE_SIZE’, RAM for the Search docker may need to be adjusted correspondingly.
Use this formula to ensure safe use of search settings:
(SEARCH_FETCH_DELAY_BETWEEN_PAGES * SEARCH_FETCH_ITEM_PER_PAGE * SEARCH_MAX_FILE_SIZE) <= (0.5 * Allocated Search docker RAM)
Post your comment on this topic.