Home
Administering
Learn how to administer settings in HCL Launch elements and communication between the elements.
Server settings and configuration
After you install HCL Launch, you can modify the server configuration and configure more options.
Server settings
These tables list the settings for several system-wide settings for the server.

Administering
Learn how to administer settings in HCL Launch elements and communication between the elements.
- High availability and failover
  You can configure clustered HCL Launch servers, and agents for high availability. You can also configure agents and agent relays for failover.
- Setting up high-availability clusters
  To configure a high-availability cluster, you store shared files on network storage. Then, you configure multiple servers, set each server to access the same files and database, and configure a load balancer to distribute the traffic between the servers.
- Adding cold standby servers
  You can add cold standby servers to serve as a backup server or for disaster recovery. You must start the secondary server or servers when the active server fails, and network traffic is routed to the secondary servers.
- Backup and recover
  You can back up and recover the contents of your HCL Launch installation.
- Server settings and configuration
  After you install HCL Launch, you can modify the server configuration and configure more options.
  - Increasing the amount of memory that is available to the server
    If you see "Out of memory" errors or are using the server at high capacity, increase the amount of system memory that is available to the server.
  - Modifying the context root of the server
    After you install the server, you can modify the context root, if your server configuration requires it.
  - Enabling maintenance mode
    Maintenance mode stops activity on the server so you can run important tasks that require the server to be idle.
  - Changing the database password
    If you change the password for your database, you must update the password on the server.
  - Changing passwords for the server KeyStore
    You can change the Java™ KeyStore password for the server.
  - Changing passwords for the encryption KeyStore
    You can change passwords for the encryption KeyStore.
  - Changing or updating the JRE of servers
    You can change the JRE of active servers by editing their configuration files.
  - Working with Notifications
    HCL Launch can send email notifications whenever user-defined trigger events occur on the server.
  - Managing locks
    A lock ensures that processes do not interfere with one another. Normally, locks are released after they are no longer needed. Sometimes, a lock is not released, and its associated process is unable to complete.
  - Server settings
    These tables list the settings for several system-wide settings for the server.
- Setting user preferences
  Each user can specify display options for the server, including the language for the server and how the server shows times and dates.
- Agents and agent relay configuration
  After you install an agent for HCL Launch, you can modify its configuration or create an agent relay to facilitate communication to remote relays.
- License management
  HCL Launch provides a 60-day license-free evaluation period. To use all product features after the evaluation period, you must have a license.
- Setting up the wizard for new users
  HCL Launch includes a wizard to help users become familiar with the procedures and steps in creating a deployment. Some configuration is required before the wizard can be used.
- Customizing the table views
  Customize a table view in the HCL Launch application by hiding or showing, and reordering of the table columns.
- Managing data

Server settings

These tables list the settings for several system-wide settings for the server.

Table 1. General settings
Field	Description
External Agent URL*	This is the URL that the HCL Launch server provides to agents as their point of contact. When an agent wants to contact the server, it retrieves this URL and opens a connection on it. This URL must point to the HTTP or HTTPS port of the server.
External User URL*	The URL that users enter to connect to the HCL Launch server. The URL is also used when creating a notification template.
Message of the Day	This message will be displayed on user login or user navigation within web UI.
Enable Maintenance Mode	Maintenance mode stops activity on the server so you can run important tasks that require the server to be idle.
Validate Agent IP	Requires that the agent IP and host name are validated against values that are used the first time that the agent is connected to the HCL Launch server.
Skip Property Updates for Existing Agents	When this toggle button is set to On, when new agents come online, the server does not update their properties. This improves performance, but in this case, agent properties can become out of date.
Enable UI Debugging	Facilitates debugging with the user interface. If this setting is enabled, the performance of the user interface might be affected.
Create Default Children for Plugins	When this option is enabled, empty groups are created when plugins use the auto discovery feature.
Require a Comment For Process Design Changes	Requires that the user provides a comment when the user changes processes.
Default Locale	The default language for the user interface.
Default Snapshot Lock Type	Determines the default lock type when users create snapshots. Lock types are the following values: Only Component Versions, Only Configuration, or Component Versions and Configuration. The initial value is Component Versions and Configuration. Changes are effective after the server is restarted.

Table 2. Component settings
Field	Description
Components copy to CodeStation by default	If this toggle is set to On, newly created components copy artifacts to CodeStation by default. You can still change this setting on individual components.
Enforce Deployed Version Integrity	When this toggle button is set to On, deployed component version artifacts cannot be changed.
Automatic Version Import Check Period (seconds)*	The number of seconds between the times that HCL Launch polls components for new versions. If this value is changed, the server must be restarted before the change becomes effective. Set this value no lower than 15 seconds.
Use Agent Tag For Integration	Enables any agent that is identified by a specific tag to import component versions. If this setting is selected, the Agent Tag for version imports field is shown. Otherwise, the Agent for Version Imports field is displayed. For information about tagging objects, see Adding tags to objects
Agent for Version Imports	The agent that is used to import component versions. The agent must have access to component artifacts. The agent becomes the default agent for new components. This value can be overridden when a component is created. This field is displayed if the Use Agent Tag for Integration toggle button is set to Off. To import artifacts from the server location, install an agent in the same location and specify that agent.
Version Import Records to Retain	The number of version import records to retain during cleanup. Default is 100.
Agent Tag for version imports	Any agent with the specified tag can import component versions. All tagged agents must have access to the artifacts. Tagged agents become the default values for new components. This value can be overridden when a component is created. This field is displayed if the Use Agent Tag for Integration toggle button is set to On.
Enable Safe Edit of Component Processes	Enables you to test component processes before making them available in normal environments. Make updates to your component process, test those updates safely, and then promote to a new version when you are ready, when toggle is set to On.
Require Approval to Promote Component Process	When this option is enabled, any draft component process must be approved by an authorized user before it can be promoted and used in deployments.
Allow Process Locking	When this option is enabled, users with 'Manage Process Lock' permission will be able to lock component processes for editing. Users can also force unlock a process locked by another user.
Require Process Locking	When this option is enabled, users will not be able to edit component processes without locking the process first.

Table 3. Artifact cleanup settings
Field	Description
Daily Cleanup Start Time*	The time when versions are cleaned. The value must be an integer from 0 (midnight) to 23 (11 pm). To preview the component versions that are scheduled for cleaning, click Preview Version Cleanup. See Cleaning up component versions.
Default Application Snapshot Retention (days)*	The number of days application snapshots are kept, by default. A value of `-1` means that they are kept indefinitely. Component and environment settings can override this setting.
Default Version Retention for Component (days)*	The number of component versions to keep, by default. A value of `-1` specifies that all are kept. Component settings can override this setting.
Default Number of Versions to Retain for Component*	The number of versions to retain for each component.
Default Version Retention for Environment (days)*	The number of environment versions to keep, by default. A value of `-1` specifies that all are kept. Environment settings can override this setting.
Default Number of Versions to Retain for Environment*	The number of versions to retain for each environment.
Archive Path	The path where the compressed file that contains the archived component versions is written. If this field is blank, the compressed file is not written, and no archive is kept.
Preview Version Cleanup	To see the versions that are archived using the current settings, click Preview Version Cleanup. See Cleaning up component versions.

Table 4. Deployment history cleanup settings
Field	Description
Enable Deployment History Cleanup	When this toggle button is set to On, deployment history files are reduced. See Cleaning up deployment history files.
Daily Cleanup Start Time	The hour that the daily cleanup process starts.
Daily Cleanup Duration (hours)	The number of hours that the cleanup process runs daily.
Days to Retain Deployment History	The number of days to retain deployment history. This setting can be overridden with the related environment setting.

Table 5. Audit Log settings
Field	Description
Enable Audit Log Entries for Read Events	When this option is disabled, no READ events are recorded in the audit log.
Enable Audit Log Cleanup	When this option is enabled, audit log entries older than the number of days specified in the Days to Retain Audit Log Entries field are removed beginning at the time specified by the Daily Cleanup Start Time field. By default, this option is disabled. See Configuring log rotation settings. Deleting audit logs from Settings > Audit Log > Cleanup Log creates a log entry of event type Audit Log Cleanup that are non-deletable.
Daily Cleanup Start Time	If Enable Audit Log Cleanup is enabled, the time the audit log cleanup starts. The default value is 12:00 AM.
Days to Retain Audit Log Entries	If Enable Audit Log Cleanup is enabled, the number of days that audit log records are retained. The default value is 30.

Table 6. Password requirement settings
Field	Description
Minimum Password Length*	Determines the minimum length for passwords.
Require Uppercase Characters in Passwords	If enabled, passwords must contain at least one uppercase character.
Require Lowercase Characters in Passwords	If enabled, passwords must contain at least one lowercase character.
Require Special Characters in Passwords	If enabled, passwords must contain at least one special character.
Require Number Characters in Passwords	If enabled, passwords must contain at least one numeric character.
Require Password to be Unique From User Information	If enabled, passwords must not match username, actual name, or configured email.

Table 7. Security settings
Field	Description
Discovery Auth Token Expiration Delay(seconds)	Delay in seconds for auth tokens that are created for Auto Discovery Steps to expire. Must be 300 seconds or more.
Configure Auth Token Expiration Delay(seconds)	Delay in seconds for auth tokens that are created for Auto Configure Steps to expire. Must be 300 seconds or more.
Version Import Auth Token Expiration Delay(seconds)	Delay in seconds for auth tokens that are created for Version Import Steps to expire. Must be 300 seconds or more.
Plugin Step Auth Token Expiration Delay(seconds)	Delay in seconds for auth tokens that are created for Plug-in Steps to expire. Must be 300 seconds or more.
Use Default Auth Token Restriction if not specified	Enable the default authentication token restriction for processes that are created in HCL Launch 6.2.6.x and earlier. For these versions, the default token is applied to the most current process version but not other versions. If you want to apply the default token restriction to all pre-6.2.7 process versions, turn on this option. By default, the option is turned off. For more information, see Restricting authentication tokens.
"Keep me logged in" duration (hours)	The number of hours a user remains logged in after checking 'Keep me logged in'.
Trusted proxy list	A regular expression pattern to match IP of the trusted proxies. This value affects all servers; restart the servers for the changes to reflect. If left blank, the proxy headers are not trusted from incoming connections, which further may affect auth-token IP restriction validation and IP logging.

Table 8. WinRS agent installation settings
Field	Description
WinRS Agent	The agent that is used to run agent installation processes on Windows™ computers. The WinRS agent is configured to use the Windows™ winrs command, which enables remote systems to run Windows™ commands. Typically, the agent that is designated as the WinRS agent is used exclusively for this purpose. Note that a WinRS agent must be designated before agents can be installed remotely on Windows™ computers.
WinRS User	The user name for Windows™ Remote Management.
WinRS Password	The user password for Windows™ Remote Management.

Table 9. Mail server settings
Field	Description
Mail Server Host	The host name of the mail server that is used for notifications. HCL Launch can send notifications to users based on user-configured trigger events (to set up notifications, see Creating Notifications in a Notification Scheme). HCL Launch requires an external SMTP mail server to send messages. To disable notifications, leave the field blank.
Mail Server Port	The SMTP port that is used by the notifications mail server.
Secure Mail Server Connection	Specifies whether the SMTP connection is secure. The default value is Off.
Mail Server Sender Address	The sender address for email notifications.
Mail Server Username	The user name for sending email notifications. Some email servers and firewalls treat emails with different sender and user names suspiciously. Therefore, consider specifying the same name for both fields.
Mail Server Password	The user password for sending email notifications.

Table 10. Configuration settings related to earlier versions of the product
Field	Description
Enable "Prompt On Use"	Controls whether user-entered values can be specified at process run time. If this parameter is inactive (the default setting), values must be entered on the plug-in step during process creation. If this option is selected, process designers have the option of requiring users to enter values during run time.
Enable "Allow Failure"	Shows an Allow Failure check box on steps.
Fail Processes With Unresolved Properties	Any running process that cannot resolve a property automatically fails. This setting is enabled by default.
Component Environment Properties Override Environment Properties	If this is enabled, component environment properties will override environment properties when using ${p:propName} notation as opposed to ${p:environment/propName}.

Table 11. External Approval settings
Field	Description
Use Agent Pool For External Approvals	Turn the toggle on to use an agent pool for external approval processes.

Table 12. Legacy Configuration Options
Field	Description
Enable "Prompt On Use"	If checked, the option to set "Prompt On Use" for properties in workflow steps will be displayed.
Fail Processes With Unresolved Properties	If enabled, any running process which comes across a property it cannot resolve will automatically fail.
Component Environment Properties Override Environment Properties	If enabled, component environment properties will override environment properties when using ${p:propName} notation as opposed to ${p:environment/propName}.
Enable Deleting Resources From Environment Resource Tree	If enabled, resources can be deleted globally from a specific environment's resource sub-tree.