Default names for CIs in XL Deploy

If you want to apply the same connectivity CI to multiple new CIs that require it, you can use a default convention to assign one of these CIs as the default. Reserved names are used to provide a consistent method of defining the default CI across the system.

These are the names which indicate that the CI is default:

  • mail.SmtpServer: defaultSmtpServer
  • credentials.UsernamePasswordCredential: defaultNamedCredential
  • credentials.ProxyServer: defaultProxyServer

Each of these configuration items is defined within the Configuration section of XL Deploy and you can configure more than one.

When a new downstream CI is created that uses one of the above connectivity CIs, the system verifies:

  • If a default CI is available using the naming convention, the default CI is displayed in the downstream CI.
  • If no default CI is available but other connectivity CIs are available, those CIs are shown in a drop list. You can associate one of these connectivity CIs with the downstream CI.

For the Proxy Server and Credentials CIs, the default CI is associated with the downstream CI. You can remove the default setting by clicking an “X” next to defaults name. For the SMTP Server, you cannot remove the default CI from the associated downstream CI because the defaultSmtpServer is used whenever it is defined and no other SmtpServer CI is associated with downstream CI.

Notes:

  • When a default CI is created such as defaultProxyServer, this value will only be associated with newly created CIs. It will not be applied to existing CIs.
  • Renaming default CIs will not remove the reference in previously created downstream CIs which use the old default CI. Example: defaultProxyServer is linked to a file.File and then the defaultProxyServer is renamed to oldDefaultProxyServer. The file.File will still be linked to oldDefaultProxyServer.

Important When migrating to version 8.6.0 or later, the defaultCI setting in credentials.UsernamePasswordCredential is not migrated or renamed to defaultNamedCredential.