Administering Resource Management From the Web Console

In this section:

Resource Governor Usage Monitoring facility allows you to monitor requests as they are submitted by users, and logs information about request usage. This information includes the usage statistics associated only with data retrieval or data manipulation in the case of MODIFY or MAINTAIN. This request information is stored in Resource Governor Usage Monitoring tables. You can specify the Monitor Preference, which allows you to change what information is collected for monitored data sources.

The Web Console enables you to administer Resource Management.

You can:

Access to these tasks is provided by the Resource Management link on the toolbar.

The following image shows the hierarchical navigation menu that is available when the Resource Management link is selected.

Navigation pane


Resource Management Configuration Maintenance

In this section:

The Resource Management ribbon provides options for configuring Resource Management, as shown in the following image.

Ribbon

The following sections provide detailed explanations for each option in the ribbon.

Note: You can also access these options by right-clicking Resource Management - Enabled/Disabled in the navigation pane.



Enabling or Disabling Monitoring

How to:

When you enable Resource Management, it automatically turns on monitoring. However, you can disable and re-enable monitoring at any time.



Procedure: How to Enable or Disable Monitoring

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Monitoring group, click Enable/Disable.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled and select Enable/Disable.



Logging Properties

How to:

The reporting server will write all information regarding monitored sources to a log file. This log file is then archived to the Resource Management repository at predetermined intervals or limits, while the server is running. The current log is also archived when the server starts or when the administrator submits a job from the Web Console of a running server.

The intervals or limits can be configured from the Logging Properties option in the Resource Management Web Console. When configured, the log file of an active server will be archived based on the maximum number of sessions or the days set, or based on a scheduled job configured by the administrator.



Procedure: How to Set Logging Properties

Logging properties can be configured in the Resource Management Web Console. When configured, the log files will be archived based on the maximum number of sessions and days set, or based on a scheduled job configured by the administrator.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Logging Properties.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled and select Logging Properties.

    The Resource Management Logging Properties window opens, as shown in the following image.

    The following options are available:

    rmlog_max_sessions

    The number of sessions recorded in the active log file before the log is archived and a new log is started. The default value is 10000.

    rmlog_max_days

    The number of days an active log file is kept open before it is archived and a new log is started. The default value is 1.

    rmlog_schedule_archive

    When set to No, automatic archiving is active and based on the two settings above.

    When set to Yes, only the Limit agent memory for interim log records is shown and the administrator has to configure the schedule archive settings. For more information, see How to Schedule an Archive.

    Note: To use the scheduler feature for archiving of the log file, the server Scheduler process must be running. To check this, from the Web Console, click the Workspace option on the toolbar. Click the Special Services and Listeners folder, right-click SCHEDULER, and select Start. If the Start option is not available, the scheduler is already running.

    Limit agent memory for interim log records

    This setting is used for a connection during which multiple procedures are run within the session. This type of connection can cause the Resource Management logging process to use a large amount of memory before the log records are written to the physical disk file (rmldata.log).

    When set to Yes, enter a value between 5 and 99 (in megabytes). When this parameter is set to Yes and the specified amount of memory is reached, the connected users log records in memory are written to a temp disk file and the memory is freed.

    At the point any new log records generated will be written to disk instead of memory until the end of the session disconnect. At this time, all the log records in the temporary disk file are written to the physical disk file (rmldata.log). This setting should only be used if excessive memory usage is observed and users are connected for long periods.

  4. Make your desired changes and click Save and Restart Server.


Archive Log Files

How to:

When this option is selected, a context menu is shown with the following options:

  • Schedule and E-Mail

    Note: This option is only available when rmlog_schedule_archive is set to Y. For more information on logging properties, see How to Set Logging Properties.

  • Submit archived job
  • View archive jobs

These give the administrator the option to archive the current log file (a new log file is automatically started), as well as view previous archive jobs including any that were submitted due to server restart, and any of the intervals or limits mentioned above having been reached.

Note: After a successful archive, the log file is deleted. If the archive fails, the log file will remain available for archiving. The failure should be investigated and corrected. Once this is done, the List Unarchived Log Files option can be used to archive the data. For more information, see List Unarchived Log Files.



Procedure: How to Schedule an Archive

Note: Only one archive can be scheduled at a time.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Archive, Schedule and E-Mail, and select Manage.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Archive, Schedule and E-Mail, and select Manage.

    The Manage Schedule and E-Mail for procedure pane opens, as shown in the following image.

    The Manage Schedule and E-Mail for procedure pane contains the following fields and options:

    Schedule Status

    Determines if there is a schedule and if so, whether the schedule is active or inactive.

    Mail To

    The email addresses where the messages will be sent. Place each email address (or user ID configured on the server with an associated email address) on a new line with no separators.

    Mail to addresses defined in procedure

    You can send the messages to email addresses defined in the procedure by either typing in the location of the procedure, or clicking the ellipses and manually selecting it from the Select Procedure dialog box.

    Enable

    Select this to enable when an email should be sent.

    Advanced

    Select this option to get the following options:

    • Importance. Select the importance for the E-mail from the drop-down menu. Choices are Low, Normal or High.
    • Subject. The subject line of the message.
    • E-Mail Message. The body of the message.
    • Send HTML output as inline message. When selected, if any stored procedures called by the flow generate an output, the message is included as message text instead of as an attachment. This option is only available in the E-Mail On Completion section.
  4. If you select Active or Inactive from the Schedule Status drop-down menu, the Manage Schedule and E-Mail for procedure pane opens with more fields, as shown in the following image.

    The Manage Schedule and E-Mail for procedure pane contains the following additional fields and options:

    Schedule Type

    Determines whether a process flow will execute once, on a recurring basis, on several specific days (multi-day), or when the server starts.

    Interval Type

    Specifies the interval in which a process flow will be executed. For example, if you select Month as your Interval Type, and select 2 as your Interval Number, the flow will execute every two months. This option is only available if the schedule type is set to Recurring.

    Interval Value

    Specifies the frequency at which a process flow will be executed. For example, if you select Week as your Interval Type, and select 2 as your Interval Value, the flow will execute every two weeks. This option is only available if the schedule type is set to Recurring.

    Start Date

    Specifies the start date for the execution of the process flow.

    Start Time

    Specifies the start time for the execution of the process flow.

    Specify Stop Time

    Allows you to specify an end time for the execution of the process flow. This option is only available if the schedule type is set to Run Once or Multi-Day.

    Specify End Date
    Allows you to specify an end date and time for the execution of the process flow. This option is only available if the schedule type is set to Recurring or Multi-Day.
    End Date

    Specifies the end date for the execution of the process flow. This option is available if Specify End Date is selected.

    End Time

    Specifies the end time for the execution of the process flow. This option is available if Specify End Date is selected.

    Days of the Week

    Specifies the day of the week on which the process flow will be executed. This option is only available if the schedule type is set to Recurring or Multi-Day.

    Days of the Month

    Specifies the day of the month on which the process flow will be executed. This option is only available if the schedule type is set to Recurring or Multi-Day.

    Intraday Start

    Specifies the beginning of the daily time span of the process flow. This option is only available if the schedule type is set to Recurring.

    Intraday End

    Specifies the end of the daily time span of the process flow. This option is only available if the schedule type is set to Recurring.

    Run on Holidays

    Specifies the option to execute the process flow on desired holidays.

    The following options are available:

    • Skip. Excludes run on desired holidays.
    • Only. Only run on desired holidays.

    This option is only available if the schedule type is set to Recurring or Multi-Day.

    Log and output Destinations

    This option controls where the log information from the Maintenance Job should be sent when the Job finishes.

    The following options are available:

    • ETLLOG. The log is sent to the DataMigrator log.
    • EDAPRINT. The log is sent to the Server log.
    • E-Mail. The log is sent as an attachment to an email message if specified in Job Properties.

    Multiple options can be selected. The default value for this option is ETLLOG and E-Mail.

    Note: If the Job is Run from the DMC or Web Console, information will go to the console log regardless of this setting.

  5. Click Set.

    Note: Do not use the Set and Test Run or Save options.

    A confirmation dialog box opens.

  6. Click OK.


Procedure: How to View Scheduler Agents

This report runs for the user whose ID value is stored in the sched_scan_id of a Scheduler. The Scheduler must be active to run the Scheduler Agents report.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Archive, Schedule and E-Mail, and select Scheduler Agents.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Archive, Schedule and E-Mail, and select Scheduler Agents.

    The Scheduler Agents window opens, as shown in the following image.

    The following options are available from the Procedure hyperlink:

    Manage Schedule/E-mail
    Opens the Manage Schedule and E-Mail for procedure pane, which allows you to edit the schedule settings for the selected procedure.
    View Scheduled Events
    Opens the Scheduled Events pane, which allows you to view jobs scheduled to start during a specified time range.
    Quiesce Scheduler Agent
    Allows you to stop the selected scheduled procedure from running.


Procedure: How to View Scheduled Events

Note: The Scheduler must be active to run the Scheduler Events report.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Archive, Schedule and E-Mail, and select Scheduled Events.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Archive, Schedule and E-Mail, and select Scheduled Events.

    The Scheduled Event window opens, as shown in the following image.

  4. Set the desired time range and click View Report.

    The report opens, as shown in the following image.

This report shows all flows and procedures scheduled to run during the time period you selected. The Run Date and Run Time columns show their scheduled run times. The User ID column shows the user ID used when running the flow or procedure.



Procedure: How to Submit an Archive of the Current Log File

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Archive and then select Submit Archive job.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Archive, and then select Submit Archive job.

    The Select an Option dialog box opens, as shown in the following image.

  4. Click OK to save the log data.


Procedure: How to List Previous Archive Jobs

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click Archive and then select View Archive jobs.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Archive, and then select View Archive jobs.

    The Deferred List opens showing the saved logs, as shown in the following image.

  4. Right-clicking an item in the Defer ID column provides more options. Select Get to see the output, or Delete to delete the selection.


List Unarchived Log Files

How to:

Select this option to show a list, if any, of previous log files that have not been archived.



Procedure: How to List Unarchived Logs

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Logs group, click List Unarchived.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled and select List Unarchived.

    The Resource Management unarchived logs list opens listing the non archived logs, as shown in the following image.

  4. Select an unarchived log and click Next to archive the desired unarchived logs.
  5. Select a date and time to archive and click Continue.


Working With Repository Maintenance

How to:

Repository data can be deleted once it has been used or reported on. This deletion can be by date range or, if sufficient data has been stored, the data can be deleted if it is more than one, three, or six months old.



Procedure: How to Schedule a Repository Maintenance

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Repository group, click Maintenance, Schedule and E-Mail, and select Manage jobs.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Maintenance, Schedule and E-Mail, and select Manage Jobs.

    The Resource Management Schedule Repository Maintenance - Add pane opens, as shown in the following image.

    Resource Management Schedule Repository Maintenance - Add pane
  4. Select the server from the list shown.
  5. Select the time range of data that you want to delete.
  6. Click Next.

    The Manage Schedule and E-Mail for procedure pane opens, as shown in the following image.

    The Manage Schedule and E-Mail for procedure pane contains the following fields and options:

    Schedule Status

    Determines if there is a schedule and if so, whether the schedule is active or inactive.

    Mail To

    The email addresses where the messages will be sent. Place each email address (or user ID configured on the server with an associated email address) on a new line with no separators.

    Mail to addresses defined in procedure

    You can send the messages to email addresses defined in the procedure by either typing in the location of the procedure, or clicking the ellipses and manually selecting it from the Select Procedure dialog box.

    Enable

    Select this to enable when an email should be sent.

    Advanced

    Select this option to get the following options:

    • Importance. Select the importance for the E-mail from the drop-down menu. Choices are Low, Normal or High.
    • Subject. The subject line of the message.
    • E-Mail Message. The body of the message.
    • Send HTML output as inline message. When selected, if any stored procedures called by the flow generate an output, the message is included as message text instead of as an attachment. This option is only available in the E-Mail On Completion section.
  7. If you select Active or Inactive from the Schedule Status drop-down menu, the Manage Schedule and E-Mail for procedure pane opens with more fields, as shown in the following image.

    The Manage Schedule and E-Mail for procedure pane contains the following additional fields and options:

    Schedule Type

    Determines whether a process flow will execute once, on a recurring basis, on several specific days (multi-day), or when the server starts.

    Interval Type

    Specifies the interval in which a process flow will be executed. For example, if you select Month as your Interval Type, and select 2 as your Interval Number, the flow will execute every two months. This option is only available if the schedule type is set to Recurring.

    Interval Value

    Specifies the frequency at which a process flow will be executed. For example, if you select Week as your Interval Type, and select 2 as your Interval Value, the flow will execute every two weeks. This option is only available if the schedule type is set to Recurring.

    Start Date

    Specifies the start date for the execution of the process flow.

    Start Time

    Specifies the start time for the execution of the process flow.

    Specify Stop Time

    Allows you to specify an end time for the execution of the process flow. This option is only available if the schedule type is set to Run Once or Multi-Day.

    Specify End Date
    Allows you to specify an end date and time for the execution of the process flow. This option is only available if the schedule type is set to Recurring or Multi-Day.
    End Date

    Specifies the end date for the execution of the process flow. This option is available if Specify End Date is selected.

    End Time

    Specifies the end time for the execution of the process flow. This option is available if Specify End Date is selected.

    Days of the Week

    Specifies the day of the week on which the process flow will be executed. This option is only available if the schedule type is set to Recurring or Multi-Day.

    Days of the Month

    Specifies the day of the month on which the process flow will be executed. This option is only available if the schedule type is set to Recurring or Multi-Day.

    Intraday Start

    Specifies the beginning of the daily time span of the process flow. This option is only available if the schedule type is set to Recurring.

    Intraday End

    Specifies the end of the daily time span of the process flow. This option is only available if the schedule type is set to Recurring.

    Run on Holidays

    Specifies the option to execute the process flow on desired holidays.

    The following options are available:

    • Skip. Excludes run on desired holidays.
    • Only. Only run on desired holidays.

    This option is only available if the schedule type is set to Recurring or Multi-Day.

    Log and output Destinations

    This option controls where the log information from the Maintenance Job should be sent when the Job finishes.

    The following options are available:

    • ETLLOG. The log is sent to the DataMigrator log.
    • EDAPRINT. The log is sent to the Server log.
    • E-Mail. The log is sent as an attachment to an email message if specified in Job Properties.

    Multiple options can be selected. The default value for this option is ETLLOG and E-Mail.

    Note: If the Job is Run from the DMC or Web Console, information will go to the console log regardless of this setting.

  8. Click Create Scheduled procedure.

    The Save As dialog box opens.

  9. Select the application directory to store the procedure in, as shown in the following image.
  10. Select an existing procedure from the list shown, or enter a new procedure name in the File Name box.

    Note: To create a new application, click the New button and enter a new application name in the dialog box.

  11. Click OK.


Procedure: How to View Scheduled Jobs

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Repository group, click Maintenance, then Schedule and E-Mail, and select Show jobs.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Maintenance, then Schedule and E-Mail, and select Show jobs.

    The Resource Management Repository Maintenance - Update pane opens, as shown in the following image.

    Resource Management Repository Maintenance - Update pane

    The columns shown have the following drill-down options available:

    Name Column

    Log and Statistics. Opens the Log and Statistics pane that enables you to view a log or statistics report.

    The following options are available:

    • Report Type. Allows you to select either a log or statistics report.
    • Report Range. Allows you to select to view the last report, all the reports, or a report specified within a select time range.
    • Completion Status. Allows you to view all reports, all completed reports, all completed successfully reports, or all completed reports that contained errors.
    • Run by. Allows you to view reports for all flows, and those initiated by the scheduler or submit.
    • Application or Flow Name. Allows you to select a specific application or flow name for the report.
    Status Column
    • Manage Schedule. Opens the Manage Schedule and E-Mail for procedure pane. For more information on this pane, see How to Schedule a Repository Maintenance.
    • Scheduler Agents. Runs a report for the user whose ID value is stored in the sched_scan_id of a Scheduler. The Scheduler must be active to run the Scheduler Agents report.
    • Scheduled Events. Opens a pane that shows all jobs scheduled to run during a specified time range.

      The Scheduler must be active to run the Scheduler Events report.

      This report shows all flows and procedures scheduled to run during the time period you selected. The Run Date and Run Time columns show their scheduled run times.

      The User ID column shows the user ID used when running the flow or procedure:

      • sched_run_id value - flow is run under
      • user - the user ID that saved the flow or procedure
      • server_admin_id - the first server administrator ID
    Months Column

    Older than. Opens the Resource Management Schedule Repository Maintenance - Change pane. Select the new time range of data that you want to delete and click Save.



Procedure: How to Delete Scheduled Jobs

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Repository group, click Maintenance, then Schedule and E-Mail, and select Delete jobs.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Maintenance, then Schedule and E-Mail, and select Delete jobs.

    The Resource Management Repository Maintenance - Delete pane opens.

  4. Select the scheduled jobs you want to delete, as shown in the following image.
    Resource Management Repository Maintenance - Delete pane
  5. Click Delete.


Procedure: How to Submit a Maintenance Job

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Repository group, click Maintenance, and select Submit Maintenance job.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Maintenance, and select Submit Maintenance job.

    The Resource Management Repository Maintenance pane opens, as shown in the following image.

    Note: If you select Delete data older than 1 month, the options on the Repository Maintenance pane will be slightly different than shown in the above image.

  4. Enter a Start Date and End Date for deletion of data through that range, or click the down arrow button on the right of each date input box to choose the dates.
  5. Click Submit.

    Note: Caution should be used when using this utility. Make sure you have a backup of the data before you proceed.

    The Submit Repository Maintenance Job window opens.

  6. Enter a date and time for the maintenance job to be executed. Click Submit.

A Deferred Execution pane opens confirming your request.



Procedure: How to View a List of Scheduled Maintenance Jobs

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Repository group, click Maintenance, and select View Maintenance jobs.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Maintenance, and select View Maintenance jobs.

    The Deferred List pane opens, as shown in the following image.

  4. To delete any of the scheduled maintenance jobs, select the check box next to the job you want to delete, and select Delete Selected.


Configuration Maintenance

In this section:

The Configuration command has the following options:

  • Properties
  • Global Governing
  • Configure Application Path
  • Migrate prior release data
  • View Migration jobs
  • Change License Key
  • Remove

These give the administrator the option to see current configuration settings, as well as change the viewable application directories, perform migration, change a license key, and remove the current Resource Management configuration.



Resource Management Properties

How to:

Setting monitor properties enables you to select global settings and the component levels to be monitored. Components are split into two categories, Procedure and Command. The information that Resource Governor monitors is stored in the Usage Monitoring tables. The default settings are: Global Data request Monitoring set to off and component level set to Command. Session records are always captured.



Procedure: How to View Resource Management Properties

To view Resource Management Properties:

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration, select Properties, and then select General.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration, select Properties, and then select General.

    The Resource Management Properties page opens, as shown in the following image.

    The Resource Management Properties pane shows the following fields:

    Configured

    The date that Resource Management was configured or reconfigured.

    Repository Type

    The repository that is being used.

    Data Adapter Connection

    The data adapter connection of the current configuration.

    Owner/schema

    The owner/schema name for the relational adapter that Resource Governor will use to create the repository tables.

    Global Data Request Monitoring

    Indicates whether Data Request Monitoring is on or off. When Global Data Request Monitoring is enabled, or set to On, Resource Governor collects information on all SQL SELECT and FOCUS TABLE, TABLEF, MATCH, GRAPH, MODIFY, and MAINTAIN requests. The default value is Off. Monitoring will be by individually selected data sources.

    Procedure Request Monitoring

    Indicates the level of Procedure Request Monitoring.

    Data Sources monitored

    The number of application data sources and relational pass-thru data sources that have been enabled for monitoring. This will show Global monitor enabled if Data Request Monitoring is On. See the Global Settings section below for more information.

    Data Sources not monitored

    The number of application data sources and relational pass-thru data sources that have been disabled by setting the monitoring setting to OFF.

    Excluded Procedure count

    The number of procedures that have been excluded from monitoring.

    Last Maintenance Date

    The date the repository was modified using the Repository Maintenance page.

    Last Repository Update

    The last time the repository updated to include data from a log file.



Procedure: How to Set Monitor Properties

To set Resource Management Properties:

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration, select Properties, and then select Monitoring.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration, select Properties, and then select Monitoring.

    The Resource Management Monitoring Properties page opens, as shown in the following image.

    The Resource Management Monitoring Properties page has the following options:

    Data Request Monitoring

    Indicates whether Data Request Monitoring is on or off. When Global Data Request Monitoring is enabled, or set to On, Resource Governor collects information on all SQL SELECT and FOCUS TABLE, TABLEF, MATCH, GRAPH, MODIFY, and MAINTAIN requests. The default value is Off. Monitoring will be by individually selected data sources.

    Procedure Request Monitoring

    Indicates the level of Procedure Request Monitoring. The following options are available:

    • Execute and INCLUDE. All executed procedures and any procedure that used -INCLUDE will be monitored. This is the default value.
    • Execute only. Any procedure that is executed using EX or EXEC will be monitored.
    • Primary Execute only. The only procedure monitored will be the primary procedure. Any procedure executed from within the primary (-INCLUDE or EX) will not be monitored.
  4. Select the monitoring properties desired.
  5. Click Save.


Procedure: How to Set Repository Properties

The amount of data stored in the repository can be controlled by selecting the record types logged for each connected session. Collecting all of the records can give a complete overview of what each connected user is doing and is a good first step in determining what resources are being consumed and which procedures, data sources, and fields are being used and by whom. But collecting everything can stress the data repository, whether a FOCUS or Relational Database Management system is being used. Some of the tables are more geared towards the Resource Governor feature and others are used just for the Resource Analyzer feature. The Functions and WHERE/IF records are mainly used by the Resource Governor, but there are several reports in Resource Analyzer that will report on that data as well. From the Web Console's Resource Management tab you have the option to add or remove any record type from the logging process using the Configuration/Properties/Repository menu in the Web Consoles ribbon or the Resource Management node on the tree.

To set Resource Management Repository Properties:

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration, select Properties, and then select Repository.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration, select Properties, and then select Repository.

    The Resource Management Repository Properties page opens. The page, as shown in the image below, shows the default record types collected. You can enable or disable any items on the page to control when they are to be collected. Some records are required for others to be collected so by selecting one record, it may cause dependent records to be selected automatically.

    By default all procedures (focexec or SQL Stored Procedure) are monitored unless the Procedure requests log record has been disabled or the procedure has be removed from monitoring using the Manage Monitoring/Remove Procedures from Monitor page. By default, no data requests are collected unless one or more Data Requests log record types are selected and either Global Monitoring is enabled or at least one Data Source has been enabled for monitoring using the Manage Monitoring/Add Data Sources to monitor page for each Application folder. Also, the properties for the Application must have Monitoring enabled in the Applications properties page.

    Note: The All Data option in Release 7.6 also collects SORT and Functions. In Release 7.7, SORT has been included in Fields, and Functions has its own select box.

    The commands option in Release 7.7 will also collect information about Remote requests from a HUB-SUB configuration and, if active, Resource Governor records.

    Resource Management will always collect session records and this feature cannot be turned off.

    By default, command records (for example, a TABLE command being issued) will also be collected for a data resource that is not being monitored.

    The following table shows the relationship between the Repository Properties and the log record types, as well as the corresponding Repository entries.

    Repository Property

    Record Type

    Repository Location

    Comments

    Messages

    RLAU

    SMAUDIT

    Messages that are issued during the processing of a request will be monitored.

    Procedure Requests

    Procedure

    RLFX

    SMRPCS

    Each Procedure (for example, FOCEXEC or SQL Stored Procedure) executed will cause a RLFX record to be collected.

    RLFW

    SMRPCWF

    The RLFW record will only be collected if the session was started by a connection from the WebFOCUS client or WebFOCUS self service application. The RLFW record is added to the SMRPCWF table or segment. Only one RLFW record will be collected for the primary procedure but several RLFX may be collected for a session

    Procedure statements and parameters

    RLFC

    SMRPCREQUESTS (table)

    SMRPCSCMD (segment)

    Contains the EX statement and it parameters or the -INCLUDE record. The actual command as executed. The RLFC records are collected if enabled and the Procedures are being collected.

    Data Requests

     

    RLCD

    SMQUERY

    These settings allow for the customization of command data to be collected. The RLCD record is collected and added to the SMQUERY table or segment.. Each data request (for example, TABLE FILE… or SQL SELECT…) executed will cause a RLCD record to be collected. The RLCD can generate two additional child records, RLDG (Governor) and RLDE (request using SUFFIX=EDA data source). These two records cannot be disabled and will always be collected if generated.

    RLDG

    SMGOVERN (table)

    SMGOVEND (segment)

    RLDE

    SMREMOTES (table)

    SMRMTS (segment)

    Data Request Details

    Data Request Statements

    RLCC

    SMRPCREQUESTS (table)

    SMCMDLN (segment)

    Contains the complete request. For example, TABLE FILE CAR PRINT CAR END.

    Translations

    RLAU

    SMAUDIT

    Contains the translated request if translation is required. If a WebFOCUS TABLE request is for a relational data source, the translated SQL, which is sent to the RDBMS, will be monitored. The RLAU records are collected if enabled and the Data requests statements are being collected.

    Functions

    RLDU

    SMFUNCTIONS (table)

    SMFNCTNS (segment)

    Data about aggregate functions used on fields. There is one record for each function used and contains the aggregation function used and the field it was used on.

    WHERE/IF

    RLDR

    SMRELATIONS (table)

    SMRELTNS (segment)

    Data on the Relational tests used in a request, such as the operator, literals, or date and time values used. There is one record for each WHERE/IF/AND/OR and contains the right and/or left data source and field used. It also has the literal if one was used on the left or right hand side of the clause other information pertinent to a relational test clause.

    Data Sources

    RLDS

    SMFROMS

    The Master File Description/Synonym name or RDBMS table or tables used in a request. There is one record for each data source used in a request. This includes cross referenced data sources or data sources joined using the JOIN or COMBINE command.

    Field

    RLDF

    SMCOLUMNS (table)

    SMCOLMNS (segment)

    The fields used, the type of field, and whether it was used in a sort or group in a request. There is one record for each field selected to return data in the request or in a BY or ORDER BY/GROUP BY statement. This record is not collected for fields used in functions or relational tests.

    Fields used by Reference

    RLDF

    SMCOLUMNS (table)

    SMCOLMNS (segment)

    Information about any DEFINE fields used or referenced in a request. The Fields used by Reference are indicated when the SMDEFINE field is set to 5 (Referenced). Referenced fields are fields that are used in a DEFINE in the MFD, DEFINE FILE or COMPUTE statement to create a virtual field and the virtual field is use in the request.

    The following table shows the comparisons between the Monitoring settings in 7.6, and earlier releases, and the Command Log records settings in Release 7.7.

    Release 7.6

    Release 7.7

    Monitoring Settings

    Command Log Records

    All Data

    Select all

    Query, Froms, Relations, and Columns

    Commands, Request, Data Sources, WHERE/IF, and Fields

    Query, Froms, and Relations

    Commands, Request, Data Sources, and WHERE/IF

    Query and Froms

    Commands, Request, and Data Sources

    Query only

    Commands and Requests

  4. Click Save.


Configuring Application Paths

How to:

You can configure the application path to set the viewable directories for Resource Governor.



Procedure: How to Configure an Application Path
  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration and then select Configure Application Path.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration and select Configure Application Path.

    The Application Path pane opens, as shown in the following image.

  4. To add or remove a directory from the application path, select the In Path check box and click Save.
  5. Refresh the navigation pane to see the newly added or removed directory.


Migrating Resource Management

For more information on how to migrate Resource Management, see Migrating the Resource Management Repository.



Working With License Keys

How to:

A license key is required to run Resource Governor. You can change the license key you are using from within Resource Management at any time.



Procedure: How to Change the License Key
  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration and then select Change License Key.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration, and select Change License Key.

    The Resource Management Configuration pane opens showing your current license.

  4. Enter the new license into the License field and click Save.


Removing Resource Management

How to:

You can remove Resource Management from the server from the Resource Management Configuration pane. This is required if you want to change the repository type from FOCUS to relational, or relational to FOCUS.



Procedure: How to Remove Resource Management
  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. On the ribbon, in the Configuration group, click Configuration and select Remove.

    or

    From the navigation pane, right-click Resource Management - Enabled/Disabled, select Configuration, and select Remove.

    The Resource Management Confirmation pane opens.

  4. Click Remove to remove Resource Management from the server. All system files and the Repository will be removed from the server.


Working With Application Directories

In this section:

When you right-click an application directory, a context menu is available, as shown in the following image.

Application Directories Context Menu

The following sections provide detailed explanations for each option in this context menu.



Monitoring at the Application Level

How to:

Monitoring Data Sources can be set at the Application level to monitor all Data Sources or at the individual level.

Note: Monitoring at the individual data source level will take precedence over the application level. For more information, see Monitoring Individual Data Sources.



Procedure: How to View Application Name Properties

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Expand an application directory in the tree.
  4. To view the data source properties, click the Properties option from the context menu.

    The Application pane opens.

    Application Directory Properties

    The Application pane has the following fields/options:

    First Used

    Is the date the synonym was first accessed.

    Last Used

    Is the date the synonym was last accessed.

    Data Sources
    Monitor On

    The number of data sources with monitoring on.

    Monitor Off

    The number of data sources with monitoring off.

    Not Monitored

    The number of data sources not being monitored.

    Total

    The total number of data sources in the selected application directory.

    Procedures
    Monitor On

    The number of procedures with monitoring on.

    Monitor Off

    The number of procedures with monitoring off.

    Total

    The total number of procedures in the selected application directory.

    Monitor Status

    For more information on setting monitor status, see How to Set Monitor Status at the Application Level.

    Note: The samples application directory ibisamp, created at product installation, has monitoring turned off, by default.



Procedure: How to Set Monitor Status at the Application Level

Data sources in an application can have monitoring turned on or off at the application level. When On is selected, the Usage Monitor will collect information about all requests for all data sources in the application. When Off is selected, no monitored data for data sources in the Application is collected.

If Application monitoring has never been used, the Monitor Status will be Not Set. This is the default value.

To set monitor status for an application:

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Expand an application directory in the tree.
  4. To view the Application properties, right-click an application name and select Properties option from the context menu.

    The Application pane opens.

  5. Select the monitoring status you wish to use from the Monitor Status drop-down menu. The options are:
    • Not Set. This is the same as Off and is the default. The status will not be shown in the navigation tree when viewing data sources.
    • On. Turns monitoring for the Application on and can be seen in the navigation tree when viewing the Application list.
    • Off. Turns monitoring for the Application off and can be seen in the navigation tree when viewing the Application list.


Monitoring Individual Data Sources

How to:

When you right-click an application directory and select Manage Monitoring, a context menu is available, as shown in the following image.

Manage Monitoring options


Procedure: How to Monitor Individual Data Sources

Data sources must be monitored to provide monitor data, which can then be used to analyze performance.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click an application directory in the navigation pane, select Manage Monitoring and select Add Data Sources to Monitor.

    The Add Data Sources to Monitor pane opens to display all synonyms in the selected application directory, as shown in the following image.

  4. Select the check boxes for the data sources you want to monitor, or select the Select All check box next to the Data Source Name column, to select all of the data sources listed.
  5. Click Add.

    The Add Data Sources to Monitor - Status pane opens displaying the selected data sources with monitoring enabled, as shown in the following image.

  6. Click the Close button.

    The data sources you selected now appear in the tree, as shown in the following image.



Procedure: How to Remove a Monitored Data Source From Being Monitored

You can remove a data source from being monitored as follows.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click an application directory in the navigation pane, select Manage Monitoring and select Remove Data Sources from Monitor.

    A list of available data sources opens.

  4. Select the data sources that you wish to remove from monitoring or select the Select All check box next to the Data Source Name column, and click Remove.

    The Remove data Sources from Monitor - Status pane opens, confirming that the selected data source was removed.

  5. Click Close.


Procedure: How to Remove a Procedure From Being Monitored

By default, all Application Data Source procedures are monitored. You can remove a procedure from being monitored as follows.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click an application directory in the navigation pane, select Manage Monitoring and select Remove Procedures from Monitor.

    A list of available procedures opens.

  4. Select the procedures that you wish to remove from monitoring or select the Select All check box next to the Procedure Name column, and click Remove.

    The Remove Procedures from Monitor - Status pane opens, confirming that the selected procedure was removed.

  5. Click Close.


Procedure: How to Monitor Procedures

To have the ability to add procedures, they will need to be removed from monitoring first. For more details, see How to Remove a Procedure from Being Monitored.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click an application directory in the navigation pane, select Manage Monitoring and select Add Procedures to Monitor.

    The Add Procedures to Monitor pane opens to display all procedures in the selected application directory, as shown in the following image.

    Add Procedures to Monitor
  4. Select the check boxes for the procedures you want to monitor, or select the Select All check box next to the Procedure Name column, to select all of the procedures listed.
  5. Click Add.

    The Add Procedures to Monitor - Status pane opens displaying the selected procedures with monitoring enabled, as shown in the following image.

  6. Click the Close button.

    The procedures you selected now appear in the tree under the selected application directory.



Monitoring Relational Adapters

In this section:

When you right-click a relational adapter folder, a context menu is available, as shown in the following image.

The following sections provide detailed explanations for each option in this context menu.



Relational Adapter Properties



Procedure: How to View Relational Adapter Properties

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Expand the Relational Adapters folder.
  4. Right-click a relational adapter directory in the tree and select Properties.
  5. Select a connection name from the Connection Name drop-down menu.

    Note: If there is only one connection name available, the properties for that connection will be shown immediately.

    The Properties for Relational Adapter for the selected connection pane opens, as shown in the following image.

    Properties

    The Properties for Relational Adapter pane has the following fields/options:

    Connection Name

    Allows you to select the connection name from the drop-down menu.

    First Used

    Is the date the relational adapter was first accessed.

    Last Used

    Is the date the relational adapter was last accessed.

    Data Sources
    Monitor On

    The number of data sources with monitoring on.

    Monitor Off

    The number of data sources with monitoring off.

    Not Monitored

    The number of data sources not being monitored.

    Total

    The total number of data sources in the selected application directory.

    Procedures
    Monitor On

    The number of procedures with monitoring on.

    Monitor Off

    The number of procedures with monitoring off.

    Total

    The total number of procedures in the selected application directory.



Monitoring Relational Data Adapter Sources

How to:

When you right-click a relational adapter and select Manage Monitoring, a context menu is available, as shown in the following image.

In the example shown, the MS SQL Server is the adapter selected for relational source monitoring.



Procedure: How to Monitor Relational Data Adapter Sources

Monitoring relational data adapter sources means monitoring SQL direct passthru requests to relational sources that do not use synonyms. Relational sources must be monitored to provide monitor data, which can then be used to analyze performance or govern usage.

Note: The following procedure can only be done if a relational adapter has been configured.

To monitor relational sources:

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Expand the Relational Adapters folder in the tree, right-click the appropriate data adapter, select Manage Monitoring and select Add Data Sources to Monitor.

    The Add Data Sources to Monitor pane opens, as shown in the following image.

  4. Select the connection name from the drop-down menu.
  5. If required, select the Filter check box and provide filter information in the appropriate fields. Click Next.

    The Add Data Sources pane opens, as shown in the following image.

  6. Select the check boxes for the data sources you want to monitor, or select the Select All check box next to the Owner column to select all of the data sources listed. Click Add.

    The Add Data Sources pane reopens displaying the selected data sources with monitoring enabled.

  7. Click Close. The relational data sources you selected now appear in the tree under the adapter/connection folder.


Procedure: How to Remove a Data Source for a Relational Adapter From Being Monitored

You can remove a data source from being monitored as follows.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click a relational adapter directory, select Manage Monitoring, and click Remove Data Sources from Monitor.

    The Remove Data Sources from Monitor pane opens.

  4. Select the connection name from the drop-down menu.
  5. If required, select the Filter check box and provide filter information in the appropriate fields. Click Next.

    The Remove Data Sources pane opens.

  6. Select the check boxes for the data sources you want to remove, or select the Select All check box next to the Owner column to select all of the data sources listed. Click Remove.

    The Remove Data Sources pane reopens displaying the data sources that were removed.

  7. Click Close.


Procedure: How to Remove a Procedure for a Relational Adapter From Being Monitored

By default, all relational procedures are monitored. You can remove a procedure from being monitored as follows.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click a relational adapter directory, select Manage Monitoring, and click Remove Procedures from Monitor.

    The Remove Procedures from Monitor pane opens, as shown in the following image.

  4. Select the connection name from the drop-down menu.
  5. If required, select the Filter check box and provide filter information in the appropriate fields. Click Next.

    The Remove Procedures from Monitor pane opens, showing the list of available procedures.

  6. Select the procedures you wish to remove from monitoring, and click Remove.

    The Remove Procedures from Monitor - Status pane opens, confirming that the selected procedure was removed.

  7. Click Close.


Procedure: How to Monitor Procedures

To have the ability to add procedures, they will need to be removed from monitoring first. For more details, see How to Remove a Procedure for a Relational Adapter from Being Monitored.

  1. Launch the Web Console.
  2. Click the Resource Management option on the toolbar.
  3. Right-click a relational adapter directory in the navigation pane, select Manage Monitoring and select Add Procedures to Monitor.

    The Add Procedures to Monitor pane opens.

  4. Select the connection name from the drop-down menu.
  5. If required, select the Filter check box and provide filter information in the appropriate fields. Click Next.
  6. Select the check boxes for the procedures you want to monitor, or select the Select All check box next to the Owner column to select all of the listed procedures.
  7. Click Add.

    The Add Procedures Status pane opens displaying the selected procedures with monitoring enabled, as shown in the following image.

  8. Click the Close button.

WebFOCUS