Configuring CDA via Customer.Config File

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

See more configuration values here: Configuring CDA via RM.CLIENT_SETTINGS/RM.SYSTEM_SETTINGS VARA Objects

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.

Password Obfuscation

You can obfuscate passwords for service users and all database connections with the ucybcryp.exe tool.

Example:

Important! Passwords that are not obfuscated cannot start with --10

To encode whole configuration sections see: Encrypting Configuration Sections

Customer Settings

Important! You cannot manage clients from the customer.config file. The administration of clients must be done via GUI.

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

<System>
- <database connectionString>
  
  connectionString: Connection string to the SQL database for the CDA database and the Reporting database (that is, 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.
    Important! Unencrypted passwords cannot start with --10
  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"
    
    >
    
    Note: If the searchpath parameter is not specified, the default value (public) is used.
  name: is either MainDatabase or ReportDatabase (Note: The user accessing the ReportDatabase requires the right to create tables)
- <ae system>
  
  AE system name (for example, AUTOMIC)
  
  Important!
  - CDA can only connect to one AE system.
  - The systems defined here must have the same connection string.
  - <cp>
    
    ip: IP address or hostname to use for this AE connection
    
    port: Port number to use for this AE connection
    
    Example:
```
<System>
    <database connectionString="User Id=###;password=###;data source=(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=###)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=###)))" />
    <ae system="AUTOMIC">
      <cp ip="###" port="8443" />
    </ae>
    <superadmin names="0/UC/UC" />
  </System>
```
- <superadmin names>
  
  Client (0), name and department of the users that should have access to the REST API. These users will have enough permissions to execute requests via REST API to connect to the client 0 of the Automation Engine, create new clients and add service users.
  
  Format: Client/Name/Department
  
  Example: 0/ADMIN/ADMIN
<IM connection>

Here you can configure the connection to your Infrastructure Manager instance, which allows you to view the list of CDA Applications mapped to Terraform templates. This list is displayed in the Provisioning Templates view of the Release Automation Management section (Administration perspective). For more information, see: Mapping CDA Applications to Terraform Templates
- IM connection
- user
- password
  
  Important! Unencrypted passwords cannot start with --10
Example: connection="http://myServer.local:9000/provisioning" password="--10ab12345678" user="Administrator"
<trustedCertFolder> (optional)

Path to the folder where the Automation Engine TLS/SSL trusted certificates are stored.

Example: C:\Automic\Automation.Platform\Agents\Certificates

This parameter is required if you want to use HTTPS for the Automation Engine and/or Infrastructure Manager REST endpoint with self-signed certificates.
<CustomerAppSettings>
- <add>
  - Database.Type
    
    The database backend type which is used.
    
    Possible values:MSSQL, ORACLE, PostgreSQL.
    
    Default:MSSQL
  - (optional) ReportDatabase.Type
    
    The database backend type that is used for Reporting.
    
    Can be either MSSQL, ORACLE or PostgreSQL.
    
    Notes:
    - The user accessing the database needs the right to create tables.
  - UC4Deployment.ECCURL
    
    The Root URL of the AWI application which is used to show the workflow monitor and edit the workflow.
    
    Example: http://my-awi-server:8080/awi
    
    Note: A fully-qualified host name (FQHN) is required.
  - UC4Deployment.CallbackUrl
    
    Base URL of the Release Manager to connect to.
    
    Example: http://my-cda-server:80/cda
    
    Note: A fully-qualified host name (FQHN) is required.
  - InternalAuthentication
    
    Defines whether internal authentication methods should be enabled.
    
    Default: enabled
  - AutomationEngine.Timeout
    
    Interoperation with the Automation Engine
    
    Default: 300
  - AutomationEngine.TraceLevel
    
    Defines the trace mode.
    
    Values: 0 (no trace), 1, 2, 3.
    
    Default: 0
  - ArtifactLoaderFolderPath
    
    Path to the Artifact Loader tool.
    
    Value: "..\Utilities\ArtifactLoader"
  - System.Agent
    
    Agent to be used on the CDA instances.
    
    Example: WIN01
    
    Default: Value defined in the CDA server settings.
  - System.Login
    
    Login to be used on the CDA instances.
    
    Example: Login.WIN01
    
    Default: Value defined in the CDA server settings.
    
    Note: The Artifact Transfer tool will use the agent/login settings for transferring uploaded files from the Staging folder ..\WebUI\StateFiles\ArtifactFiles to the RM Repo. For more information, see: Consolidating Artifacts in CDA with the RM Repository
  - DownloadLink.Expiration
    
    While downloading artifact files from the RM Repo, CDA creates and stores a downloadable zip file containing the requested files/folders in the StateFiles folder (\Release.Manager\WebUI\StateFiles).
    
    The number of files may increase over time. To prevent disk storage issues, you can configure this parameter to check for expired download links and clean up redundant zip files periodically.
    
    Default(in hours): 24
    
    Note: This key value can be also defined in the RM Client/System Settings VARA objects. For more information, see: Configuring CDA via RM.CLIENT_SETTINGS/RM.SYSTEM_SETTINGS VARA Objects
<SystemMonitor>
Here you can activate the Performance Monitor, which measures AE and DB performance by comparing the AE and total time of events over time.
- PerformanceEvents.LogLevel
  
  Type of background task result that is stored in the database.
  
  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 that is 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.
  
  Values: true, false.
  
  Default: false
<Application>
Here you can configure the synchronization interval for Application Packs and the Application calendar and page size.
- ApplicationPack.Sync.Interval
  
  Synchronization interval between the Application Pack that is installed in the Automation Engine and the CDA system .
  
  Default: 90 seconds.
<Deployment>
- Agents.Revalidate.Interval
  
  Validation interval between the Agents and CDA.
  
  Default: 60 seconds.
- SnapshotTypeRegistry.Reload.Interval
  
  Reload interval of the snapshot registry.
  
  Default: 60 seconds.
- CustomType.Sync.Interval
  
  Synchronization interval between the custom types and CDA.
  
  Default: 60 seconds.
<DeploymentCalendars>
Here you can configure start times for executions, queue runs, reservations, and even more calendars.

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 - Configuring Your Local Setup