Configuring the Web Application - Customer.Config

The customer.config configuration file (Automic\Release.Manager\WebUI\customer.config) is an XML file used to set up connections and customize your CDA system.

File Location

The customer.config file of the CDA application is located in the WebUI folder (Automic\Release.Manager\WebUI\customer.config). You can open the file with an editor and change the settings according to your environment.

Encryption

To encrypt passwords or any other sensitive data you have to encrypt the whole configuration section. To know how to do it see: Encryption of Configuration Sections.

Customer Settings

The elements in the configuration file are set up with the following structure:

Here you can configure the following parameters:

Key	Default	Explanation
CalendarWeekRule	FirstFullWeek	Rule of calculating the calendar week. Possible values are: `FirstDay`: indicates that the first week of the year starts on the first day of the year and ends before the following designated first day of the week `FirstFullWeek`: indicates that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year `FirstFourDayWeek`: indicates that the first week of the year is the first week with four or more days before the designated first day of the week Note: The API is not affected by this setting.
Calendar.MaxRecord	100	Maximum number of displayed records
GUI.Export.Max	10000	Defines the maximum amount of entities which can be exported via the Web UI (the API is not affected by this)

Key

Default

Explanation

CalendarWeekRule

FirstFullWeek

Rule of calculating the calendar week. Possible values are:

FirstDay: indicates that the first week of the year starts on the first day of the year and ends before the following designated first day of the week
FirstFullWeek: indicates that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year
FirstFourDayWeek: indicates that the first week of the year is the first week with four or more days before the designated first day of the week

Note: The API is not affected by this setting.

Calendar.MaxRecord 100 Maximum number of displayed records

GUI.Export.Max

10000

Defines the maximum amount of entities which can be exported via the Web UI (the API is not affected by this)

Example

<GlobalDefinition>	
	<add key="GUI.Export.Max" value="10000"/>	
</GlobalDefinition>

<connections>
- <connection>
  Specifies a connection to an AE:
  name: name of the connection as displayed on the AWI login screen (example: AUTOMIC).
  system: AE system name (example:AUTOMIC)
  CDA can be configured for multiple clients on the same AE-system. Each client must have a separate CDA database.
  Click on the image to expand it.
  Important! Multiple AE systems with the same system name are not supported.
  - <system>
    client: Client number (1-9999)
    user: Name of the service user for the connection to the AE (client number, user name and department)
    password: Service user's password
  - <queuetrigger>
    agent: Name of the agent to use to trigger queue runs
    login: Name of the Login object to use to trigger queue runs
  - <connectionStrings>
    - <add>
      connectionString: Connection string to the SQL database for the CDA database and the Reporting database (i.e., the database where the reporting data is stored)
      Syntax
      connectionString="Data Source=##DB SERVER##;Initial Catalog=##DB NAME##;User ID=##DB USER##;Password=##DB PASSWORD##"
      or
      connectionString="##DB SERVER##"
      Parameters
      - Data Source: Replace ##DB SERVER## with your database server name.
      - Initial Catalog: Replace ##DB NAME## with your database name (for example: CDA).
      - User ID: Replace ##DB USER## with your database user.
      - Password: Replace ##DB PASSWORD## with your database user password.
      Examples
      - SQL Server Database:
        connectionString="Data Source=##DB SERVER##;Initial Catalog=##DB NAME##;User ID=##DB USER##;Password=##DB PASSWORD##"
        <add connectionString="Data Source=tcp:localhost,1433;Initial Catalog=ARA;User ID=AUTOMIC;Password=P@ssw0rd" name="MainDatabase"/>
      - Oracle Database:
        connectionString=user id=##DB USER##;password=##PASSWORD##;data source=(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST= ##DB SERVER##)(PORT=##PORT OF LISTENER##))(CONNECT_DATA=(SERVICE_NAME=##DB NAME##)))
        <add connectionString="User Id=ARA_DEV_8_0;password=ara;data source=(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=192.168.40.58)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=vviedb02.sbb01.spoc.global)))" name="MainDatabase"/>
      - PostgreSQL Database:
        connectionString="User ID=<db_user>;password=<db_password>;Host=<db_host>;Port=<db_port>;Database=<db_name>;searchpath=<db_schema>"
        <add connectionString="User ID=ara;password=1a2b3c;Host=vpostgre01;Port=5332;
        Database=ara;Searchpath=public" name="MainDatabase"
        >
      name: is either MainDatabase or ReportDatabase (Note: The user accessing the ReportDatabase requires the right to create tables)
  - <cp>
    ip: IP address or hostname to use for this AE connection
    port: Port number to use for this AE connection
    Example for Multiple CPs
```
<connection name="AE10" system="AE10"> <system user="123/ARA/ARA" password="ara" client="123"> <queuetrigger agent="WINAGENT" login="UC4_RL.LOGIN.ALL"/> <connectionStrings> <add name="MainDatabase" connectionString="User Id=..."/> <add name="ReportDatabase" connectionString="User Id=..."/> </connectionStrings> </system> <cp ip="AESERVER" port="2217"/> <cp ip="AESERVER" port="2218"/> <cp ip="AESERVER" port="2219"/> </connection> 
```
  - <restApi uri>
    Here you define the full URI to access the AE REST API:
    <restApi uri="http://localhost:8088" />

<add>

Each <add> element contains a key and the corresponding value parameter.

Important settings are listed below:

Key	Value
Database.Type	The database backend type which is used. Can be either `MSSQL`, `ORACLE` or `PostgreSQL`. Default: `MSSQL`
ReportDatabase.Type (optional)	The database backend type that is used for Reporting. Can be either `MSSQL`, `ORACLE` or `PostgreSQL`. Note: The user accessing the database needs the right to create tables.
WarnAheadPackageDelaysInDays	If set to true, archived entities will be shown in sublists (for example: Deployment Targets of an Environment), even if the user has not enabled the Show Archived Entities checkbox. Default: 5
References.ShowReferencedArchivedEntities	Handling of referenced archived entities: True: archived entities are shown in sub-lists (for example: targets of an environment), even if the Show Archived Entities option is disabled. False: archived entities are not shown in sub-lists. See: Archiving Entities
Queues.ContinueWithNextOnApprovalTimeout	Defines whether the next execution in a queue run should be started if the current was not approved in time. Default: false
Queues.ContinueWithNextOnConfirmationTimeout	Defines whether the next execution in a queue run should be started if the current was not confirmed in time. Default: false
Queues.ShowQueueRunExecutionsCount	Defines the number of workflow executions visible in the Scheduled Workflow Executions panel. Default: 10
MaxRecentPlaceItems	Maximum number of recent placed items per session Default: 10
InternalAuthentication	Defines whether internal authentication methods should be enabled. Default: enabled
pageSize	Defines the default page size. Possible values: 10, 20, 50, 100. Default: 20
UC4Deployment.ECCURL	The Root URL of the AWI application which is used to show the workflow monitor and edit the workflow. Example `http://my-ecc-server:8080/my-ecc`
UC4Deployment.CallbackURL	The URL which should be used by CA Continuous Delivery Automation to call back to CDA - Also used for approval emails Example: http://my-ara.my-company.com The `fix -queues` command must be executed every time the url changes.
UC4Deployment.AlwaysUseTokens	Defines whether the @global/token is used to validate workflow executions (true) or if a password must be entered instead (false). Within an application workflow, the EXT:@global/username and EXT:@global/token variables can be used as credentials to connect to the CDA Deployment Targets. By default, the EXT:@global/token variable is evaluated as an Automation Engine token. This token can expire if the Application Workflow is blocked or if the execution takes too long. Set the UC4Deployment.AlwaysUseTokens key to "false" if you want to validate a planned execution with your password. Values: true, false Default: true
AutomationEngine.TraceLevel	Defines the trace mode. Values: 0 (no trace), 1, 2, 3. Default: 0
SMTPServer.Host	Defines the host address for the smtp server. For example: smtp.domain.com
SMTPServer.Port	Defines the port for the smtp server. For example: 587 Default: 25
SMTPServer.User	Defines the user for the smtp server.
SMTPServer.Password	Defines the password for the user on the smtp server.
SMTPServer.EnableSSL	Enables/disables the secure connection to the smtp server. Default: true
Notification.Sender.Email	Defines the sender email address. For example: rm-notification@domain.com Default: example@example.org
Notification.Sender.Name	Defines the name of the sender. For example: Notification System Default: Notification System
Notification.DefaultTimezone	Defines the default timezone of the notification. Default: UTC
Reservations.Panels.MaxVisibleReservationTeamItems	Defines how many items can be shown in the Reservation Team sidebar panel. Default: 3
Reservations.Panels.MaxVisibleDeploymentProfileItems	Defines how many items can be shown in the Scope sidebar panel Default: 3
Reservations.ConflictHandling	Defines how the system behaves when Workflow Executions created by Package State Events or the API are in conflict with a Reservation. Values: CONFIRM: Confirms the Workflow Execution, which is executed normally. FAIL: The Workflow Execution fails. Default: CONFIRM
MainNavigation.HideItemsOnMissingPermissions	Defines whether certain main navigation items are hidden from users without enough permissions to work with them. Values: true, false Default: true
DeploymentTargets.ShowInstallationsCount	Defines the maximum number of visible items in the currently installed components panel. Default: 5
REST.DefaultPageSize	Defines the default page size for the REST API Default: 20
Ventum.Bond2.LoadBalancing.TaskExecutors.ProvisioningConfigService.RefreshCycleInSeconds	Defines the default values for refresh cycle (in seconds) of the provision configuration service job. Default: 60

<Integration>
Here you can configure integrations with external systems.

Here you can configure your approval system.

Key	Value
EnableApprovalWorkflows	Switch to enable the start of external approval workflows Default value: false
Workflow.NewApprovalRequest	The workflow which is triggered for approvers (users or usergroups) when an approval request is generated. Default value: UC4.APPROVALS.REQUEST.NEW
Workflow.RejectedApprovalRequest	The workflow which will be triggered if an approval request gets rejected Default value: UC4.APPROVALS.REQUEST.REJECTED
Workflow.ApprovedApprovalRequest	The workflow which will be triggered if an approval requests gets approved Default value: UC4.APPROVALS.REQUEST.APPROVED
Workflow.RevokedApprovalRequest	The workflow which will be triggered if an approval request gets revoked Default value: UC4.APPROVALS.REQUEST.REVOKED
GracePeriod	Timeout duration for approvals/confirmations after the planned start time - can be either a number or a ISO ISO 8601 duration value: If its a number, CDA will consider it as number of minutes ISO 8601 values If GracePeriod is set to 0, there will be no timeout which means that CDA will wait for approval and confirmation indefinitely Examples: `360` will cause the system to wait for approval for 6 hours `PT6H` or `PT360M` will cause the system to wait for approval for 6 hours

Here you can activate the Performance Monitor, which measures AE and DB performance by comparing the AE and total time of events over time.

Key	Value
PerformanceEvents.LogLevel	Type of background task result that will be stored in the database. Possible values: Off: Turns off performance log BackgroundTaskError: Logs background task process errors only BackgroundTask: Log background task processes. All: Logs all events. Default: BackgroundTask
PerformanceMonitor.RecordsMaxAgeTimespan	Execution frequency of the periodical background task used to clean up monitor data in the database. Default: P7D (7 days)
PerformanceMonitor.EnablePerformanceCounter	Enables/disables Performance Counters(CPU usage/ available RAM). Counter data helps you identify system bottlenecks and fine-tune performance. Possible values: true, false. Default: false

Key

Value

PerformanceEvents.LogLevel

Type of background task result that will be stored in the database.

Possible values:

Off: Turns off performance log
BackgroundTaskError: Logs background task process errors only
BackgroundTask: Log background task processes.
All: Logs all events.

Default: BackgroundTask

PerformanceMonitor.RecordsMaxAgeTimespan

Execution frequency of the periodical background task used to clean up monitor data in the database.

Default: P7D (7 days)

PerformanceMonitor.EnablePerformanceCounter

Enables/disables Performance Counters(CPU usage/ available RAM). Counter data helps you identify system bottlenecks and fine-tune performance.

Possible values: true, false.

Default: false

Here you can configure the synchronization interval for Application Packs and the Application calendar and page size.

Key	Value
ApplicationPack.Sync.Interval	Synchronization interval between the Application Pack installed in the Automation Engine and the CDA system Default value: 90 seconds.

Key

Value

ApplicationPack.Sync.Interval

Synchronization interval between the Application Pack installed in the Automation Engine and the CDA system

Default value: 90 seconds.

Here you can configure Deployment related parameters.

Key	Value
Snapshot.MaxReportsPerSnapshot	The maximum number of SnapshotCompare reports which are kept per environment snapshot before the old reports are removed. Default: 10
Agents.Revalidate.Interval	Default: 60
SnapshotTypeRegistry.Reload.Interval	Interval time between reloading the agent list from the engine (in seconds). Default: 60
CustomType.Sync.Interval	Interval time between reloading/synchonizing custom types from the engine (in seconds). Default: 60
Snapshot.AdHoc.Timeout	Timeout period of the adhoc snapshot generation workflow (in minutes( Default: 180
Snapshot.ReportWorkflow.DetailCompare.Timeout	Timeout period of the file comparison workflow (in minutes(. If no callback is received during this time, the button "Show differences" is reactivated. Default: 60

Here you can configure Package related parameters.

Key	Value
AllowUnsafePackageStateTransitions	Default: false
AllowStateChangeWithMissingMandatoryProperties	Default: true

Here you can configure Activity related parameters.

Key	Value
StartTimeTolerance.BeforePlan	Defines how long in advance can an activity be started/restarted before its planned start date (in minutes).
StartTimeTolerance.AfterPlan	Defines for how long can an activity be started/restarted after its planned start date (in minutes).

<Environment>

Here you can configure Environment related parameters.

Here you can configure start times for executions, queue runs, reservations and even additional calendars.

Parameter	Type	Description	Default Value
ExportPeriodBefore	ISO-8601 time span	Period before today for the export of the calendar information	P1M
ExportPeriodAfter	ISO-8601 time span	Period after today for the export of the calendar information.	P6M
ExportPeriodAfter	ISO-8601 time span	Period after today for the export of the calendar information.	P6M
MonthView.NewExecutionStarttime	ISO-8601 time	Default start time of new workflow executions when creating them in the month view.	00:00
MonthView.NewQueueRunStarttime	ISO-8601 time	Default start time of new queue runs when creating them in the month view.	00:00
MonthView.NewQueueRunDuration	ISO-8601 time span	Default duration of new queue runs when creating them in the month view.	PT8H
MonthView.NewEnvironment ReservationStarttime	ISO-8601 time	Default start time of new environment reservations when creating them in the month view.	00:00
MonthView.NewEnvironment ReservationDuration	ISO-8601 time span	Default duration of new environment reservations when creating them in the month view.	P1D

<Calendar>
CDA supports system wide calendars.

name: Name of the calendar (for example: "Public holidays Austria"

file: Path and file name of the iCalendar file to import

url: URL to dynamically retrieve the iCalendar file to import.

reloadInterval: Interval in hours to reload dynamically fetched system-wide calendars. If not set or empty, the default value is applied.

Important! This value is ignored if a URL is specified too.

Note: The path can either be absolute or relative to the root folder.of the web application.

Example: "C:\temp\Austria.ics"

XML snippets for <calendar>:

<Calendar name="Public holidays Austria" file="C:\temp\Austria.ics"/> <Calendar name="Corporate Calendar" url="https://webmail.mycompany.com/calendars/token/CorporateCalendar.ics" reloadInterval="12"/>

Key	Value
ExecutionDlg.DeploymentProfileAutoFill	Defines if the Profile field of the Workflow Execution dialog is prepopulated. Possible values: true, false. Default: true
ExecutionDlg.DeploymentPackageAutoFill	Defines if the Package field of the Workflow Execution dialog is prepopulated. Possible values: true, false. Default: true
ExecutionDlg.InstallMode	Defines if existing installations are to be overwritten or skipped when executing a workflow. Possible values: overwrite, skip. Default: skip
ExecutionDlg.RequirePasswordIfApprovalsAreNeeded	Defines if a password prompt should be enabled if the execution requires approval requests. Default: false

See the configuration file for comments.

Display settings of Actions in Workflows

For more information about how to configure display settings for Workflow Actions (tasks) in the AWI, see: configuration.properties