SAS Code to Run Performance Reports

After you have created the data sets that define the report specifications and have extracted the model from the publishing channel, you then run the %MM_RunReports() macro to create the reports for one or more time periods. Using the data sets that were created to define the report specifications, the %MM_RunReports() macro uses the report specifications to create the reports. The report specifications include the type of report to create, such as characteristic, stability, or model assessment. Other report specifications include the target variable, the libref, and the data set name that is used as the performance data source, variables to keep and drop from reports, email addresses to send report notifications, and performance index warnings and alerts.

To run the %MM_RunReports() macro, your code must accomplish the following tasks:

To ensure that you have the latest model, extract the model from the channel each time you create the performance reports. For this reason, you could combine into one SAS program the extraction process and the code to run the reports.

If you run a set of batch jobs every night, you could include this batch job with that set of batch jobs. The reports would be created only after the scheduled date and time that is specified in the mm_jobs.jobtime data set.

The following sections describe each of these components of your SAS program. The last section is an example of a program that is used to test the %MM_RunReports() macro.

If you are running macros in a SAS session that requires a connection to the SAS Metadata Server, you must specify the metadata connection system options before you run the macros. If these options are not specified, you will be prompted for the information. If you are running the macros in batch mode, you must include the metadata connection system options. Otherwise, you will receive a failure message. For more information, see Setting Metadata Connection System Options.

The %MM_RunReports() macro, the %MM_GetModel() macro, and all other Model Management macros are available in the catalog sashelp.modelmgr.reportmacros.source. Use the following FILENAME statement to make these macros available to your program:

filename repmacro catalog 'sashelp.modelmgr.reportmacros.source';
%inc repmacro;

The following librefs are required in your report monitoring program:

Define the following macro variables in your report monitoring program. Then define the location of the job and model on the SAS Model Manager server:

You use a DATA step to access the performance data set before you run the %MM_RunReports() macro:

DATA libref.dataStepName;
   set libref.performanceDataSetName;
run;
   

Here is an example of a DATA step to access the performance data set:

DATA scoreIn.hmeq;
   set scoreIn.hmeq_perf_q1;
run;

The following example program defines the librefs and macro variables to test the %MM_RunReports() macro's ability to assess home equity performance data for multiple time periods. Before this section of code can be run, the report specifications must be defined in SAS data sets and the model must be extracted from the publishing channel. For more information, see Define the Report Specifications and Extracting the Champion Model from a Channel.

The example program sets the current time to a time that would trigger the creation of data sets or the updating of data sets that underlie the model monitoring reports. When you run your batch program in a production environment, you do not need a variable to set the current time. When no value is set for the current time, the %MM_RunReports() macro uses the system timestamp as the value of the current time variable.

The highlighted values are user-supplied values.

/* Source file name: sashelp.modelmgr.reportExample4.source */

FILENAME repmacro catalog 'sashelp.modelmgr.reportmacros.source';
%inc repmacro;

/* Fileref to the encoded password                */

FILENAME pwfile "my-network-path\pwfile"; 

/**************************************************/
/* Specify the report execution metadata and      */
/* configure the _MM_ macro variables to run the  */
/* report job in TEST mode.                       */
/**************************************************/
  
%let _MM_ReportMode=TEST;
%let _MM_User=mmuser1;
data _null_;
   infile pwfile obs=1 length=l; 
   input @;
   input @1 line $varying1024. l; 
   call symput('_MM_Password',substr(line,1,l)); 
run;
;

%let _MM_PathMayChange=Y;

%let _MM_JobLocalPath=c:\mm.test\report.auto;
%let _MM_ModelLocalPath=c:\mm.test\model.extraction;

LIBNAME mm_jobs "&_MM_JobLocalPath";
LIBNAME mm_meta "&_MM_ModelLocalPath";
LIBNAME scoreIn 'c:\mm.test\score.in';

%let mapTable=mm_meta.current;

/***************************************************/
/* DATA step scoreIn.hmeq0                         */
/*                                                 */
/* First, run the Q4 report.It is necessary to */
/* artificially declare a "currentTime" argument   */
/* of 01Jan2013 in order to trigger the report     */
/* execution scheduled for the Q4 interval.    */
/***************************************************/
  
%let currentTime=01Jan2013:12:30:15; 
%MM_RunReports(
  localpath=&_MM_JobLocalPath, 
  currentTime=&currentTime,
  mapTable=&mapTable, 
  user=&_MM_User, 
  password=&_MM_Password);

/***************************************************/
/* Now, run the Q1 report. It is necessary to  */
/* artificially declare a "currentTime" argument   */
/* of 03Apr2012 in order to trigger the report     */
/* execution scheduled for the Q1 interval.    */
/***************************************************/
  
%let currentTime=03Apr2012:12:30:15;
%MM_RunReports(
  dataSource=scoreIn.hmeq_perf_q1,  localpath=&_MM_JobLocalPath, 
  currentTime=&currentTime,
  mapTable=&mapTable, 
  user=&_MM_User, 
  password=&_MM_Password);
  
/***************************************************/
/* Now, run the Q2 report. It is necessary to  */
/* artificially declare a "currentTime" argument   */
/* of 03Jul2012 in order to trigger the report     */
/* execution scheduled for the Q2 interval.    */
/***************************************************/  
%let currentTime=03Jul2012:12:30:15;
%MM_RunReports(
  dataSource=scoreIn.hmeq_perf_q2,  localpath=&_MM_JobLocalPath, 
  currentTime=&currentTime,
  mapTable=&mapTable, 
  user=&_MM_User, 
  password=&_MM_Password);

/***************************************************/
/* Now, run the Q3 report. It is necessary to  */
/* artificially declare a "currentTime" argument   */
/* of 03Oct2012 in order to trigger the report     */
/* execution scheduled for the Q3 interval.    */
/***************************************************/ 
%let currentTime=03Oct2012:12:30:15;
%MM_RunReports(
  dataSource=scoreIn.hmeq_perf_q3,  localpath=&_MM_JobLocalPath, 
  currentTime=&currentTime,
  mapTable=&mapTable, 
  user=&_MM_User, 
  password=&_MM_Password);

/***************************************************/
/* Now, run the Q4 report. It is necessary to  */
/* artificially declare a "currentTime" argument   */
/* of 03Jan2013 in order to trigger the report     */
/* execution scheduled for the 2012Q4 interval.    */
/***************************************************/
  %let currentTime=03Jan2013:12:30:15;
%MM_RunReports(
  dataSource=scoreIn.hmeq_perf_q4,  localpath=&_MM_JobLocalPath, 
  currentTime=&currentTime,
  mapTable=&mapTable, 
  user=&_MM_User, 
  password=&_MM_Password);