Working with Performance Report Transformations

Add a Performance Report Transformation to a Report Job

The Adapter Setup and Add Domain Category wizards create Performance Report transformations and report jobs automatically for a number of supplied adapters and domain categories. However, you might need to create your own Performance Report transformation and report job. For example, you might want to create batch reports for domain categories for which SAS IT Resource Management does not already provide reports.
To create a Performance Report transformation and add it to a report job, perform the following steps:
  1. In SAS IT Resource Management, open the report job that is to contain the new Performance Report transformation. The job appears on the Diagram tab of the Job Editor window.
    Note: If you want to add a Performance Report transformation to a new job, you must first create the job. For more information about how to create a job, see the “Create a Job” topic in Chapter 14, “Jobs,” in the SAS IT Resource Management 3.5: Administrator’s Guide.
  2. In the Transformations tree of SAS IT Resource Management, expand the SAS IT Resource Management folder.
    SAS IT Resource Management Transformations Folder
    SAS IT Resource Management Transformations Folder
  3. Drag and drop the Performance Report transformation onto the Job Editor window. The Performance Report transformation appears in the process flow diagram for the job.
    Sample Job with a New Performance Report Transformation
    Sample Job with a New Staging Transformation
  4. Right-click the Performance Report transformation and select Properties.
  5. On the General tab, specify the name and description of the transformation.
    Note: SAS IT Resource Management uses the naming convention <domain category> <time period> to name Performance Report transformations. For example, a Performance Report transformation that generates weekly reports for the Server System domain category of DT Perf Sentry is named System Weekly. For best results, use the same naming convention that SAS IT Resource Management uses for consistency and efficiency. For information, see Appendix 7, “Naming Standards,” in the SAS IT Resource Management 3.5: Administrator’s Guide.
    General Tab of a Performance Report Transformation
    General Tab of a Performance Report Transformation
  6. On the Report Server tab, select the SAS Content Server folder path for the transformation.
    In this dialog box, all SAS Content Server folder locations that are available to ITRM are displayed. SAS Content Server folder locations are created in ITRM Report Center Administration workspace. For more information about creating ITRM folder locations on the SAS content server, see How to Create and Assign Access to a SAS Content Server Location Using ITRM Report Center.
    Report Server Tab of a Performance Report Transformation
    Report Server Tab of a Performance Report Transformation
    The Report Server tab includes the following parameters:
    • SAS Content Server specifies the name of the SAS Content Server that stores the report output for the Performance Report transformation.
    • Repository folder path specifies the root path, relative to the SAS Content Server, in which to store the reports.
    Note: Use the Administration workspace of ITRM Report Center to add or delete a repository folder path.
  7. On the Report Parameters tab, specify the following attributes:
    • the style and graph formats for the reports that the transformation creates
    • the location for the ActiveX Control
    • the override location for temporary physical files on the server
    Report Parameters Tab of a Performance Report Transformation
    Report Parameters Tab of a Performance Report Transformation
    The Report Parameters tab includes the following parameters:
    • Style template specifies the name of the style template that is used by all of the reports that the Performance Report transformation creates. The style template determines graph colors and other attributes inside the graph portion of a report.
      You can use the standard style template that SAS IT Resource Management provides (named ITRMDefault). Alternatively, you can create your own style template that includes your own custom colors and visual design. For more information, see About Templates and Style Sheets.
      Note: The content, report titles, and footnotes of the individual exception reports that are generated by the Exception transformation honor the style template that you specify. However, this style sheet does not affect the exception overview report.
    • Location for style sheet specifies the cascading style sheet (.css file) that is used when viewing a report. It controls colors and other attributes outside of the graph portion of a report.
      Any of the following location types are valid values for this field:
      • a full URL to the style sheet folder on a specified server (such as http://<server>:8080/<folder name>/).
      • a URL to a style sheet folder on all the clients where the web browser was initiated (such as file://c:/programfiles/<folder name>/).
      • a relative URL to the style sheet folder on the middle tier where the graphs are installed (such as /<folder name>/<subfolder name>). The option to use only the relative path provides portability of this value. For example, the name or location of the middle tier might change. In that case, the location value does not need to change as long as the folder names in the middle tier remain the same.
      The default value (/SASContentServer/repository/default/sasdav/Stylesheets/) provides a path to the default style sheet for SAS IT Resource Management reports . You can create a style sheet that includes your own custom colors, logos, and visual design. For more information, see About Templates and Style Sheets.
    • Graph format override specifies the graph format to use when generating the reports, regardless of the graph format indicated in the corresponding report definition. The available formats are ActiveX, PNG, or JAVA type images. A value is optional in this field, and the default value is blank. When this field is blank, the reports use the graph format that is specified in the report definition.
    • Location for graph applet JAR files specifies the path to the SAS code that is used only to render reports that are specified as Java reports. A value is optional in this field, and the default value is /sasweb/graph.
      Any of the following location types are valid values for this field:
      • a full URL on a specified server.
      • a URL to a folder on all the clients where the web browser was initiated (such as file://c:/program files/<folder name>).
      • a relative URL to a folder on the middle tier where the graphs are installed (such as /<folder name>/<subfolder name>). The option to use only the relative path provides portability of this value. For example, the name or location of the middle tier might change. In that case, the location value does not need to change as long as the folder names in the middle tier remain the same.
      Note: If this field is blank, then the Performance Report transformation uses the path that is specified for the –APPLETLOC option in the SAS configuration file.
    • Location for ActiveX Control specifies the path to the ActiveX Control. (ActiveX Control is the software that displays an ActiveX graph.) In most cases, the ActiveX Control is installed on your system. If it is not installed on your system, you can do one of the following actions:
      • Use the default path to install the control for you. The default path is specified as the following: /codebase/graph/v94/sasgraph.exe#version=9,4. This path points to a URL location on the SAS website from which the ActiveX Control can be installed.
        Tip
        Access to the Internet is necessary in order to install the ActiveX Control from the SAS website.
      • Enter the path to a location from which the ActiveX Control can be installed.
      Note: Installation of the ActiveX Control is done only one time per client.
    • Override location for temporary physical files on server
      Temporary disk space is used to store reports that are generated by a report job. After the reports have been published to the SAS Content Server, these files and any associated folders are deleted. The default value for this field is blank.
      If the override path exists and is specified, it is used as the location for the reports generated by the report job. If it is not specified or if it does not exist, the following paths are used, based on your operating environment:
      • For Windows operating environments, SAS IT Resource Management uses one of the following paths to the temporary files. The path is selected from this list in the following order:
        • the value of the TEMP environment variable (for the user)
        • the value of the TEMP environment variable (for the system)
        • the value of the USERPROFILE environment variable
        • .
      • For UNIX operating environments, the path is selected from this list in the following order:
        • the value of the TEMP environment variable
        • /tmp
        • the value of the HOME environment variable
        • .
      • For z/OS operating environments, the path is selected from this list in the following order:
        • The value of the FILETEMPDIR option if it is specified, if it exists, and if FILESYSTEM=zFS
        • /tmp
        • .
      Note: If the macro variable ITRMDebug is set to a value of 1 in your report job, the files and any associated folders are not deleted.
    The Report Parameters tab also enables you to reset the parameter values on the tab to their original default values. To do so, select Reset next to a specific field to reset the value for that parameter to the default value. Or, select Reset to defaults to reinstate the default value for all parameters on the tab.
  8. On the Report Definitions tab, you can specify the report definitions and expiration date criteria for the reports that the transformation creates.
    Report Definitions Tab of a Performance Report Transformation
    Report Definitions Tab of a Performance Report Transformation
    As shown in the previous display, the Report Definitions table at the top of the page provides a list of report definitions. These report definitions are used by the Performance Report transformation to generate reports.
    This table includes the following parameters:
    • Report Definition Name specifies the name of the report definition.
    • Report Definition Folder specifies the folder where the report definition is stored.
    • Data Source Folder specifies the folder where the data source for the report is located. If this field is blank, then the report job looks for the data source in the data path that is specified in the report definition or in the same IT data mart folder as the report job, respectively.
      You can double-click a Data Source Folder cell to open the Select a Location dialog box. This dialog box enables you to navigate to and select a folder that contains the data source for the corresponding report definition.
      For more information, see Specifying a Data Source Location.
    The Report Definitions tab enables you to add report definitions to the Performance Report transformation. To do so, perform the following steps:
    1. Click Add. The Select Report Definitions dialog box appears.
    2. Navigate to the report definition folders that corresponding to the adapter and domain category that you are using.
      The report definitions that the Adapter Setup and the Add Domain Category wizards use are in Supplied folders at Shared Data/SAS IT Resource Management/3.5 IT Report Definitions/<adapter>/<domain category>/Supplied/<time period (such as Day, Week, or Month)>.
      The report definitions that you have modified or created on your own are, by default, in User Defined folders at Shared Data/SAS IT Resource Management/3.5 IT Report Definitions/<adapter>/<domain category>/User Defined/<time period (such as Day, Week, or Month)>.
      Note: The supplied SAS Enterprise Guide projects that you can use to create your own report definitions provide this default location. However, you can specify a different location for the report definition. For best results, use the default User Defined folders as detailed above for consistency and efficiency.
      The following display shows the supplied report definitions that the Adapter Setup or Add Domain Category wizard uses for Day reports of the Server Disk domain category of the DT Perf Sentry adapter.
      Select Report Definitions Dialog Box
      Select Report Definitions Dialog Box
    3. Select one or more report definitions that you want to add to the Performance Report transformation.
    4. Click OK. The report definition appears in the Report Definitions table at the top of the Report Definitions tab.
    To remove a report definition from the Report Definitions table, perform the following steps:
    1. Select the report definition from the Report Definitions table at the top of the Report Definitions tab.
    2. Click Remove. The report definition is removed from the Report Definitions table.
    The Properties of report definition box provides additional information about the report definition that is selected in the Report Definitions table. The following display shows some of the properties that might be associated with a report definition.
    Note: As shown in the following display, the properties of a report definition are also available from the Extensions tab of the report definition.
    Properties of Report Definition Box of the Report Definitions Tab
    Properties of Report Definition of the Report Definitions Tab
    Tip
    Report definition names are unique within a domain category. However, they are not unique across all domain categories. The only means of distinguishing between two report definitions with the same name is by viewing their properties. You can use the information in the Properties of report definition box to confirm that you have selected the correct report definition for your report job.
    Properties of Report Definitions on the Report Definitions Tab
    Property
    Notes
    Report author
    Specifies the user ID of the person who created the report definition. If the value is Supplied, then the report definition was supplied by SAS IT Resource Management and is used by the Adapter Setup and Add Domain Category wizards.
    Domain category
    Specifies the adapter and domain category for the report definition. For example, the value DTPerfSentry_ServerDisk indicates that the report definition corresponds to the Server Disk domain category of the DT Perf Sentry adapter. This value is a primary filter that is specified for the report definition in the ITRM Report Definition task.
    Verify that the adapter and domain category is correct for the IT data that you are using and the reports that you want to create.
    Domain subcategory
    (Optional) Specifies the domain subcategory that corresponds to the domain category for the report definition. This value is a primary filter that is specified for the report definition in the ITRM Report Definition task.
    Job schedule frequency
    Specifies when the corresponding reports for the report definition should be scheduled to run. This value is a primary filter that is specified for the report definition in the ITRM Report Definition task.
    Note: This value is a report filter in metadata only. It does not affect the schedule for the corresponding report job. However, for best results, you should schedule the corresponding report job to run according to this filter. For example, if the schedule frequency is Weekly, then schedule the report job to run weekly.
    Keywords
    Specifies the keywords that the report definition assigns to the reports that it creates. Keywords are primary filters that are specified for the report definition in the ITRM Report Definition task.
    Project
    Specifies the name of the SAS Enterprise Guide project that includes the ITRM Report Definition task that created the report definition.
    Process flow
    Specifies the name of the process flow that includes the ITRM Report Definition task that created the report definition.
    Report Definition
    Specifies the name of the ITRM Report Definition task that created the report definition. The ITRM Report Definition task and the report definition have the same name.
    Data path
    (Optional) Specifies the path to the data source.
    Data source
    Specifies the data source such as an information map. Verify that the data source is in the same folder as the report job. If it is not, verify that the data source is in the data path of the report definition or in the Data Source Folder of the Performance Report transformation.
    Expire after
    Specifies the number of days that the corresponding reports are stored in the SAS Content Server before they are expired. If a report is expired and its report job is run again, the expired report is deleted.
    Note: The Override Expiration Date options in the Performance Report transformation can override this value.
    For more information about the naming standards that SAS IT Resource Management uses for reporting components, see About Naming Standards for SAS IT Resource Management Reporting Objects.
    The Override Expiration Date group box provides the ability to override the expiration date that is specified in the report definition.
    Override Expiration Date Options on the Report Definitions Tab
    Override Expiration Date Options on the Report Definitions Tab
    The following override options take effect the next time the report job is deployed and run:
    • Delete report content based on the expiration date in the report definition causes the expiration date that is specified in the report definition to take effect. This option is the default.
    • Delete report content that is older than specified days enables you to override the expiration data that is specified in the report definition. You can enter the number of days that must elapse before the reports are deleted.
  9. Click OK. The Performance Report transformation icon in the process flow diagram of the report job appears with a green check to indicate that it is complete and ready for execution.
  10. Deploy and run the report job. For more information, see About Report Jobs.

Edit a Performance Report Transformation

To edit an existing Performance Report transformation, perform the following steps:
  1. In the IT Data Marts tree of SAS IT Resource Management, double-click the job that contains the Performance Report transformation that you want to edit.
  2. Right-click the Performance Report transformation in the process flow diagram and select Properties. A Properties dialog box is displayed and enables you to modify the various parameters that are specified for the Performance Report transformation and the code that it generates.
    For more information about the specific parameters that are available for configuration in the Performance Report transformation, see the detailed steps in Add a Performance Report Transformation to a Report Job.
  3. Click OK to save your changes.
  4. Deploy and run the report job. For more information, see About Report Jobs.

Delete a Performance Report Transformation

To delete a Performance Report transformation from a job, perform the following steps:
  1. In the IT Data Marts tree in SAS IT Resource Management, double-click the job that contains the Performance Report transformation that you want to delete.
  2. Right-click the Performance Report transformation in the process flow diagram and select Delete. The Performance Report transformation object is deleted from the job.
  3. Click OK to save your changes.
  4. Deploy and run the report job. For more information, see About Report Jobs.
Copyright © SAS Institute Inc. All rights reserved.