Configuring the RM.CLIENT_SETTINGS/RM.SYSTEM_SETTINGS VARA Objects

The RM.CLIENT_SETTINGS and RM.SYSTEM_SETTINGS VARA objects contain global definitions (general configurations for the web applications), application, approval, deployment-related, and execution parameters for CDA. The RM.CLIENT_SETTINGS VARA object is created by the Release Manager Unified Upgrade tool.

If you have installed a new CDA system manually or with the ONE Installer, or if you have performed a manual upgrade of the system, you can change the default configuration by creating the objects manually or importing the VARA templates located in the Automic\Release.Manager\AE folder.

Note: The RM.CLIENT_SETTINGS and RM.SYSTEM_SETTINGS VARA objects are case sensitive. Make sure to define them in uppercase if you create them manually.

Folder Location

The RM.SYSTEM_SETTINGS (only in client 0) and RM.CLIENT_SETTINGS VARA objects are located in the <No Folder> folder of the Process Assembly Explorer.

Important! This page shows the list of settings that can be configured in the VARA objects. Note that not all these settings are defined in the VARA object templates located in the installation bundle (Automic\Release.Manager\AE).

Keys

• Activity

  • Activity.GracePeriod

    Timeout duration for executions after the planned start time - can be either a number or an ISO 8601 duration value:

    • If it is a number, CDA considers it as number of minutes
    • ISO 8601 values
    • If GracePeriod is set to 0, there is no timeout, which means that CDA waits for activities indefinitely

    Examples:

    • 360 causes the system to wait for approval for 6 hours
    • PT6H or PT360M cause the system to wait for approval for 6 hours

• ApprovalSystem

  Here you can configure your approval system.

  • ApprovalSystem.EnableApprovalWorkflows

    Switch to enable the start of external approval workflows

    Default: False

  • ApprovalSystem.GracePeriod

    Timeout duration for approvals/confirmations after the planned start time - can be either a number or an ISO 8601 duration value:

    • If it is a number, CDA considers it as number of minutes
    • ISO 8601 values
    • If GracePeriod is set to 0, there is no timeout, which means that CDA waits for approval and confirmation indefinitely

    Examples:

    • 360 causes the system to wait for approval for 6 hours
    • PT6H or PT360M cause the system to wait for approval for 6 hours

    Default: 0

  • ApprovalSystem.Workflow.ApprovedApprovalRequest

    The workflow which is triggered if an approval request is approved.

    Default: UC4.APPROVALS.REQUEST.APPROVED

  • ApprovalSystem.Workflow.NewApprovalRequest

    The workflow which is triggered for approvers (users or usergroups) when an approval request is generated.

    Default: UC4.APPROVALS.REQUEST.NEW

  • ApprovalSystem.Workflow.RejectedApprovalRequest

    The workflow which is triggered if an approval request gets rejected

    Default: UC4.APPROVALS.REQUEST.REJECTED

  • ApprovalSystem.Workflow.RevokedApprovalRequest

    The workflow which will be triggered if an approval request is revoked.

    Default: UC4.APPROVALS.REQUEST.REVOKED

• Configuration

  • Configuration.RefreshCycleInSeconds

    Whenever the VARA objects are updated, the CDA server loads the new values and uses them for further operations.

    Default: 600 seconds

• Deployment

  • Deployment.Snapshot.AdHoc.Timeout

    Default: 180 seconds

  • Deployment.Snapshot.MaxReportsPerSnapshot

    Default: 10

  • Deployment.Snapshot.ReportWorkflow.DetailCompare.Timeout

    Default: 60 seconds

• DeploymentCalendars

  • DeploymentCalendars.ExportPeriodAfter

    Period after today for the export of the calendar information.

    Type: ISO-8601 time span

    Default: P6M

  • DeploymentCalendars.ExportPeriodBefore

    Period before today for the export of the calendar information.

    Type: ISO-8601 time span

    Default: P1M

  • DeploymentCalendars.MonthView.NewExecutionStarttime

    Default start time of new executions when creating them from the month view.

    Default: 00:00

  • DeploymentCalendars.MonthView.NewQueueRunStarttime

    Default start time of new queue runs when creating them in the month view.

    Default:00:00

  • DeploymentCalendars.MonthView.NewQueueRunDuration

    Default duration of new queue runs when creating them from the month view.

    Default:PT8H

  • DeploymentCalendars.MonthView.NewEnvironmentReservationStarttime

    Default start time of new environment reservations when creating them from the month view.

    Default:00:00

  • DeploymentCalendars.MonthView.NewEnvironmentReservationDuration

    Default duration of new environment reservations when creating them from the month view.

    Default:P1D

  • DeploymentCalendars.MonthView.NewEnvironmentActivityStarttime

    Default start time of new environment activities when creating them from the month view.

    Default:00:00

  • DeploymentCalendars.MonthView.NewEnvironmentActivityDuration

    Default duration of new environment activities when creating them from the month view.

    Default:PT1H

• DeploymentTargets

  • DeploymentTargets.ShowInstallationsCount

    Defines the maximum number of visible items in the currently installed components panel.

    Default: 5

• Environment

  • Environment.Calendar

    Defines the calendar pagesize of the environment.

    Default: 100

  • Environment.Reservation.Calendar

    Defines the calendar pagesize of the environment reservation.

    Default: 100

• Execution

  • Execution.ExecutionDlg.DeploymentPackageAutoFill

    Defines if the Package field of the Workflow Execution dialog is prepopulated.

    Possible values: true, false.

    Default: true

  • Execution.ExecutionDlg.DeploymentProfileAutoFill

    Defines if the Profile field of the Workflow Execution dialog is prepopulated.

    Possible values: true, false.

    Default: true

  • Execution.ExecutionDlg.InstallMode

    Defines if existing installations are to be overwritten or skipped when executing a workflow.

    Possible values: overwrite, skip.

    Default: skip

  • Execution.ExecutionDlg.RequirePasswordIfApprovalsAreNeeded

    Defines if a password prompt should be enabled if the execution requires approval requests.

    Default: false

• GlobalDefinitions

  • GlobalDefinitions.Calendar.MaxRecord

    Defines the maximum number of records displayed

    Default: 100

  • GlobalDefinitions.CalendarWeekRule

    Rule for calculating the calendar week.

    Default: FirstFullWeek

    Values:

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

  • GlobalDefinitions.GUI.Export.Max

    Defines the maximum number of entities which can be exported via the Web UI.

    Default: 10000

• MainNavigation

  • MainNavigation.HideItemsOnMissingPermissions

    Defines whether certain main navigation items are hidden from users without enough permissions to work with them.

    Values: true, false

    Default: true

• Notification

  • Notification.DefaultTimezone

    Defines the default timezone of the notification.

    Default: UTC

  • Notification.Sender.Email

    Defines the sender email address.

    Example: rm-notification@domain.com

    Default: example@example.org

  • Notification.Sender.Name

    Defines the name of the sender.

    Default: Notification System

• Package

  Here you can configure package-related parameters.

  • Package.AllowStateChangeWithMissingMandatoryProperties

    Default: true

  • Package.AllowUnsafePackageStateTransitions

    Default: false

• PageSize

  Defines the default page size.

  Possible values: 10, 20, 50, 100.

  Default: 20

• Queues

  • 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

• References

  • 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

• Reservations

  • 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

  • Reservations.Panels.MaxVisibleDeploymentProfileItems

    Defines how many items can be shown in the Scope sidebar panel

    Default: 3

  • Reservations.Panels.MaxVisibleReservationTeamItems

    Defines how many items can be shown in the Reservation Team sidebar panel.

    Default: 3

• REST

  • REST.DefaultPageSize

    Defines the default page size for the REST API.

    Default: 20

• SMTPServer

  • SMTPServer.EnableSSL

    Enables/disables the secure connection to the smtp server.

    Default: true

  • SMTPServer.Host

    Defines the host address for the smtp server.

    Example: smtp.domain.com

  • SMTPServer.Password

    Defines the password for the user on the smtp server.

  • SMTPServer.Port

    Defines the port for the smtp server.

    Example: 587

    Default: 25

  • SMTPServer.User

    Defines the user for the smtp server.

• UC4Deployment

• 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

  Important! This key has to be added manually by the user.