Previous Topic: Custom Roles and PoliciesNext Topic: Log Storage


Services and CA Adapters

This section contains the following topics:

Services Tasks

Delete a Service Host

Edit Global Configurations

Edit a Global Service Configuration

Edit a Local Service Configuration

Service Configurations

CA Adapters Configuration Tasks

System Status Tasks

Services Tasks

You can set global configurations that apply to all CA User Activity Reporting Module servers. You can view and edit two types of individual service configurations: A global service configuration applies to all the instances of a single service in your environment, and a local service configuration only to a selected individual service host.

Note: Global configurations are distinct from global service configurations: the first controls the behavior of all CA User Activity Reporting Module servers, and the second that of a chosen service. For example, you can set the update interval for all services (global configuration), or report retention policies for all report servers (global service configuration).

You can also view self-monitoring events from the service configuration areas.

Available services include:

You can display some services by service name, or by host. You can use the System Status service to gather information about, and to control, an individual CA User Activity Reporting Module server.

More information:

Edit a Global Service Configuration

Edit a Local Service Configuration

Delete a Service Host

If you uninstall a CA User Activity Reporting Module server, you must delete the host configuration from the management server repository. The removal of this reference will keep the server up to date with the list of its registered CA User Activity Reporting Module servers.

To delete a service host

  1. Click the Administration tab, and then click the Services subtab.

    The Service List appears.

  2. Click Host in the Show Services By dialog at the top of the list.

    An expandable tree list of service hosts appears.

  3. Select the host you want to delete, and click Delete.

    The host is removed from the list.

Important! No warning appears when deleting a host. Clicking Delete immediately removes the host, so you must be sure you want to delete the host.

Edit Global Configurations

You can set global configurations for all services. If you attempt to save values outside the allowed range, CA User Activity Reporting Module defaults to the minimum or maximum as appropriate. Several of the settings are interdependent.

To edit global settings

  1. Click the Administration tab and the Services subtab.

    The Service List appears.

  2. Click Global Configuration in the Service List.

    The Global Service Configuration details pane opens.

  3. Change any of the following configuration settings:
    Update Interval

    Specifies the frequency, in seconds, at which server components apply configuration updates.

    Minimum: 30

    Maximum: 86400

    Session Timeout

    Specifies the maximum length of an inactive session. If auto-refresh is enabled, a session never times out.

    Minimum: 10

    Maximum: 600

    Allow Auto Refresh

    Lets users auto-refresh reports or queries. This setting lets administrators globally disable auto-refresh.

    Auto Refresh Frequency

    Specifies the interval, in minutes, at which the report views refresh. This setting depends on the selection of Allow Auto Refresh.

    Minimum: 1

    Maximum: 60

    Enable Auto Refresh

    Sets auto-refresh in all sessions. Auto-refresh is not enabled, by default.

    Viewing Action Alerts Requires Authentication

    Prevents Auditors or third-party products from viewing Action Alert RSS feeds. This setting is enabled by default.

    Default Report

    Specifies the default report.

    Enable Default Report Launch

    Displays the default report when you click the Reports subtab. This setting is enabled by default.

  4. Change any of the following report or query tag settings:
    Hide Report Tags

    Prevents specified tags from appearing in any tag list. Hiding report tags streamlines the view of the available reports.

    Hide Query Tags

    Lets you hide chosen tags. Hidden tags do not appear in the main query list or the action alert scheduling query list. Hiding query tags customizes the view of the available queries.

  5. Change any of the following Dashboard settings:
    Enable Default Dashboard Launch

    Displays the default dashboard when you click the Queries and Reports tab. This setting is enabled by default.

    Default Dashboard
  6. Change any of the following Profiles settings:
    Enable Default Profile

    Lets you set the default profile.

    Default Profile

    Specifies the default profile.

    Hide Profiles

    Lets you hide chosen profiles. When the interface refreshes or the Update Interval expires, the hidden profiles do not appear. Hiding profiles customizes the view of the available profiles.

    Note: Click Reset to restore the last saved values. You can reset a single change or multiple changes until you save changes. After you save changes, reset your changes individually.

  7. Click Save.

Edit a Global Service Configuration

You can edit global service configurations, which are settings that apply to all instances of a given service in your environment. A global service configuration does not override any local service setting that differs from the global setting.

The maximum and minimum configuration values are detailed in the specific service sections. If you attempt to save values outside the allowed range, CA User Activity Reporting Module defaults to the minimum or maximum as appropriate.

To edit a global service configuration

  1. Click the Administration tab, and then click the Services subtab.

    The Service List appears.

  2. Select the service whose configuration you want to edit.

    The Global Service Configuration display opens in the details pane.

  3. Make the configuration changes you want.

    Note: You can click Reset to restore the entry fields to the last saved value. You can reset a single change or multiple changes up to the point you click Save. Once you have saved changes you must reset your changes individually.

  4. Click Save when you are finished making changes.

    Any configuration changes you are applied to all hosts of the selected service, unless they have different local settings.

Edit a Local Service Configuration

You can view or edit local service configurations by service or by host server. Local service configurations let you control services or settings that may not apply, or be required, for your entire environment, overriding global settings only for specific hosts. For example, you may want a specific CA User Activity Reporting Module server to retain action alerts longer than others. You control this using a local configuration.

The maximum and minimum configuration values are detailed in the specific service sections. If you attempt to save values outside the allowed range, CA User Activity Reporting Module defaults to the minimum or maximum as appropriate.

To edit a local service configuration

  1. Click the Administration tab, and then click the Services subtab.

    The Service List appears.

  2. Click the arrow beside the service whose configuration you want to edit.

    The service display expands, showing individual service hosts.

  3. Click the service host you want.

    The service configuration you select opens in the details pane.

  4. Make the configuration changes you want. Every entry field, menu, or control in the local configuration displays a local/global configuration button which can be toggled to one of two states.

    Global configuration: Configuration button, showing global setting

    Local configuration: Configuration button, showing local setting

    Clicking the button changes it from the global to the local setting, and makes its associated value available for use. The value must remain set for local configuration for the setting to take effect: If it is set for global configuration, the global setting for that listener is in effect.

    Note: Clicking Reset shows the most-recently saved configuration values for all the available configurations. You can reset a single change or multiple changes up to the point you click Save. Once you have saved changes you must reset your changes individually.

  5. Click Save when you are finished making changes.

    Any changes you make are applied to the selected service host only.

Service Configurations

This section includes details and service guidelines to review when making configuration changes in the following CA User Activity Reporting Module services:

More information:

Subscription

Alerting Service Considerations

The Alerting Service controls the delivery of action alerts. You can perform the following tasks from the alerting service configuration area:

More information:

Configure Integration with an SNMP Trap Destination

Configure CA User Activity Reporting Module to Work with ObserveIT

Configure CA IT PAM Integration

You can configure CA IT PAM integration to leverage either or both of the following types of CA IT PAM processes:

The following procedure addresses both the common settings.

To configure IT PAM integration

  1. Click the Administration tab, and the Services subtab.
  2. Click Alerting Service.

    The Global Service Configuration: Alerting Service dialog appears.

  3. Scroll to the IT PAM area.
  4. Enter the fully qualified host name of the server on which CA IT PAM is installed, accept the default port number, 8080, and enter valid login credentials for CA IT PAM.
  5. Do the following for the event/alert output process in the Event/Alert Output Process section:
    1. If you have imported the sample EventAlertOutput.xml for use, accept the default entry for Event/Alert Output Process. If not, replace this entry with your custom event/alert output process name preceded by its path.

      Note: You can view the Name and Path of the process under Folders in the ITPAM Client.

    2. If you have imported the sample EventAlertOutput.xml for use, define the default values for ReportedBy, Severity, Priority, and EndUser as follows:
      1. Select a parameter and click Add Default Value.

        The Add Value dialog appears.

      2. Enter the default value and click OK.
    3. If you specified a custom event/alert output process, delete the displayed parameters and add your own. Then define the default value for each.
  6. Do the following for scheduled keyed list update in the Keyed List Update section:
    1. Select the server that updates the keyed list from the Default Server list.
    2. Select the Enabled option.

      The parameters required for setting a schedule are displayed.

    3. Select the timezone, and the start time at which the update scheduler runs.
    4. Select the recurring frequency of the update scheduler, and specify the required details.
  7. Click Save.

    The following message appears: Confirmation: Configuration changes saved successfully. IT PAM integrations is configured.

More information:

Create a Keyed List

ObserveIT Integration

You can integrate CA User Activity Reporting Module with ObserveIT for investigating user session recordings.

With ObserveIT, you can do the following:

You can use either a single instance or multiple instances of ObserveIT.

More information:

Integration Considerations

Configure CA User Activity Reporting Module to Work with ObserveIT

View a User Session Recording

How to Integrate CA User Activity Reporting Module with ObserveIT

This topic provides an overview of the steps that you must perform as an administrator to integrate CA User Activity Reporting Module with ObserveIT.

To integrate CA User Activity Reporting Module with ObserveIT, perform the following steps:

Integration Considerations

CA User Activity Reporting Module supports integration with OberveIT 5.2.5.1. Before you integrate CA User Activity Reporting Module with ObserveIT, do the following:

Configure CA User Activity Reporting Module to Work with ObserveIT

CA User Activity Reporting Module works with ObserveIT to let you view a user session recording. To integrate CA User Activity Reporting Module with ObserveIT, you must configure ObserveIT server from the CA User Activity Reporting Module interface.

To configure CA User Activity Reporting Module to work with ObserveIT

  1. Click Administration, Services, and Alerting Service.

    The Global Service Configuration: Alerting Service window appears. By default, the Administration tab opens.

    Note: You can configure an individual CA User Activity Reporting Module server to work with ObserveIT at a local configuration level.

  2. Complete the following fields in the ObserveIT pane as appropriate, and click Save:
    ObserveIT Server URL

    Specifies the address of the ObserveIT server.

    Note: If you use a single instance of OberveIT, you must specify the address of the single ObserveIT server in the following format:

    http://observeit_appserver:port_number_used_to_install_ObserveIT/ObserveIT
    

    If you use multiple instances of ObserveIT, you must specify the address of the centralized management server in the following format:

    http://observeit_centralizedmanagementserver/ObserveITCentralizedManagement/ 
    
    Username

    Specifies the user name of the Administrator who has access to the ObserveIT server.

    Password

    Specifies the password associated with the Administrator of the ObserveIT server.

  3. (Optional) Click Test Connection.

    The connection to the ObserveIT server is tested. If the connection succeeds, the message 'ObserveIT connection information validated successfully' is displayed. The ObserveIT application server is configured from the CA User Activity Reporting Module server.

More information:

Integration Considerations

View a User Session Recording

View a User Session Recording

CA User Activity Reporting Module lets you view a user session recorded by ObserveIT. You must be an administrator or analyst to view a user session recording. You can view a user session recording when you launch the query viewer through CA User Activity Reporting Module API.

To view a user session recording

  1. Right-click an event in a report, and select Investigate host by user session recording.

    The ObserveIT user session recording events dialog opens. The dialog displays all user session recordings available within the time period of the selected event and current time.

  2. Click the video icon of a session you want to view.

    Note: A video icon is enabled only if there is an event within the selected time period.

    The ObserveIT - Slide Viewer window opens. The selected user session recording is played.

More information:

Integration Considerations

Configure CA User Activity Reporting Module to Work with ObserveIT

Configure Integration with an SNMP Trap Destination

Configure SNMP integration as part of the Global Service Configuration for Report Server. The configuration is the IP address and port of one SNMP trap destination.

You can configure SNMP integration either before or after preparing the destination product to receive and interpret SNMP traps from CA User Activity Reporting Module.

When you create an alert destined for an SNMP trap recipient, you can specify one or more destinations. This configuration serves as the default. This default applies to all servers listed under Report Server.

To configure SNMP integration

  1. Click the Administration tab and the Services subtab.
  2. Click Alerting Service

    The Global Service Configuration: Alerting Service dialog appears.

  3. Scroll to the SNMP Configuration area.
  4. Enter the IP address or host name of the destination server for the SNMP traps.
  5. Accept the default port, 162, or change it.
  6. Click Save.

Correlation Service Considerations

The Correlation Service controls the rules applied on the correlation server. When you apply a rule it becomes active.

You can associate notification destinations with rules, and enable or disable rules from the Correlation Service Configuration page. You can choose which CA User Activity Reporting Module servers route events to the selected correlation server, or set an Event Limit.

Event Limit

Defines how many events are retained per incident when accumulation is enabled. The Event Limit helps prevent undue traffic caused by correlation in periods of high activity. When this limit is reached, additional events are lost. For example, if your limit is set to 100, a single rule can accumulate up to 100 recorded events, including the initial qualifying event or events. Accumulation continues until the event limit is reached, or more usually, gap or limit values reset the rule.

You can also remove applied correlation rules, making them inactive.

To remove rules from the applied list

  1. Highlight the row for the correlation rule you want to remove.
  2. (Optional) You can control-click or control-shift to highlight multiple rows.
  3. Click Remove.

    The highlighted rules are removed from the active list.

  4. Click Save to confirm the configuration. If you have not saved, you can click Reset to restore removed rules to the list.

    Note: This procedure only removes correlation rules from the active list. They are not removed from the rule library.

More information:

Apply Correlation Rules and Incident Notifications

Set Collection Servers

Event Log Store Considerations

The event log store uses a federated system, with each host server maintaining its own local event log store and the ability to contact other stores in your environment. When you query a server for event information, it can search its own local event log store as well as all others connected through the federation. This arrangement allows for flexible storage and archiving of event data.

The event log store archive settings let you specify how often data is archived and where it is stored. Both hot (active) event log stores and warm (archived) event log information are queried. Event information in cold storage (remote) is not queried.

You can configure the following event log store and archiving settings:

Maximum Rows

Sets the maximum number of events your event log store hot database can contain. When the event count reaches this value, the event log compresses all event information in the hot database and moves it to the warm database.

Minimum: 50000

Maximum: 100000000

Max Archive Days

Sets the number of days archived files are retained in the archive before being deleted.

Minimum: 1

Maximum: 28000

Archive Disk Space

Defines the percentage of remaining disk space which triggers automatic deletion of the oldest archive files. For example, the default value is 10. When the available event log store space falls below 5 percent, the event log removes the oldest archive files to make more room.

Minimum: 10

Maximum: 90

Export Policy

Defines the number of hours a file restored to the archive (defrosted) is retained in the event log store before deletion

Minimum: 0

Maximum: 168

Summarization/Suppression Rules

Controls which of the available summarization or suppression rules are applied to received events. An administrator must apply new summarization or suppression rules before they can begin refining events.

Forwarding Rules

Controls which of the available event forwarding rules are applied to received events.

Federation Children

Controls which of the available event log stores are set as children of the current server. This setting lets you set up separate federation "trees", controlling query access levels. It is only available as a local setting.

Logging settings control how individual CA User Activity Reporting Module modules record internal messages. They are only available as local settings. Logging settings are usually used for troubleshooting purposes. It is not normally necessary to change these settings. It is important to have a good understanding of log files and logging before doing so.

Log Level

Defines the type and level of detail recorded in the logging file. The drop-down list is arranged in order of detail, with the first choice providing least detail, and the last providing most detail.

Apply to all loggers

Controls whether the Log Level setting overrides all log settings from the log properties file. This setting only applies when the Log Level setting is lower (showing more detail) than the default setting.

Auto Archive Settings enable and control scheduled database archiving jobs, which move warm databases to a remote server.

Note: Before you move scheduled database jobs from one CA User Activity Reporting Module server to another, or to a remote server, you must configure non-interactive authentication between the servers.

You can set the following auto archive values:

Enabled

Sets an auto archive job to run. The auto archive uses the scp utility as controlled by the other settings.

Backup Type

Controls the backup type: A full archive that copies all database information, or an incremental archive that copies all databases that have not yet been backed up.

Default: Incremental

Frequency

Specifies whether the archive job runs daily or hourly. A daily job runs at the time you set using the Start Time clock. An hourly job runs every hour on the hour.

Start Time

Sets the time a daily archive job runs, in whole hours, based on the local sever time. The value is a 24-hour clock.

Limits: 0-23, where 0 means midnight and 23 means 11:00 p.m.

EEM User

Specifies the user who can perform an archive query, recatalog the archive database, run the LMArchive utility, and the restore-ca-elm shell script. This user must be an Administrator.

Default: Log Manager administrator user

EEM Password

Specifies the password for the user who has the rights defined in the EEM user field.

Remote Server

Specifies the hostname or IP Address of the remote server to which the auto archive job copies the database information.

Remote User

Specifies the username that the scp utility uses to connect to the remote server.

Default: caelmservice

Remote Location

Specifies the archive file destination on the remote server.

Default: /opt/CA/LogManager

Remote ELM Server

Specifies whether the remote server is a management server or not. If it is, the auto archive job deletes the databases from the local machine when the transfer is complete. It then notifies the remote machine to perform a recatalog.

Correlation Event Reception Span

Controls how wide a time variance is tolerated for the creation of incidents. The Drift End Time and Drift Start Time values allow you to set a value after the current <CALM >server time (future) and before the current CA User Activity Reporting Module server time (past). If an event falls outside that window it is not forwarded for correlation.

Note: The event reception span values are not considered for counting rules. Counting rules only consider events ahead up to 5 minutes. Events with timestamps ahead by more than 5 minutes are ignored, regardless of the Drift End Time value.

More information:

Apply a Suppression or Summarization Rule

Log Storage

Example: Auto-Archiving Across Three Servers

Incident Service Considerations

You can control the way in which the incident service stores events and creates incidents for a selected CA User Activity Reporting Module server. You can set the following values:

Expiration Time

Specifies how long in days the service retains incidents in the incident database. If the value is 0, events are never deleted. Expired incidents are not displayed.

Incident Generation Limit values

Specifies how often a single correlation rule can create incidents, allowing you to reduce unwanted multiple incidents. For the purposes of incident generation limits, different versions of a rule are considered separate rules. So if you have applied multiple versions of a rule in your environment, they are limited separately. Limit values include:

Enabled

Indicates whether incident generation limits are applied.

Count

Sets a threshold for the number of incidents generated by a single rule. This value works with the Time value, if that value is above 0. After these numbers are reached, the incident service applies the Blocked Time limit. So if you set Count to 3, and the Time to 10, the limit applies after a single rule generates more than 3 incidents in 10 seconds.

Time

Sets a threshold, in seconds, for the number of incidents generated by a single rule. This value works with the Count value, if that value is above 0. After these numbers are reached, the incident service applies the Blocked Time limit. So if you set Count to 3, and the Time to 10, the limit applies after a single rule generates more than 3 incidents in 10 seconds.

Blocked Time

Specifies an interval in seconds, when a rule is blocked from creating further incidents. When this limit is reached, the rule creates no incidents until the time expires.

ODBC Server Considerations

You can install an ODBC client or a JDBC client to access the CA User Activity Reporting Module event log store from an external application like SAP BusinessObjects Crystal Reports.

You can perform the following tasks from this configuration area:

The field descriptions are as follows:

Enable Service

Indicates whether the ODBC and JDBC clients can access data in the event log store. Select this check box to enable external access to events. Clear the check box to disable external access.

The ODBC service is not currently FIPS-compatible. Clear this check box to prevent ODBC and JDBC access if you intend to run in FIPS mode. This prevents non-compliant access to event data. If you intend to disable the ODBC and JDBC service for FIPS mode operations, ensure that you set this value for each server in a federation.

Server Listening Port

Specifies the port number used by the ODBC or JDBC services. The default value is 17002. The CA User Activity Reporting Module server refuses connection attempts when a different value is specified in the Windows Data Source or the JDBC URL string.

Encrypted (SSL)

Indicates whether to use encryption for communications between the ODBC client and the CA User Activity Reporting Module server. The CA User Activity Reporting Module server refuses connection attempts when the corresponding value in the Windows Data Source or JDBC URL does not match this setting.

Session Timeout (minutes)

Specifies the number of minutes to keep an idle session open before it is closed automatically.

Log Level

Defines the type and level of detail recorded in the logging file. The drop-down list is arranged in order of detail, with the first choice providing least detail.

Apply to all loggers

Controls whether the Log Level setting overrides all log settings from the properties file of the log. This setting only applies when the Log Level setting is lower (showing more detail) than the default setting.

Report Service Considerations

The report service controls custom ODBC connection configuration, the administration of automatically delivered reports, and Action Alert and report retention.

To create an external ODBC connection:

  1. Click Add Connection.
  2. Enter the required connection information.

    Note: If you select Oracle from the ODBC Driver drop-down list, a schema field appears, allowing you to enter individual schema objects. Enter at least one schema.

  3. Click Save.
  4. Click Test Connection to validate the information you entered.

    A confirmation message appears. The connections you create appear in the connection list of the query design wizard.

You can set the total Actions Alerts retained, and number of days they are retained in the Alert Retention area:

Maximum Action Alerts

Defines the maximum number of action alerts the reporting server retains for review.

Minimum: 50

Maximum: 1000

Action Alerts Retention

Defines the number of days action alerts are retained, up to the maximum number.

Minimum: 1

Maximum: 30

You can control the company name and logo, header and footer content and color, fonts, and other PDF reports settings in the Report Configurations area:

Rule Test Service Considerations

The rule test service controls how CA User Activity Reporting Module tests correlation rules. You can set the following rule test values.

Event Limit

Defines how many events are retained per incident when accumulation is enabled. The Event Limit helps prevent undue traffic caused by correlation in periods of high activity. When this limit is reached, additional events are lost. For example, if your limit is set to 100, a single rule can accumulate up to 100 recorded events, including the initial qualifying event or events. Accumulation continues until the event limit is reached, or more usually, gap or limit values reset the rule.

Maximum Concurrent Rule Tests

Defines the number of rule tests that can be run simultaneously on a single CA User Activity Reporting Module server.

Subscription Considerations

A Proxy/Client server system delivers subscription updates. The first server you install is set as your Default Subscription Proxy server, which contacts the CA Technologies Subscription Server periodically to check for updates. Subsequent installations are configured as clients of that proxy server, contacting it periodically for updates. If they fail to make contact, a self-monitoring event is logged.

The default system reduces network traffic by eliminating the need for each server to contact the CA Technologies Subscription Server directly, but is fully configurable. You can add proxy servers as needed.

You can also reduce internet traffic still further by creating offline proxy servers, which store update information locally and provide it to clients when contacted. Support any offline proxy servers by manually copying everything in the download path of the online proxy to the download path of the offline proxy. Offline proxies must be configured in environments where there are CA User Activity Reporting Module servers that cannot access the Internet or an internet-connected server.

When configuring the Subscription Service, consider the following information about certain settings and their interactions:

Default Subscription Proxy

Defines the default proxy server for the Subscription Service. The default subscription proxy must have internet access. If no other subscription proxies are defined, this server gets subscription updates from the CA Technologies Subscription server, downloads binary updates to all clients, and distributes content updates to the CA User Activity Reporting Module user store. If other proxies are defined, clients contact this server for updates when no subscription proxy list is configured or when the configured list is exhausted. The default value is the first server installed in your environment. This value is only available as a global setting.

Public Key

Defines the key used to test and verify the signature used to sign the updates. When a public-private key pair is updated, the proxy downloads the update to the public key value, and the proxy updates the public key. This value is only available as a global setting.

Important! Never manually update this value.

Subscription Proxy

Controls whether the local server is a subscription proxy. If the subscription proxy check box is cleared, the server is a subscription client.

Update Now

Starts an on demand update cycle immediately for the selected server. You can perform an on demand update for only one server at a time; this option is not available globally. Update a subscription proxy server before you update its subscription client.

Online Subscription Proxy

Controls whether the local server is an online subscription proxy. An online subscription proxy uses its internet access to get subscription updates from the CA Technologies Subscription server and distribute them to the CA User Activity Reporting Module environment. To designate a server as an online subscription proxy, select both the Subscription Proxy check box and the Online Subscription Proxy option. This value is only available as a local setting.

Offline Subscription Proxy

Controls whether the local server is an offline subscription proxy. An offline subscription proxy is a server that gets subscription updates through a manual directory copy (using scp) from an online subscription proxy. Offline subscription proxies do not need internet access. To designate a server as an offline subscription proxy, select both the Subscription Proxy check box and the Offline Subscription Proxy option. This value is only available as a local setting.

RSS Feed URL

Defines the URL of the CA Technologies Subscription server. Online subscription proxies use this URL to access the CA Technologies Subscription server and download subscription updates.

Modules Available for Download

Lets you select from the modules available for download the modules that apply to your CA User Activity Reporting Module environment. Click Browse to display this dialog; the modules you select appear in the Modules list.

Modules selected are downloaded from the CA Technologies Subscription Server during subscription updates. Modules for download can be selected at the global level; other configured subscription proxies download these modules by default during update. Modules for download can also be selected at the local level for individual proxy and client servers. Doing so overrides global settings so that only the selected modules download to the given server. Modules selected for clients are used to update corresponding modules installed on the client. You can select a module to download for a client that is not selected for its proxy. The proxy retrieves it for the client, but does not install it on itself.

Note: If not populated, set the RSS Feed URL. This setting lets the system read the RSS Feed and, at the next update interval, display the list of available modules to download.

Modules Selected for Download

Displays the modules selected in the RSS Feed Browser dialog. The default subscription proxy and all other online proxies download these modules from the CA Technologies Subscription Server during the update process. The modules listed can be modules chosen for download at the global level, or can reflect modules selected for a given server at the local level.

HTTP Proxy Server

Controls whether this server contacts the CA Technologies Subscription Server through an HTTP Proxy for updates, rather than directly.

Proxy Address to Use

Specifies the full IP Address of the HTTP Proxy.

Port

Specifies the Port number used to contact the HTTP Proxy.

HTTP Proxy User ID

Specifies the user ID used to contact the HTTP Proxy.

HTTP Proxy Password

Specifies the password used to contact the HTTP Proxy.

Schedule

Specifies the start time and frequency for CA User Activity Reporting Module servers to request subscription updates. Online subscription proxy servers (including the default proxy server) contact the CA Technologies Subscription Server, and proxy clients contact their proxy servers, according to this schedule. The schedule can be set globally for all CA User Activity Reporting Module servers; it can also be overridden locally for a given server.

Subscription Proxy for Client Updates

Lets you set which proxies are contacted, in a round robin fashion, for product and operating system updates by all clients or the selected client. You can use the up/down arrows to control the order in which the client contacts the subscription proxies. The client downloads updates from the first proxy it successfully reaches. If none of the configured proxies are available, the client contacts the default subscription proxy.

Subscription Proxy(s) for Content Updates

Lets you select which proxies are used to distribute content updates to the user store. You can select offline proxies or online proxies. This value is only available as a global setting.

Note: Consider selecting more than one server to act as a subscription proxy for content updates, for redundancy.

System Status Service

You can use the System Status service to gather information about, and to control, a CA User Activity Reporting Module server. You display system status only for individual CA User Activity Reporting Module servers. All settings and options apply at the local level.

The System Status service offers the following tabs:

More information

System Status Tasks

Review Service Status and Version

Review System Status Self Monitoring Events

Create a Diagnostics File for Support

Restart the ELM Services

Reboot a Host Server

CA Adapters Configuration Tasks

Local listeners receive and collect native events from certain types of sources using various types of CA adapters.

You can view and edit two types of individual adapter configurations.

You can also view self-monitoring events for each adapter service or adapter host from the individual adapter's global or local configuration areas.

Enable or Disable the CA Adapters Services

If you are not using CA Adapters, you can disable the CA Adapter services to increase the performance of the CPU and memory usage. You can enable the CA Adapter services when you want to use CA Adapters.

If you upgraded to the current CA User Activity Reporting Module release from any release earlier to CA User Activity Reporting Module 12.5.05, the CA Adapters services are enabled by default. If you installed the current CA User Activity Reporting Module release, the CA Adapters services are disabled by default.

To enable the CA Adapters services, perform the following steps:

  1. Log in to the UI.
  2. Click Administration, Services, Global Configuration.
  3. Select the Enable CA Adapters option in the Global Service Configuration: Global Configuration section.
  4. Click Save.
  5. Log out of the UI.
  6. (Optional) Log in to the UI to confirm that the CA Adapters folder is displayed.
  7. Stop the CA iTechnology iGateway on the primary server.
  8. Navigate to the disabledModules folder in the $IGW_LOC folder.

    Note: By default, the disabledModules folder is created starting from CA User Activity Reporting Module 12.5.05. If you are using any previous release of CA User Activity Reporting Module 12.5.05, create the folder in the $IGW_LOC folder.

  9. Move the following configuration files from the disabledModules folder to the $IGW_LOC folder:
  10. Start the CA iTechnology iGateway.
  11. Repeat the Steps 7–10 on each secondary server in the environment.

To disable the CA Adapters services, perform the following steps:

  1. Log in to the UI.
  2. Click Administration, Services, Global Configuration.
  3. Clear the Enable CA Adapters option in the Global Service Configuration: Global Configuration section.
  4. Click Save.
  5. Log out of the UI.
  6. (Optional) Log in to the UI to confirm that the CA Adapters folder is hidden.
  7. Stop the CA iTechnology iGateway on the primary server.
  8. Navigate to the disabledModules folder in the $IGW_LOC folder.

    Note: By default, the disabledModules folder is created starting from CA User Activity Reporting Module 12.5.05. If you are using any previous release of CA User Activity Reporting Module 12.5.05, create the folder in the $IGW_LOC folder.

  9. Move the following configuration files from the $IGW_LOC folder to the disabledModules folder:
  10. Start the CA iTechnology iGateway.
  11. Repeat the Steps 7–10 on each secondary server in the environment.

Edit a Global Adapter Configuration

You can edit global adapter configurations, which are settings that apply to all instances of a given CA Adapter in your environment. For example, you could make configuration changes that apply to all SAPI collectors running in your environment. A global adapter configuration does not override any local adapter settings that differ from the global setting.

To edit a global adapter configuration

  1. Click the Administration tab, and then click the Log Collection subtab.

    The Log Collection folder list appears.

  2. Click the CA Adapters folder.

    The folder expands, displaying subfolders for each adapter.

  3. Select the folder for the adapter whose configuration you want to edit.

    The Global Service Configuration display opens in the details pane.

  4. Make the configuration changes you want.

    Note: Clicking Reset restores the configuration values to the most-recently saved states. You can reset a single change or multiple changes up to the point you click Save. Once you have saved changes you must reset your changes individually.

  5. Click Save when you are finished making changes.

    Any configuration changes you make will be applied to all hosts of the selected adapter, unless they have differing local settings.

Edit a Local Adapter Configuration

You can view or edit local adapter configurations. Local adapter configurations allow you to control settings that may not apply, or be required, for your entire environment. They override global settings only for specific adapter hosts. For example, you may want a specific SAPI adapter host to listen on a different port. You can set this behavior using a local configuration.

To edit a local adapter configuration

  1. Click the Administration tab, and then click the Log Collection subtab.

    The Log Collection folder list appears.

  2. Click the CA Adapters folder.

    The folder expands, displaying subfolders for each adapter.

  3. Select the folder for the adapter whose configuration you want to edit.

    The service display expands, showing adapter hosts.

  4. Click the adapter host you want.

    The host configuration you select opens in the details pane.

  5. Make the configuration changes you want. Every value entry field, menu, or control in the local configuration displays a local/global configuration button which can be toggled to one of two states.

    Global configuration: Configuration button, showing global setting

    Local configuration: Configuration button, showing local setting

    Clicking the button changes it from the global to the local setting, and makes its associated entry field available for use. The entry field must remain set for local configuration for the setting to take effect: If it is set for global configuration, the global setting for that adapter is in effect.

    Note: Clicking Reset shows the most-recently saved configuration values for all the available configurations. You can reset a single change or multiple changes up to the point you click Save. Once you have saved changes you must reset your changes individually.

  6. Click Save when you are finished making changes.

    Any changes you make are applied to the selected adapter host only.

View Adapter Self-Monitoring Events

You can monitor adapter service activity and troubleshoot problems by viewing self-monitoring events for each adapter service host. You can see pre-screened events from the individual adapter's global or local configuration areas.

To view adapter self-monitoring events

  1. Click the Administration tab, and then click the Log Collection subtab.

    The Log Collection folder list appears.

  2. Click the CA Adapters folder.

    The folder expands, displaying subfolders for each adapter service.

  3. Select the folder for a adapter service to view self-monitoring events for that service, or expand the folders and choose a adapter host to view only self-monitoring events for that individual adapter host.

    The adapter configuration appears in the details pane

  4. Click the Self-Monitoring Events tab.

    An event viewer window showing appropriately-filtered events appears. For example, if you select the iTechnology Event Plugin folder in Step 3, you see self-monitoring events for all instances of the iTechnology Event Plugin. If you select a specific host from the iTechnology Event Plugin folder, you see only events relating to that specific iTechnology host.

    Note: Your federation structure controls which events are visible. If no federation is set up then you will only see local events, regardless of which host you select.

More information:

Edit a Global Adapter Configuration

Edit a Local Adapter Configuration

View Adapter Status

View Adapter Status

You can view the current status of certain CA adapter services, including start time, running state, and event delivery information and statistics. You cannot view the status of the iTechnology Event plug-in service.

To view an adapter status

  1. Click the Administration tab, and then click the Log Collection subtab.

    The Log Collection folder list appears.

  2. Click the CA Adapters folder.

    The folder expands, displaying subfolders for each adapter service.

  3. Select the folder for the adapter whose status you want to view.

    The service display expands, showing individual adapter hosts.

  4. Click the adapter host you want.

    The host configuration you select opens in the details pane.

  5. Click the Status tab.

    The Status information appears.

    Note: Status information appears only in the local configuration panel.

SAPI Service Considerations

CA User Activity Reporting Module uses two instances of a CA Audit Submit Application Programming Interface (SAPI) service, one installed as the SAPI Collector, the other as the SAPI Router. The SAPI services are generally used to receive events from existing CA Audit clients and integrated products. You can configure the SAPI adapters using the following settings:

Enable Listener

Activates the selected service. This setting is enabled by default.

SAPI Port

Sets a specific port number for the selected service, if it is not registered with the portmapper. The default value, 0, allows the service to use a randomly-determined port, if the Register check box is selected.

Note: The port number must be different for the SAPI Collector and Router. If the same ports are set for both services, the second one set will not function/.

Register

Controls whether the service registers with the system portmapper. If you select Register and enter 0 in the SAPI Port field, a random port is selected each time the service starts. This is the default setting for both fields. If Register is not selected, you must specify a SAPI port.

Encryption Key

Defines the encryption key, if you use a non-standard encryption key in your CA Audit environment, which the SAPI adapter uses to read incoming SAPI events.

Event Ordering

Ensures that events are sent to the event log store in the same order in which they are received. If event ordering is disabled, the order may be changed if some events are parsed and sent onward more quickly than others. Enabling event ordering may affect performance by increasing the size of the event queue.

Event Throttling

Defines the maximum number of events in the event processing queue, allowing control of processing resources. Entering 0 in this field means that no throttling occurs. Events that exceed this threshold will be delayed at the source.

Thread Count Per Queue

Defines the number of processing threads for each protocol. Using many processing threads will speed up processing if event ordering is disabled. If event ordering is enabled, the thread count will have no effect. Using many threads may have performance implications.

Cipher and Data Mapping

Logging settings control how individual CA User Activity Reporting Module modules record internal messages. They are only available as local settings. Logging settings are usually used for troubleshooting purposes. It is not normally necessary to change these settings, and you should have a good understanding of log files and logging before doing so.

Log Level

Defines the type and level of detail recorded in the logging file. The drop-down list is arranged in order of detail, with the first choice providing least detail, and the last providing most detail.

Apply to all loggers

Controls whether the Log Level setting overrides all log settings from the log's properties file. This setting only applies when the Log Level setting is lower (showing more detail) than the default setting.

iTechnology Event Service Considerations

The iTechnology service controls events sent through the iGateway daemon. You can configure the service by setting which of the available data mapping (DM) files the service uses for event mapping, using the DM file shuttle control.

The event plug-in service is preconfigured to include most of the major data mapping files.

Logging settings control how individual CA User Activity Reporting Module modules record internal messages. They are only available as local settings. Logging settings are usually used for troubleshooting purposes. It is not normally necessary to change these settings, and you should have a good understanding of log files and logging before doing so.

Log Level

Defines the type and level of detail recorded in the logging file. The drop-down list is arranged in order of detail, with the first choice providing least detail, and the last providing most detail.

Apply to all loggers

Controls whether the Log Level setting overrides all log settings from the log's properties file. This setting only applies when the Log Level setting is lower (showing more detail) than the default setting.

System Status Tasks

You can do the following things from within the System Status service:

More information:

Review Service Status and Version

Review System Status Self Monitoring Events

Create a Diagnostics File for Support

Restart the ELM Services

Reboot a Host Server

Create a Diagnostics File for Support

You can review the status and version for services running on a selected CA User Activity Reporting Module server. Clicking Support Diagnostics executes the LmDiag.sh script provided with CA User Activity Reporting Module.

This utility packages system information and log files into a compressed .tar file for transmission to CA Technologies Support personnel. You can transfer this file using FTP or another file transfer method.

Note: Some of the information in the resulting file can be sensitive, for example, IP addresses, system configurations, hardware logs, and process logs. Use a secure method for storing and transporting this file.

To create a diagnostic file

  1. Click the Administration tab and then click the Services subtab.
  2. Expand the System Status entry.
  3. Select a specific CA User Activity Reporting Module server.

    The System Status Service Configuration displays the Administration tab.

  4. Click Support Diagnostics.
  5. Select a file location for the download of the generated diagnostics file.

    The utility creates the file and downloads it to the specified location. The utility closes automatically when the file is copied.

Reboot a Host Server

You can review the status and version for services running on a selected CA User Activity Reporting Module server.

Important! Use this feature only when necessary, or when directed to do so by CA Technologies Support. Rebooting a CA User Activity Reporting Module server causes it to stop receiving, parsing, and storing event logs until the reboot is complete. If you reboot the management server, the managed CA User Activity Reporting Module sessions on other, associated servers must log out and log back in again.

To reboot a host server

  1. Click the Administration tab, and then click the Services subtab.
  2. Expand the System Status entry.
  3. Select a specific CA User Activity Reporting Module server.

    The System Status Service Configuration displays the Administration tab.

  4. Click Reboot Host.

Restart the ELM Services

You can restart the ELM services running on a selected CA User Activity Reporting Module server.

Important! Use this feature only when necessary, or when directed to do so by CA Technologies Support. Restarting the ELM services causes the affected CA User Activity Reporting Module server to stop receiving, parsing, and storing event logs until the restart is complete. If you restart the management server, the current session and all other CA User Activity Reporting Module sessions on other servers must log out and log back in again.

To restart the ELM services

  1. Click the Administration tab and then click the Services subtab.
  2. Expand the System Status entry.
  3. Select a specific CA User Activity Reporting Module server.

    The System Status Service Configuration displays the Administration tab.

  4. Click Restart ELM Services.

Review Service Status and Version

You can review the status and version for services running on a selected CA User Activity Reporting Module server.

To review status

  1. Click the Administration tab and then click the Services subtab.
  2. Expand the System Status entry.
  3. Select a specific CA User Activity Reporting Module server.
  4. Click the Status tab.

Review System Status Self Monitoring Events

You can review the status and version for services running on a selected CA User Activity Reporting Module server. The status messages include events related to processor and disk space usage, CPU load averages, memory use, hardware access and usage, and other events.

To review self monitoring events

  1. Click the Administration tab and then click the Services subtab.
  2. Expand the System Status entry.
  3. Select a specific CA User Activity Reporting Module server.
  4. Click the Self Monitoring events tab.