Bizagi parameters configuration

<< Click to Display Table of Contents >>

Navigation:  Bizagi Cloud Management > Management console >

Bizagi parameters configuration

applies_enterprise

Overview

The Environment Configuration determines the way in which the email sending, scheduler, uploads and logging options are configured.

These options are found in the Environment Tab in the Bizagi Management Console.

 

console_environment

 

The Environment Configuration has three main options:

Popular

Advanced

Custom

 

environment_tabs

 

 

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 of the environments. From then on 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 email sending for your environment.

 

console_environment

 

 

The parameters to be configured are:

 

 

OPTION

DESCRIPTION

Email Configuration

Enable Email

Allows or restricts Bizagi to send emails. If checked, emails will be sent. If not checked, emails 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 emails are sent.

SMTP Server Account

Defines the SMTP account (or address) used to send emails. 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 email account to where a copy of all mails sent by the application will be sent

Send Email BCC to

Defines an email account to where a BLIND copy of all mails sent by the application will be sent

Skip Recipients

 

Email Recipient

 

Email integration

Enable lookup email

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

Connection type

Depending on your company's requirements the available options are Exchange, POP3 and 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 username within your Mail server in order to perform the connection.

Password

The previously mentioned user's password.

 

note_pin

It's strongly recommended setting the SMTP Server to ensure your emails are sent correctly.

Email integration is currently supported for Microsoft Exchange accounts.

 

Advanced

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

 

environment_advanced

 

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 check whether there are pending jobs.

UPLOADS OPTIONS

Upload Max File Size

Defines the maximum file size allowed 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

If checked, using the SOA layer Bizagi will display an exception if you attempt to register a business key pointing to a parameter 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) of when there are any changes (related or un-related) 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).

 

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

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. Therefore, Bizagi will wait for a reply of success or failure, no matter how long it takes. Since this can cause blockages we suggest 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, 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.

 

Custom

From this option, you can add, edit and delete different project properties for your environment.

 

environment_custom

 

To add new parameters, hover over the add icon (add_icon) that will transform into the Add Property icon and click on it. A new window will appear. Define the name, value and description for the parameter.

 

add_property

add_custom

 

The edit button (edit_icon) will display the field Value to be edited.

 

edit_property

 

Clicking on the trash icon (trash_icon) will remove the property.

 

delete_property

 

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"); 

 

Custom Parameters in Production

To guarantee the correct performance of all environments, once deployed Custom Parameters cannot be edited or deleted.