Environment configuration

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Bizagi Studio user interface explained > Advanced settings > Configuration >

Environment configuration

Overview

The Environment Configuration determines the way in which the email sending, scheduler, uploads and logging options are configured. This option is found in the Configuration Tab in Bizagi Studio's Standard Menu.

 

EnvironmentConfig1

 

The Environment Configuration has three main options:

Popular

Advanced

Custom

 

EnvironmentConfig2

 

note_pin

Before the first deployment, the configuration for all the environments is set in the Development environment through Bizagi Studio.

The first deployment will publish this configuration to each environment. Henceforth changes to Environment Configuration are local to each environment.

If you want those changes to be permanent, and become part of the process design, please make them in all your environments as well.

 

Popular

In this option, you can configure the parameters for e-mail sending for each environment (Development, Test, Production) in the Email configuration options.

You can also configure an account to retrieve emails sent to Bizagi, when the project has enabled the option to Complete Tasks via email. This functionality is called Email integration.

 

EnvironmentConfig3

 

The parameters to be configured are:

 

 

OPTION

DESCRIPTION

Email configuration

Enable Email

Allows or restricts Bizagi to send e-mails. If checked, e-mails will be sent. If not checked, e-mails will be ignored.

SMTP Server

The Bizagi cloud offering includes the SMTP service. Therefore, Bizagi includes the SMTP server configuration when provisioning your Automation Service's environments. These parameters cannot be changed through deployment. Any request related to the SMTP configuration or parameters must be done with a support ticket.

SMTP Server Account

Defines the SMTP account (or address) used to send e-mails. It must be a valid e-mail address on the SMTP server.

If local server (localhost) is used the e-mail address may be a non-valid one. If a real SMTP server is used, the address must belong to the domain.

Send Email Copy to

Defines an e-mail account to which a copy of all mails sent by the application will be sent.

Send Email BCC to

Defines an e-mail account to which a BLIND copy of all mails sent by the application will be sent.

Email integration

For Automation Service customers: you can configure your own Email account for Email Integration. The account must be Exchange and cannot use Multifactor authentication. If you don't have an account that meets these requirements, Bizagi can provide the account, just request it by creating a ticket in our support platform.

Enable lookup email

Enables the possibility to retrieve emails from the configured account to be able to Complete tasks via email, without entering the Work Portal.

Connection type

Only Exchange is supported, POP3 and IMAP are not supported.

Enable SSL

As Exchange type does not support SSL. This option is always turned off and cannot be changed.

Port

As Exchange type does not support SSL. This option is not editable.

Account

Defines the account that will receive the email replies sent by end users.

Mailbox Service / Host

When Exchange is selected the host field should be the URL for your EWS virtual directory. In other words, the Mailbox service receives the Exchange Web Service URL, which is an .asmx URL, the default URL for this service is https://[MailServer]/EWS/Exchange.asmx. For example, for Office 365, the URL is https://outlook.office365.com/EWS/Exchange.ASMX.

Username

Defines a valid username within your Mail server in order to perform the connection.

Password

The previously mentioned user's password.

WS-Security

Enable legacy web services (asmx)

Not available.

Enable WS-Security

This options grants access to Bizagi secure services (svc). You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

Username

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

Password

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

X509 Find Value

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

X509 Store Location

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

X509 Store Name

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

X509 Find Type

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

X509 Validation Mode

You must request a ticket to activate the WS-Security option, and the Bizagi operations team configures this.

SMS configuration

Default country code

This code will be used if a user's phone number doesn't have one.

Code validity period

The time in minutes in which the sent code will be valid.

Number of codes allowed

The number of times a user can request a code. Bizagi will not send any more codes if the number of requests reaches this number. Codes can be requested again when the time-out to between requests expires.

Time-out between code requests

The time in minutes that Bizagi will wait before sending new codes after reaching the maximum number of codes allowed.

Provider

Your SMS provider. Currently, our supported provider is Twilio.

Account SID

The security identifier that acts as a username.

Auth token

The security identifier that acts as a password.

From numbers

The numbers used to send the code according to the end user's location. The default number is used when there is no match for the user's country code.

 

note_pin

We recommend using an exclusive account to retrieve incoming messages for Email integration. Bizagi will read all incoming messages and will mark them as Read.

Any errors arisen from Email integration setup are recorded in Window's Event viewer.

 

Advanced

From this option you can configure the parameters of Advanced features for each environment (Development, Test, Production).

 

EnvironmentConfig4

 

The parameters that can be configured are:

 

OPTION

DESCRIPTION

Uploads options

Upload Path

Does not apply to cloud environments.

Upload Max File Size

Defines the maximum allowed size in bytes of files to be uploaded.

SOA options

SOA Business Key Enforcement

The option to unmark it, is available for Bizagi .NET.

If checked, using the SOA layer Bizagi will display an exception when attempting to register a business key pointing to either a parameter or master entity that does not exist in Bizagi.

If not checked the business key will be saved as null.

Log options

Enable Job Logging

Enables the logging of information on every job execution.

Enable Entity Logs

Enables the logging of information on the entities.

Enable M-M relations logs

When enabled Bizagi will create a log in the database (Attriblog) when there are any changes (relating or un-relating) in M-M (multiple-to-multiple) relationships.

Entity options

(1) Attributes Length Maximum Threshold AND (2) Parameter Entities Instances Cache Threshold

Parameter entities in the Work Portal are handled in Cache if the length of the attributes in the entity is less than the first parameter AND the number of records is less than the second parameter.

 

Parameter entities that have more attributes or more records than the thresholds will be loaded by demand (accessing the DB).

 

These parameters are used to refine the application's performance when there is a big data volume.

Web services interfaces options

Timeout

This parameter is used to configure a Timeout for synchronous Web Services. If the value specified is less than or equal to zero, it will be ignored. Thus, Bizagi will wait for a reply with success or failure, no matter how long it takes. Since this can cause blockages, we suggests setting a value.

Logging Threshold

Threshold time in seconds to log interfaces that last more than this time.

Cancel notifications options

Disable cancel notifications

When enabled, the Canceled case notifications are not sent. Canceled case notifications are sent to all users who have pending tasks in a case that is canceled in the Work Portal.

Include events on notifications

When enabled, the Canceled case notifications are sent to all users allocated to the case events.

Security

Trusted domains (CORS)

Cross-origin Resource Sharing

Define the domains that can interact with Bizagi. If you haven't defined a domain, all the domains are disabled by default. When using Web parts for portals integration, you must add the domain of the site you are integrating in this parameter.

Domains should be comma separated.

Proxy Settings

Enable Proxy

Enable the application to use the proxy server.

URL

Define a valid URL of your proxy server.

Port

Define a valid port of your proxy server.

Proxy Authentication

If the proxy server needs credentials, enable to send them.

 

Custom

From this option you can add, edit, and delete the different project parameters for each environment (Development, Test, Production).

 

EnvironmentConfig5

 

To add new parameters, click the plus sign (green_plus_add_flat). A new window displays. Define the name, value, and description for the parameter.

The edit button will display the same window, but with the information of the selected parameter.

Selecting a parameter and clicking the trashcan icon (red-cross-icon-flat) will remove the parameter.

 

Custom parameters can then be used in a Scripting Expression in the following way:

 

CHelper.getParameterValue("PARAMETER_NAME") ;

 

If you create a custom parameter named LOGOSPATH, you can use it in an Expression in the following way:

var tmp = CHelper.getParameterValue("LOGOSPATH");

 

note_pin

In case you want to set a different address for the User Portal, use the Environment Configuration functionality.

 

Custom Parameters in Production

To guarantee the correct performance of all environments, once deployed Custom Parameters will not be available to edit or delete.


Last Updated 11/25/2024 1:30:46 PM