Prerequisites for Running Batch Performance Reports

Overview of Prerequisites for Running Batch Performance Reports

Batch performance reporting requires you to complete several tasks before you can modify the example programs. After the following tasks have been completed, you are ready to modify the example programs:
  • Ensure that the champion model has been published from the project folder.
  • Create a folder structure on the local computer.
    Note: The local computer and the folder that are used in the process of creating batch performance reports must be accessible to the batch performance program.
  • Store performance data sets on the local computer.
  • If you are using SAS example programs, copy the example programs to the local computer.
  • Determine the channel that is used to publish the project or model.
  • Determine a SAS Model Manager user ID and password to authorize the batch processing.

Publish the Champion Model from the Project Folder

In order to run performance reports in batch, you must publish the champion model from the project folder. The SAS Model Manager performance macros use project metadata when running performance reports.
Whenever you have a new champion model, you must publish the new champion model again.

Create a Folder Structure

Create a folder structure on your local computer to contain the report monitoring files. First, create a root folder to contain performance reporting files for one or more SAS Model Manager projects. You might further organize your file structure by project. The examples in the following table use a classification of HMEQ for the files that are used to create home equity performance monitoring reports. Create folders to contain the following types of files:
Folder Contents
Description
Example
job local path
Specifies the folder that contains the reporting specification data sets that are used by the %MM_RunReports() macro.
c:\mmReports\HMEQ\reportJobs
report output
Specifies the folder that contains data sets and auxiliary files that are created during the creation of the performance reports when the %MM_RunReports() macro is run in test mode.
c:\mmReports\HMEQ\testReportOutput
performance data
Specifies the folder that contains the performance data sets for each time period.
Performance data sets can be stored in a DBMS as well. If your performance data set is in a DBMS, then this folder is not necessary.
c:\mmReports\HMEQ\scoreIn
channel
Specifies the folder on the local computer to save the SPK file that is created during the processing of the %MM_GetModels() macro. The SPK file contains the model.
When you publish a model to a channel, the published package is placed in this folder.
A channel can be shared by multiple SAS Model Manager projects. You can define the channel to any location as long as it can be accessed by the %MM_GetModels() macro.
c:\mmReports\HMEQ\channel2
model
Specifies the folder to where the SPK model is extracted to by the %MM_GetModels() macro. The macro creates a \scorecode folder that contains the model score code and saves the data set current.sas7bdat, logs.sas7bdat, and processingspk.sas7bdat in the model folder. The current.sas7bdat data set contains project and model information that is used to create the performance monitoring reports.
c:\mmReports\HMEQ\model
c:\mmReports\HMEQ\model\scorecode
To ensure that your report data is not lost, regularly back up these report folders.

See Also

Report Output in Test and Production Modes

Obtain Performance Data

The performance data set is a snapshot of a data set that includes scoring input variables and one or more target variables. After the snapshot is available, store the data set in a performance data folder on the local computer.

See Also

Creating a Performance Table

Determine the Publish Channel

You can determine the channel that was used to publish the model by using one of these methods:
  • Select the model and click the History tab. Look for a publish model entry. In this example, the channel name is MMChannel: May 29, 2013 4:55:11 PM[mdlmgradmin] "Tree1" was published to "MMChannel(sas-oma://RDCESX09147.race.sas.com:8561/reposid=A5DB5KPY/ITChannel;id=A5DB5KPY.BC000001)" successfully.
  • Select the MMRoot, project, or version folder, and then select the Publish History tab. Look for the publish model entry and then select the entry to view the publish details. In this example, the channel name MMChannel that can be found from the value of SAS destination location. Here is an example: /Channels/Model Manager Channels/MMChannel.
  • In SAS Management Console, click the Plug-ins tab and expand the following nodes under SAS Management Console to find the publishing channels that are used by SAS Model Manager: Environment Managementthen selectPublishing Frameworkthen selectFoundationthen selectChannelsthen selectModel Manager Channels. You can attempt to extract the model using each of the SAS Model Manager publishing channels. Right-click the channel and select Properties. The channel path is located on the Persistent Store tab.
    Note: If the Plug-ins tab does not appear in your view of SAS Management Console, contact your SAS administrator.
Note: A publish channel can be shared by multiple SAS Model Manager projects.

Copy Example Batch Programs

SAS provides several example programs that you can use to create a batch program that monitors the performance of the champion model. You can find the example programs in the sashelp.modelmgr catalog. The catalog includes these example programs:
reportExample1 contains example SAS code to extract a project or model from the channel using the %MM_GetModels() macro.
reportExample2 contains DATA steps to create performance data that can be used to test the batch programs that create performance monitoring reports.
reportExample3 contains example DATA steps to create the SAS data sets that contain report specifications, such as the project UUID and path, various input variables, the location of the performance data source, alert and warning conditions, and e-mail addresses for report notifications.
reportExample4 contains an example program that are used to define the operating environment using macro variables. This program also contains the DATA steps that are used to create the reports.
You can copy these example programs to the job local path folder and you can modify them for your operating environment.

Determine SAS Model Manager User ID and Password

The performance monitoring reports must specify a valid SAS Model Manager user ID and password. The user ID can have any of the following roles:
  • Model Manager User
  • Model Manager Advanced User
  • Model Manager Administrator

See Also

SAS Model Manager User Groups, Roles, and Tasks
Copyright © SAS Institute Inc. All rights reserved.