Bizagi parameters configuration

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Maintenance and administration > Environment administration >

Bizagi parameters 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 Management Console.

 

MC_Configuration

 

The Environment Configuration has three main options:

Popular

Advanced

Custom

 

EnvironmentConfig2

 

 

note_pin

Before the first deployment, the configuration for ALL environments is performed in Development in Bizagi Studio. The first deployment will take the configuration to each environment. Henceforth changes to Environment Configuration are local to each environment from the Management Console.

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

 

 

Popular

From this option you can configure the parameters of e-mail sending for each environment (Development, Test, Production).

 

EnvironmentConfig3

 

 

The parameters to be configured are:

 

 

OPTION

DESCRIPTION

Notifications options

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. This option depends on your Mail Server configuration, and it is available when the connection type is POP3 or IMAP.

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 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, defines 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.

 

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.

 

Regarding traces and troubleshooting, note that errors are logged according to the platform where processes run:

When having processes run in a .NET platform, any errors related to 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) of how often the Scheduler service will monitor if there are pending jobs.

UPLOADS OPTIONS

Upload Path

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

 

The value for this property may be a local folder or external path located in a remote server. For remote servers, the path must be \\[IP Address or Server Name]\[Folder]\. Make sure you have write permission on such folder in the server.

 

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

 

Keep in mind that [user] will correspond to the user starting the Application Server service (i.e, the root user in a Unix-like OS such as Linux).

Upload Max File Size

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

 

Consider the next table in order to convert to bytes the most common units of measurement for data storage

MEASUREMENT

BYTES

1 KB (Kilobyte)

1.024

1 MB (Megabyte)

1.048.576

1 GB (Gigabyte)

1.073.741.824

SOA OPTIONS

SOA Business Key Enforcement

The option to unmark this checkbox, 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, and the logs of changes in user's configuration

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 number of 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 NOTIFICATION 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.

OPERATIONAL DATA STORE

ODS

ODS (Bizagi Operational Data Store) is an optional mechanism designed to improve Bizagi server's overall availability (enhances performance and reliability as well).

Provider Type

ODS connection configuration. For more information please go to ODS Configuration

 

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). 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 cross icon (red-cross-icon) 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.