Integrating Configuration Management Database with CA Configuration Automation - Part 2

Document ID : KB000048969
Last Modified Date : 14/02/2018
Show Technical Document Details

Back to Part 1 of the document.

4.2 Install the CA Configuration Automation Connector

You can install the CA Configuration Automation Connectorlocally on the CA Configuration Automation Server(recommended), on the CA Catalyst Server, or on a Windowssystem that is in the same domain as the CA ConfigurationAutomation Server.

Note: If you install the CA Configuration AutomationConnector on the same server hosting the CA CatalystServer, then the Choose Installation Folder, the CA EEM,and the Peer Node Configuration screens are not displayedwhen you run the installation program. The information inthese screens is collected when you install the CA CatalystServer.

Important! We recommend that you do not install the CAConfiguration Automation Server on the CA Catalyst Serverhost because performance problems can occur. If you installCA Catalyst on the CA Configuration Automation server host,you run into port conflicts. Change the default ports toavoid conflicts. Ensure that the CA Catalyst RegistryServer is up and running before you start the CAConfiguration Automation Connector installation.

Follow these steps:

  1. Open CA Configuration Automation installer and complete thefollowing steps:

    1. Click Run the CA Catalyst CA Configuration AutomationConnector Installation Wizard.

      The installer introduction page appears.

    2. Click Next, accept the terms of the License Agreement, andclick Next.

      The Choose Install Folder page opens.

      Note: This page is not displayed if the CA Catalyst components already reside on the system.

    3. Specify the installation folder and click Next.

      Note: The maximum installation path length is 150characters. The installation program blocks paths with morethan 150 characters.

      The Administration Configuration screen appears anddisplays the default CA Catalyst user in the Username field.

    4. Enter the CA Catalyst administrator user password and clickNext.

      The CA EEM Server Configuration screen appears.

  2. Enter the following CA EEM information and click Next.

    Server

    Specifies the CA EEM host server.

    User

    Specifies the name of the CA EEM administrator user.

    Password

    Specifies the password for the CA EEM administrator.

    Application Name

    Identifies the CA Catalyst and CA EEM integration using the following format: CATALYST-<CA_Catalyst_host_name>.

    Note: Use the same EEM Application name that you used during the CA Catalyst server installation.

    Default Catalyst Access for all users

    Select READ-WRITE as the default access for all users.

    The Remote Registry Server Configuration screen appears.

    Note: You can use the same CA EEM Server for CA Catalystand CA Configuration Automation.

  3. Enter the following information and click Next.

    • Registry Host

      Specifies the CA Catalyst Registry host server. Thisrepository contains the USM schema and policies thatcontrol the behavior of other components in the CA Catalystcontainer.

      Note: For detailed information about CA Catalyst architecture and components, see the CA Catalyst Installation Guide.

    • HTTP Port

      Specifies the server port number where you installed the CACatalyst Registry.

    • Secure Server Port

      Specifies the secure server port number where you installedthe CA Catalyst Registry.

    The Catalyst Container Server Configuration screen appears.

  4. Enter the following information and click Next.

    • Node Name

      Specifies the name of the host where the CA ConfigurationAutomation Connector is installed.

    • Bus Port

      Specifies the bus port number for the CA Catalyst server.

    • HTTP Port

      Specifies the HTTP listening port of the CA Catalyst server.

    • HTTP Service Port

      Specifies the SOAP-based web service HTTP network port onthe CA Catalyst server. Other systems use this port to makeAPI remote procedure calls to the CA Catalyst server.

    • HTTPS Service Port

      Specifies the SOAP-based web service HTTPS network port onthe CA Catalyst server. Other systems use this port to makesecure API remote procedure calls to the CA Catalyst server.

    The Peer Node Configuration screen appears.

  5. Enter the following information and click Next.

    • Peer Host

      Specifies the name of the CA Catalyst server.

    • Peer Port

      Specifies the WS Endpoint port number of the CA Catalystserver.

    • Message Bus Host

      Specifies the server where the CA Catalyst message bus isdeployed; typically the same computer that hosts the CACatalyst server.

    • Message Bus Port

      Specifies the bus port number where you installed theMessage Bus.

    The CA Configuration Automation Connector Configurationscreen appears.

  6. Enter the following information and click Next.

    • CA Configuration Automation Server Hostname

      Specifies the name of the CA Configuration Automationserver that the CA Configuration Automation Connectormonitors for alarms and updates.

    • CA Configuration Automation Server Port

      Specifies the port the CA Configuration AutomationConnector uses to communicate with the CA ConfigurationAutomation server.

    • CA Configuration Automation Server User

      Specifies an administrator user who can access the CAConfiguration Automation server.

    • CA Configuration Automation Server Password

      Specifies the password for the specified user.

    • Verify CA Configuration Automation Server Password

      Ensures that the password was entered correctly by matchingthe passwords.

    • CA Configuration Automation Notification Listener Port

      Specifies the port that receives events from CAConfiguration Automation.

    • HTTPS

      Enables https on the target CA Configuration AutomationServer.

    • X.509 Certificate Authentication

      Enables client authentication on the target CAConfiguration Automation Server.

    • Certificate Path

      Specifies the path to the certificate for the CAConfiguration Automation Server User that you configured.

    • Certificate Password

      Specifies the password for the certificate file.

    The Database Server screen appears.

  7. Enter the following information and click Next.

    • Database Type

      Specifies the type of database that the CA ConfigurationAutomation server uses.

    • Server Name

      Specifies the name of the CA Configuration AutomationDatabase host.

    • Port Number

      Specifies the listening port that the CA ConfigurationAutomation database host uses.

    • Instance Name (Optional)

      Specifies the name of the CA Configuration AutomationDatabase instance.

    The Database Configuration screen appears.

  8. Enter the following information and click Next.

    • Database Name

      Specifies the name of the CA Configuration AutomationDatabase.

    • Database User

      Specifies the name of the CA Configuration AutomationDatabase administrator user.

    • Database User Password

      Specifies the password of the CA Configuration AutomationDatabase administrator user.

    • Retype Password

      Ensures that the password is entered correctly by matchingthe passwords.

    The Change Detection Alert Metric and Threshold Levels pageappears.

  9. Enter the following information and click Next.

    • Alert Metric

      Specifics one of the following metrics that are used todetermine the severity level of the alert when combinedwith the threshold values:

      • CountChange

        Specifies the number of changes from the source to thetarget server that the Change Detectionchanges for the specifiedChange Detection metric that is required to assign anInformation severity level to an alert.


        Specifies the minimum number of changes for the specifiedChange Detection metric that is required to assign a Fatalseverity level to an alert.

      The Installation Summary page appears.

    • Review your selections and click Install.

      The CA Configuration Automation Connector installs on thesystem and integrates with the appropriate CA ConfigurationAutomation and CA Catalyst instances. The Install Completepage appears when the installation finishes.

      If the Installation Summary page displays installation errors, view the CATALYST_HOME\CA_Configuration_Automation_Connector_InstallLog.log file to troubleshoot the installation. This file is created when you click Done after the installation finishes. CATALYST_HOME specifies the folder where you insConnector_CAServiceDeskManager.exe file.

      The Introduction screen appears.

  • Click Next, accept the terms of the License Agreement, andclick Next.

    The Choose Container Node screen appears.

  • Select a custom container node and click Next.

    The CA SDM Configuration screen appears.

  • Enter the following CA SDM information and click Next.

    • CA Service Desk Manager User

      Specifies the CA SDM user.

    • CA Service Desk Manager Password

      Specifies the corresponding password of the CA SDM user.

    • Enable TWA Flag

      Specifies to enable or disable the Transaction Work Area(TWA) flag. TWA is an intermediate storage system for thedata.

      Note: For more information about TWA, see the CA SDM Administration Guide.

    The Service Startup screen appears.

  • Keep the check box selected to start the CA SDM Connectorservices automatically after the installation. To performthe post installation steps, clear the check box. ClickNext.

    The Installation Summary screen appears.

  • Review your selections and click Install.

    The CA SDM Connector installs on the system and integrateswith the appropriate product database and CA Catalystinstance.

    The Install Complete screen appears.

  • Click Done.

    Note: If the installation summary page displaysinstallation errors, view the CATALYST_HOME\CA_Service_Desk_Manager_Connector_Install_<Date (MM-DD-YYYY)><Time(HH:MM:SS)>.log file to troubleshoot the installation.CATALYST_HOME specifies the folder where you installed theCA SDM Connector. This file is created after you completethe installation.

    The CA SDM Connector is installed.
  • 4.4 (Optional) Configure the CA SDM Connector

    After the CA SDM Connector installation, you can modify theCA SDM Connector properties that you defined during theinstallation. You can customize the integration byintroducing new CMDB families to participate in theintegration, deploying the CA SDM Connector on thesecondary server, excluding certain CI types, and so on.

    Follow these steps:

    1. Log in to the CA Catalyst Registry UI using the followingURL:
      https://<registryserver:port>/registry/carbon/admin/login.jsp
      • registryserver

        Specifies the name of the server where you installed the CACatalyst Registry.

      • port

        Specifies the CA Catalyst Registry port.

      The Registry Browse page appears.

    2. Click ServiceDeskManagerConnector.xml from the followingdirectory:
      /topology/physical/<NODE-NAME>/modules/configuration
      Note: <NODE-NAME> indicates the hostname where youinstalled the CA SDM Connector.

    3. Click Edit as Text.

    4. Change any of the following properties from the ConnectionDetails table and click Save:

      • DeviceXXXFamilies

        Specifies the list of CMDB families with mapped USM CItypes that require device properties defined by USM importstandards in CA Catalyst. When device properties are notdefined for the CI, the CA SDM Connector uses this propertyto obtain the information from the system on which the CIis hosted.

        For example, the application configuration manager discovers the software that uses the COTS class and Software.COTS family and populates the system with the host name (or DNS name) of the computer on which the application is running. If the system name is not found, the CA SDM Connector uses this property to retrieve the information.

        Default: Software.Application, Software.Operating System, Software.COTS, Software.Database, Soft ware.Application Server, Hardware, Network.Port, Software, Network.Network, Interface Card, Hardware.Storage

      • DeviceXXXRelationships

        Specifies the list of CMDB CI relationship types. CA SDMConnector queries the CI to obtain its device propertiesbased on the relationship type.

        Default: runs, runs on, hosts, is hosted by, contains, is contained by.

      • Domsrv_name

        Specifies the Domserver name to which the CA SDM Connectorsends queries and registers for change notifications.

        Default: Primary server name.

        Format: Domsrv name specified for the Object Manager during the CA Service Desk Manager configuration.

      • Database query parameter size

        Specifies the CA SDM database parameter list size (integeronly) in the where clause query. For more information aboutthe database parameter list size, see your databasedocumentation.

      • Child to Parent

        Specifies the relationship of the service CI and associatedCIs. In CMDB, you can configure a service CI for eitherconsumption or composition. If configured for consumption,the service CI is the provider to consumers and theassociated CIs are dependents in the service graph. If theservice CI is configured for composition, the service isthe ultimate dependent and the provider CIs impact theservice.

        Specify True if the service CI is configured for composition (child-to-parent).

        Specify False if the service CI is configured for consumption (parent-to-child).

        Note: For more information about configuring CI services, see the CA SDM Administration Guide.

      • Exclude_usm_ci_types

        Specifies the USM entity name that the CA SDM Connectorexcludes from processing. You can exclude any CMDBsupported CI type.

        Default: Incident, Problem, Request, Change Order, Alert

      • Exclude_cmdb_relationship_types

        Specifies the CMDB relationship types that the CA SDMconnector excludes from processing. (For each relationshiptype, provide both Provider-to-Dependent andDependent-to-Provider attributes separated by comma (,)).

      • Class

        Specifies the CMDB class which refers to the service CItype (separated by comma (,)).

        Default: Business Service, Infrastructure Service, Other Service

      • Family

        Specifies the CMDB family which refers to the service CItype (separated by comma(,)).

        Default: Enterprise Service

      • Open_incident_threshold

        Specifies the threshold value for the total number of openIncidents per service (including the graph CIs) and a "TooMany Open Incident" alert is sent to CA SOI.

        Default: 1

      • Password

        Specifies the password that is associated with the CA SDMuser.

      • User name

        Specifies the user name for connecting to CA SDM.

        Default: The value entered during installation

      • Window_offset

        Specifies the offset value which is used to calculate thepredicted maintenance windows and an alert is sent to CASOI. The CA SDM Connector will not alert CA SOI about thepredicted maintenance windows until the next day from thepresent time.

        Default: 1440 (one day in minutes).

      • Enable_twa

        Specifies whether the incoming CIs and CI relationshipsshould be saved to TWA or to CMDB.

        Default: false (The data is loaded in the CMDB module of CA SDM)

      • Excluded_activity_types

        Specifies the activities in CA SDM that the CA SDMConnector excludes from publishing to the Catalyst. Providethe activity codes separated by comma (,).

        Default: INIT

      • Time_reporting_min_allowed_value

        Specifies the minimum value (in seconds) to be entered forthe time spent on any activity in CA SDM.

        Default: 180

    5. Import the CA SDM server certificate to theclient-truststore.jks keystore file located under$CATALYST_HOME\registry on the CA SDM server. The passwordfor the keystore is located in the$CATALYST_HOME\registry\repository\conf\axis2.xml file.

    6. Set the NX.env file on the CA SDM server to the followingvalue:
      @NX_SERVLET_SERVER_URL=https://sdm_server_host:8443
    7. Restart the CA SDM Connector Container.

      The changes are applied and the configuration is updated.

    5.0 Copyright

    This Documentation, which includes embedded help systemsand electronically distributed materials, (hereinafterreferred to as the "Documentation") is for yourinformational purposes only and is subject to change orwithdrawal by CA at any time.

    This Documentation may not be copied, transferred,reproduced, disclosed, modified or duplicated, in whole orin part, without the prior written consent of CA. ThisDocumentation is confidential and proprietary informationof CA and may not be disclosed by you or used for anypurpose other than as may be permitted in (i) a separateagreement between you and CA governing your use of the CAsoftware to which the Documentation relates; or (ii) aseparate confidentiality agreement between you and CA.

    Notwithstanding the foregoing, if you are a licensed userof the software product(s) addressed in the Documentation,you may print or otherwise make available a reasonablenumber of copies of the Documentation for internal use byyou and your employees in connection with that software,provided that all CA copyright notices and legends areaffixed to each reproduced copy.

    The right to print or otherwise make available copies ofthe Documentation is limited to the period during which theapplicable license for such software remains in full forceand effect. Should the license terminate for any reason, itis your responsibility to certify in writing to CA that allcopies and partial copies of the Documentation have beenreturned to CA or destroyed.

    TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THISDOCUMENTATION "AS IS" WITHOUT WARRANTY OF ANY KIND,INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ORNONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU ORANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT,FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUTLIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESSINTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA ISEXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCHLOSS OR DAMAGE.

    The use of any software product referenced in theDocumentation is governed by the applicable licenseagreement and such license agreement is not modified in anyway by the terms of this notice.

    The manufacturer of this Documentation is CA.

    Provided with "Restricted Rights." Use, duplication ordisclosure by the United States Government is subject tothe restrictions set forth in FAR Sections 12.212,52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section252.227-7014(b)(3), as applicable, or their successors.

    Copyright © [set copyright date variable] CA. All rightsreserved. All trademarks, trade names, service marks, andlogos referenced herein belong to their respectivecompanies.