Environment configuration

<< Click to Display Table of Contents >>

Navigation:  Advanced settings >

Environment configuration

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 of 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 of 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

Defines the name of the SMTP server. The SMTP can be local (localhost) for specific testing purposes in the Development environment.

For Testing and Production environments the server must be the company's server from where e-mails are sent.

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

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

Depending of your company's requirements the available options are Exchange, POP3 and IMAP.

Enable SSL

Defines whether Bizagi will use SSL to connect to your server or not (it is recommended to enforce use of SSL).

This option depends on your Mail Server configuration, and it is available when the connection type is POP3 or IMAP.

 

Notice that Exchange connections already enforce the use of HTTPS.

Port

Defines the connection Port to your Mail Server. This option is available when the connection type is POP3 or IMAP.

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. Click here for more information about EWS and how to determine it.

When POP3 or IMAP are enabled, define the server's name or IP of your Mail Server

Username

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

Password

The previously mentioned user's password.

WS-Security

Enable legacy web services (asmx)

This option grants access to Bizagi legacy services (asmx). For more information, refer to Web Service Security.

Enable WS-Security

This options grants access to Bizagi secure services (svc). For more information, refer to Web Service Security.

Username

The user name token used for signing.

For authentication purposes of the web services, you must define a user name token (as specified by the WS-Security standard).

Password

Define a password for the above user name token.

X509 Find Value

The common name of the installed X.509 certificate.

X509 Store Location

The location of the store where the X.509 certificate is installed.

You may use the MMC snap-in to verify such information (https://msdn.microsoft.com/en-us/library/ms788967(v=vs.110).aspx).

X509 Store Name

The name of the store where the X.509 certificate is installed.

You may use the MMC snap-in to verify such information (https://msdn.microsoft.com/en-us/library/ms788967(v=vs.110).aspx).

X509 Find Type

The value which filters how to use the Find Value parameter.

For the common name, use FindBySubjectName.

X509 Validation Mode

Choose from the valid options:

ChainTrust: This one validates the certificate using the certification authority. In .NET scenarios, it may be more reliable to use this option.

PeerTrust: This one is validated by the server by checking its trusted store (recommended). PeerTrust implies that the incoming certificate has to be in the Trusted People certificate folder.

PeerOrChainTrust: Any of the previous one.

None: Trust any certificate (not recommended).

 

note_pin

We recommend using an exclusive account to retrieve incoming messages for Email integration. Bizagi will read all incoming messages and will make 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

Scheduler options

Interval

Configures the interval (in hours, minutes and seconds), for how often the Scheduler service will monitor to see if there are jobs pending.

Uploads options

Upload Path

Defines the physical Directory where files uploaded by the client are to be stored.

The default directory in Bizagi  is: C:\Bizagi\[Project name]\Docs.

There are important considerations regarding the path. It will be valid if:

The logged-in user has read/write permissions over the defined folder.

The path is local to the environment where the application is running.

The path can also be in a virtual disk defined on a local path on the server where the application is running.

In any other case, namely, no read/write permissions over the folder or the path specified is remote (such as a file server or an Azure route), then the path will not be valid.

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

Entities 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).

 

This 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.

Abort notifications options

Disable Abort Notifications

When selected the Abort notifications will not be sent. Abort notifications are sent to all users who have pending tasks in a case that is aborted in the Work Portal.

Cryptography options

This group of options is only available when Database Encryption is enabled. For more information, refer to Database Encryption.

Hashing algorithm

Select the hashing algorithm used to convert the key into bits. Available algorithms are: SHA1, SHA2 256.

Encryption algorithm

Select the encryption algorithm that will use the key you’ve set to encrypt information.

Options are: DES, Triple DES 1, Triple DES 2, AES (recommended).

Key file locations

Specify the location of your key file.

Set Authentication properties

To specify valid credentials to access the key file, tick this checkbox.

User name

Enter the username of the user authorized to access the key file

(applies when the set authentication properties is marked).

Password

Enter the password of the user authorized to access the key file

(applies when the set authentication properties is marked).

Domain (optional)

Enter the domain of the user authorized to access the key file

(applies when the set authentication properties is marked).

Operational data store

Provider Type

ODS connection configuration. For more information, refer to ODS Configuration

Query Engine ODS

Provider Type

ODS connection configuration for Query Engine. For more information, refer to Enabling query engine support

 

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, the web.config file of the Work Portal needs to be modified (more specifically, the value associated to the SERVER_NAME key). Please take into account that it is not recommended to change the configuration values directly in the Web.Config file unless it is strictly necessary. Instead, use the Environment Configuration functionality whenever possible.

 

Custom Parameters in Production

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