CA Agile Central Control Panel
Use the CA Agile Central Control Panel to manage these administrative tasks:
- Change your password
- Back up and restore CA Agile Central data
- Use the CA Agile Central and search services
- Restart the server
- Activate licensing for your subscription
- View subscription details
- Export log files
- Administer server settings
- View Server information and diagnostic tools
- Email all CA Agile Central users
Change your password
CA Agile Central highly recommends that you change your password on a regular basis for access to the Control Panel.
To change your password:
- Click the Change Your Password link at the top-right of the Control Panel screen.
- Enter your new password into the New Password field.
- Retype your new password into the Retype Password field.
- Save your changes by clicking Reset Your Password.
Back up and restore CA Agile Central dataThe back up and restore features help you to manage snapshots of your CA Agile Central data. To access these features, select Back Up/Restore on the Feature menu. Use any of these options:
- Back up
To back up your CA Agile Central application data:
- Click Back Up/Restore on the Feature menu.
- On the Back Up tab, enter the user name and password for the account on your FTP or SFTP server where you will save your data.
- Optionally, you can upload a private key file in PEM format instead of a password when using SFTP during a back up operation.
- Enter the URL for the directory or folder where you will save your backup data, for example, sftp://www.backupserver.com/backupdirectory/.
CA Agile Central suggests you create a directory or folder to hold only CA Agile Central backup files. CA Agile Central automatically creates the file name for your backup data and stores the file in the directory that you indicate in the path. For example:
Use the file name associated with your release:
- 2011.3: 2011.10.22-2-2014-10-10-09-01-49.tgz
- 2012.1: 2012.02.25-7-2014-10-09-16-14-32.tgz
- 2012.2: 2012.05.19-11-2014-10-09-16-33-34-dp.tgz
- 2012.3: master-2947-2014-10-09-15-41-16-dp.tgz
- 2014.1: master-7241-2014-10-09-15-30-09-dp.tgz
- 2014.2 and higher: almci-master-15355-2014-10-09-15-12-47-dp.tgz
You can change the SFTP port for the back up and restore processes from the On-Premises Control Panel. This can be especially useful if your organization does not use the default ports.
You can add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
The custom port is 800 and the default port is 22.
- Click Send.
Upon completion, you will see the message: Your back up completed successfully.
You can restore any CA Agile Central backup file from your storage location to your CA Agile Central application by either type FTP or SFTP.
To restore your CA Agile Central application data:
- Select Back Up/Restore on the Feature menu, then click the Restore tab.
- Select either FTP or SFTP as your file transfer protocol.
- Enter the user name and password for the account on your FTP or SFTP server from where you will retrieve your data.
- If you use SFTP, you can upload a private key PEM file instead of a password during a restore operation.
- To restore data from a server located in your private network, enter the host server name and click Browse FTP.
The FTP Browse window is populated with available directories, folders, and files. FTP Browse is not available when using SFTP.
- Locate and select the file name to restore. The remaining fields (Remote URL and Remote File) are automatically populated with the related information based on your selection.
- Click Send.
You can also change the SFTP port for the back up and restore processes from the On-Premises Control Panel. This can be especially useful if your organization does not use the default ports.
Add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
The custom port is 800 and the default port is 22.
Upon completion of the restore, the resulting log will display the following message: Your restore completed successfully.
You can schedule your back up to run automatically at a time you specify.
To schedule a back up of your CA Agile Central application data:
- Select Back Up/Restore on the Feature menu, then click the Schedule tab.
- Select the Daily or Weekly back up frequency option.
- Enter the user name and password for your FTP or SFTP server.
- If you use SFTP, you can upload a private key PEM file instead of a password during a restore operation. Enter the URL path to the storage folder that you choose. (Note the example format).
- Click Send. A confirmation message indicates a successful schedule. For example:
- Click the Schedule tab again. The Back up Status dialog box on the right of the display now lists the scheduled back up.
- Click the Delete this Scheduled Back up link at any time to delete the scheduled back up.
You can add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
Daily back up has been scheduled for hour 12 AM on host:ftp://atlantis
Use the CA Agile Central and search services
Restart or stop CA Agile Central and manage the search service for your On-Premises installation using the CA Agile Central Services link on the Feature menu.
CA Agile Central service
CA Agile Central suggests all application users be logged out during a restart of CA Agile Central to avoid any conflicts.
To restart CA Agile Central:
- Go to Feature → CA Agile Central Services.
- Click Restart.
Before logging in again, wait five minutes to allow enough time for CA Agile Central to restart all processes.
To stop CA Agile Central:
- Go to Feature → CA Agile Central Services.
- Click Stop.
Once CA Agile Central has stopped, click the Restart button to restart CA Agile Central.
Use the Search Service tab to disable and enable the search service in CA Agile Central. By default, the search service is enabled in CA Agile Central and searches in CA Agile Central are performed using the search service.
To disable the search service, click Disable. The search feature in CA Agile Central is reverted to the default search process and the search service process will be shut down.
The search service provides a process that is scheduled to run once per week to optimize the search service index. This process will remove outdated files to keep the index size as small as possible. However, if you need to run the search index optimization, click Search Index Optimization.
If there is a problem with the search service index, the existing index can be deleted and re-created with the Create Search Index button.
In general, the search service should not need further management or intervention. See the CA Agile Central Monitoring Service section in the Installation Guide for more information on this service.
The restart server feature lets you restart the virtual server and the guest operating system where CA Agile Central is installed. CA Agile Central suggests all application users be logged out during a restart to avoid any conflicts.
To restart the CA Agile Central virtual server:
- Go to Feature → Restart Server.
- Click OK on the confirmation message to continue with the server restart.
- Wait five minutes and log into the server.
Your CA Agile Central virtual machine is restarted and the restart status will be visible through the VMware console for the CA Agile Central virtual machine.
Activate licensing for your CA Agile Central subscription
After successful installation of the CA Agile Central application, import your license file into CA Agile Central to activate you subscription and make it accessible to CA Agile Central users. The <License>.asc file is sent to you in an email from CA Agile Central. It is recommended you save this file to a secure location on your local system.
To import your <License>.asc file:
- Go to Feature → Licensing.
- Add your license key by browsing to your <License>.asc file. Select the file and click Open.
- Click Upload to import your license file.
- Restart CA Agile Central to apply the license to your installation.
The path to your file is stored in the Browse box.
After successful import, a confirmation message is displayed: License successfully imported.
Subscription details contained within your license file are available from Feature → Subscription List.
View subscription details
The subscription list provides the details about your CA Agile Central subscription that are contained within your license file. Use this option to help manage your users and determine any modules that are appended to your installation.
To review your Subscription details, go to Features → Subscription List.
|Subscription_Id||Each subscription contains a minimum of two lines. The first line is the administrator's account automatically created by CA Agile Central. The second line reflects details regarding the users and licenses purchased from CA Agile Central. Each account is given an internal CA Agile Central ID which is reported in this column.|
|Max_Users||The number of user licenses purchased from CA Agile Central.|
|Expiration||The expiration date of your CA Agile Central licenses.|
|Name||The name of your CA Agile Central subscription.|
|State||The status of your subscription such, as Active or Inactive.|
|Is_ XXX_Enabled||A binary value that indicates whether your subscription is enabled for any specific CA Agile Central add-ons such as web services, defect management, and Quality Manager.|
Export log files
CA Agile Central captures a log of server events in text files. These files may be used for diagnostic purposes or troubleshooting problems that may occur with your CA Agile Central installation. Log files are compressed into a single .zip file.
To access your log files:
- Go to Features → Log Files.
- On the pop-up window, select the .zip file you wish to use.
- To review the log file, click Open.
- Click Save to save your .zip file to a location that can be accessed outside of the CA Agile Central Control Panel.
If necessary, email the .zip file to CA Agile Central Support for assistance with diagnosis and troubleshooting.
Administer server settings
Use Server Settings from the Feature menu to configure DNS, mail, and web server information. This information is used with CA Agile Central for access of backup and restore files and email notifications within the application. CA Agile Central suggests configuring DNS settings prior to enabling mail server and backup and restore settings from the Feature menu.
You may also configure Network Time Protocol (NTP) synchronization servers using the Server Settings option.
Configure your DNS settings for your installation on the Network Settings tab.
To enter your DNS settings:
- Go to Feature → Server Settings.
- On the Network Settings tab, enter the domain name of your server in the Search Domain field.
- Enter the primary DNS server address in the DNS Server 1 field.
- Enter the secondary DNS server address, if applicable, in the DNS Server 2 field.
- Click Update to save your settings.
- Verify that the correct data is reflected in the Current DNS Settings section in the lower-left portion of the page.
Reset network configuration
Click the Reset the Network Interface link to reset the CA Agile Central virtual machine so that the Network Configuration Interface prompt will display at the next reboot of the virtual machine and guest operating system to allow for changing the IP address of CA Agile Central or setting up DHCP.
Mail server settings
To use the email-dependent features of CA Agile Central, you must configure the address information for your mail server on the Mail Settings tab. If you have a policy that denies relaying of email, then enter your desired domain information in the Outgoing Email Domain field of the Mail Settings tab.
To enter mail server settings:
- Go to Feature → Server Settings → Mail Settings.
- Complete the following fields as necessary:
- Hostname: Must be a domain name. An IP address must exist for the hostname.
- Port: Default is 25. Another common value is 587, but the value depends on your IT servers and the way mail is set up.
- Mail Server authentication (optional): Both username and password are required if you want to use authentication.
- Outgoing Email Domain (optional): Enter the desired domain information if your organization has a policy that denies relaying emails.
You can click the Clear Settings and Save button to reset settings.
Web server settings
CA Agile Central uses secure HTTP to access your software after a typical installation. Although not recommended, it is possible to override this setting and configure your installation of CA Agile Central to use a non-secure HTTP format using the Web Server Settings tab.
To enable Non-Secure HTTP Access for your web server:
- Go to Feature → Server Settings → Web Server Settings.
- Select the Enable field.
- Click Update to save your changes.
A confirmation message displays. Click OK to exit the window.
Network time settings
The Network Time Protocol (NTP) is a commonly used protocol for synchronizing computer system clocks over data networks. NTP servers provide the synchronization point of reference.
To enter network time settings:
- Go to Feature → Server Settings → NTP Settings.
- Enter your primary NTP server hostname or IP address in the NTP Server 1 field.
- Enter your secondary (backup) NTP server hostname or IP address in the NTP Server 2 field.
- Click Update to save your NTP Server settings.
After a successful update, your NTP Server Settings are listed at the bottom of the page under Current Time Servers at the bottom of the screen.
Delete your NTP server settings at any time with the Click here to clear NTP servers link at the bottom of the screen.
If you have the CA Agile Central LDAP module enabled on your CA Agile Central subscription, this tab provides the setup interface to enter information specific to your CA Agile Central subscription and LDAP environment. For full information about setting up the CA Agile Central On-Premises LDAP module, see Enabling the CA Agile Central On-Premises LDAP Module.
To enter LDAP settings, go to Feature → Server Settings → LDAP Settings.
|LDAP Hostname||Enter the fully qualified host name of the LDAP server.|
|Port||The port number the LDAP server is listening on, typically 389.|
|Enable LDAP over SSL||Select this field to allow CA Agile Central to connect to the LDAP server using SSL. The port number may need to be updated as well if using SSL. For more information about importing a certificate to the CA Agile Central On-Premises server to be able to use LDAP over SSL, see Java Keystore.|
|Select LDAP Vendor||Select the vendor of your LDAP server. Available options are: Active Directory, Oracle Internet Directory (10g or 11g), and Oracle Directory Server 11g.|
|Bind Username DN||Enter the fully qualified name to authenticate to the LDAP server.
Example: CN=LdapReadonly, CN=Users, DC=rallydev, DC=com.
|Bind DN Password||Password for the bind user.|
|LDAP Tree Base DN||The top-level tree node of the LDAP directory where your users and groups are located.
Example: CN=Users, DC=rallydev, DC=com.
|User Name Attribute||The attribute that lives on the LDAP server, which should be a globally unique identifier within the directory. Once users are populated, they will use the value of this attribute as their login name, for example, sAMAccountname.|
|LDAP Group Management
Note: This is not required if you choose authentication with username and password only.
|Require membership in an LDAP group||This checkbox is selected by default. Unchecking the box confirms that users will be logged in through authentication only. If you disable the group membership option, the LDAP user syncing service will no longer be available. Users authenticating with CA Agile Central will no longer be required to have membership in a specific LDAP group.|
|Group Name||The group you created in Setup your LDAP Environment on your LDAP server which contains the users you would like to allow access to CA Agile Central. Multiple groupNames separated by a | (pipe) symbol are allowed. These can be different LDAP groups. Nested groups are NOT supported.
The following Active Directory configurations have been verified:
CN=CA Agile Central Test Group,CN=Users,DC=rallyonprem,DC=local|
|Group Attribute||The group attribute for your LDAP Server. Generally, memberOf is used with Active Directory and isMemberOf, member, or uniqueMember is used with Oracle products. You will need to check with your LDAP administrator to determine which one is in use in your environment.|
Note: This requires LDAP Group Management.
|Enable LDAP Synchronization Service||Enabling this feature will schedule a sync of any newly added users from the LDAP CA Agile Central group to CA Agile Central. This sync is scheduled to occur every 15 minutes.|
|Run LDAP Synchronization Immediately after Save Settings||Force a sync to run right after saving your LDAP settings.|
|CA Agile Central Username||The CA Agile Central subscription or workspace administrator account that will be used to create new CA Agile Central users.|
|CA Agile Central User Password||Password for the CA Agile Central subscription or workspace administrator.|
|Test Connection||Once the LDAP Hostname, Port, Bind Username DN, Bind DN Password, and Group Name have been entered, use this button to test the LDAP connection from the CA Agile Central server. The test will first try to bind to the LDAP server then attempt to search for the Group Name on the LDAP server.|
|Disable LDAP & Restart CA Agile Central||Deletes the LDAP authentication settings on the CA Agile Central server and CA Agile Central is restarted to disable LDAP authentication and enable CA Agile Central authentication.|
CA Agile Central LDAP user report
Once the CA Agile Central On-Premises module is set up and enabled, the LDAP user report is available to show the current provision status of users in your CA Agile Central subscription and the LDAP directory.
Running the report will provide a text file with a list of users and whether they are provisioned in CA Agile Central, LDAP, or both. The file also provides instructions on reconciling the users between the CA Agile Central subscription and LDAP.
Your Secure Sockets Layer (SSL) certificate enables encryption of sensitive information that is transmitted between the browser and the server during online transactions. Your SSL certificate is also used to identify you as the registered owner of the domain that is referenced in the transaction.
You will need the certificate file, key file, and, if a chained SSL certificate is used, the SSL Certificate Bundle file. Customers who install CA Agile Central on premises have the option to generate their own certificate, purchase a certificate from a third party vendor, or use the CA Agile Central certificate that is installed by default.
If the domain owner of the URL does not match the owner of the SSL certificate, you may see an error from your browser warning you of the mismatch. Access to the CA Agile Central Web Services API may also be hindered if the domain owner of the URL does not match the owner of the SSL certificate.
If your users are comfortable with understanding why the mismatch exists, you may click through the error window and continue using the application. If you wish to avoid receiving the error, you will have to generate a certificate for your company domain and install it from the SSL Certificate tab.
To install an SSL certificate:
- Generate or purchase your certificate (this should be a single root or unchained certificate) and copy your certificate (.cert) and key (.key) files to the CA Agile Central server.
- Copy them to a convenient place where you may easily access them for installation.
- Go to Feature → Server Settings → SSL Certificate.
- Click Choose File next to the SSL Certificate indicator to locate your SSL certificate (.cert) file.
- Click Choose File next to the SSL Key indicator to locate your SSL key (.key) file.
- If your SSL Certificate is a chained certificate, select the Chain Certificate File field. Click Choose File next to the SSL Certificate Bundle indicator to locate your SSL certificate bundle file.
- Click Upload to upload and install your certificate and key files.
- Restart the server.
To restore the default SSL certificate:
- Go to Feature → Server Settings → SSL Certificate.
- Click the Restore Default Certificates link at the bottom-left of the SSL Certificate page.
Create an SSL certificate from a third-party vendor
This section assumes the openssl command is available on the system used to create the private keys. You do not need to be on the CA Agile Central machine to do this, but the steps below were created using a Linux machine. The steps may vary using a Windows machine with OpenSSL.
- Generate a private key.
- Generate a Certificate Signing Request (this certificate will be used to generate our ssl certificate on the third party's site.)
- Remove the passphrase from the key.
- Submit your request to your third-party vendor. The SSL certificate that is obtained should be a single root or unchained certificate.
- After submitting your CSR to a third-party vendor they will send you a .crt file. This file is used in combination with the key generated in step 1 to upload to the On-Premises image.
- Verify the format of your certificate by opening the .crt file using a text editor. This file should have the same format as the one below:
- Use the .crt file the vendor sends you in combination with the key file you generated to upload to your On-Premises image.
openssl genrsa -des3 -out www.mydomain.com.key 1024
openssl req -new -key www.mydomain.com.key –out www.mydomain.com.csr
cp www.mydomain.com.key www.mydomain.com.key.org
openssl rsa -in www.mydomain.com.key.org -out www.mydomain.com.key
The CA Agile Central On-Premises LDAP solution supports the ability to connect to an LDAP server over an SSL connection. Before the server can connect securely, the certificate of this server will need to be imported into the Java keystore located on the CA Agile Central On-Premises instance. To get started, locate the SSL certificate used by your LDAP server and copy it to a machine that has access to the CA Agile Central On-Premises Control Panel. Once this is complete follow the instructions below.
Add public keys
- From the CA Agile Central Control Panel, go to Server Settings → Java Keystore.
- Click Browse and select the certificate file from the LDAP server, then click Upload.
- Once the upload has completed, CA Agile Central needs to be restarted before the certificate can be used for LDAP authentication.
View content of a key
After you have uploaded a key, click the View Contents link and verify that the correct key has been uploaded.
Delete a key
Delete a key if necessary from the Delete link. After deleting the key, you must restart CA Agile Central for the key to be deleted from the server cache.
View server information and diagnostic tools
Current server status
The Current Server Status page provides a snap-shot of the CA Agile Central On-Premises machine. The page provides the current disk usage, current memory usage, and the usage of the database on the system. You may download the database usage output if needed to send to CA Agile Central Support.
Search service status
If the Search Service has been enabled, the Search Service status displays at the bottom of the Current Server Status page. This section displays current settings, the index directory size, next and last scheduled index optimizations, and a link to download the Search Service logs should the need arise to review them or send them to CA Agile Central Support.
Network settingsThe Network Settings tab provides a listing of the current network settings on the CA Agile Central On-Premises machine.
The Ping tab provides the Ping utility for network troubleshooting purposes.
Enter a computer name or IP address for a host you are trying to reach. Select the number of times to run the Ping command and then click the Ping button. If you have selected more than one as the number of times to run the Ping command, the output may be delayed as it waits for the Ping command to complete before displaying the output.
The TCP/IP tab provides access to the netcat utility (similar to telnet) to assist with network troubleshooting.
Enter a fully qualified computer name or IP address for a host you are trying to reach and a port number, then click Connect. The utility will attempt to connect to the destination and will provide the result message in the TCP/IP output box. It may take a few seconds for the results to display in the output box.
The Email Test page provides the current status of sendmail on the CA Agile Central On-Premises server, the current size of the sendmail queue, and a way to test sending an email.
To send a test email, enter the to and from addresses in the appropriate fields, then click Test Email. A test email will be sent from the CA Agile Central server. The sendmail log file will display in the Email Test section of the form. It may take a few seconds for the log to display as the page will search the sendmail log file for the recipient of the email and today’s date to display the status of the test email.
Email all CA Agile Central users
The Email All Users link allows the CA Agile Central server administrator to send an email to all the users that currently have an enabled account in CA Agile Central. This can be used to notify CA Agile Central users of upcoming maintenance or other CA Agile Central related messages. It is a text-based email (no HTML or rich text).
The Email All Users page will attempt to send the emails to users that have an account in CA Agile Central and are currently enabled. The email first is routed to the sendmail server on the CA Agile Central server. Delivery is not guaranteed and the page only displays an error if there is a problem with email creation and routing it to sendmail. No other error logging is done.
CA Agile Central login banner
The CA Agile Central Login Banner link allows the CA Agile Central server administrator to enter either a bulleted list or message that displays on the CA Agile Central Login page. No markup text (HTML or XML) is allowed. The markup tags will be displayed as entered. To create a login banner:
- Go to Feature → User Messaging → CA Login Banner.
- Select whether you want to create Bulleted List or a 550-character Message.
- Click Create Message. Your message will then display on the CA login page.