Running the %INDNZ_PUBLISH_MODEL Macro

%INDNZ_PUBLISH_MODEL Macro Run Process

To run the %INDNZ_PUBLISH_MODEL macro, complete the following steps:

Create a scoring model using SAS Enterprise Miner.
Use the SAS Enterprise Miner Score Code Export node to create a score output directory. Populate the directory with the score.sas file, the score.xml file, and (if needed) the format catalog.
Start SAS and submit the following command in the Program Editor or Enhanced Editor:
```
%let indconn = server=myserver user=myuserid password=XXXX database=mydb;
```
For more information, see the INDCONN Macro Variable.
If you use the SAS Embedded Process, run the %INDNZ_CREATE_MODELTABLE macro.

For more information, see Creating a Model Table.
Run the %INDNZ_PUBLISH_MODEL macro.

For more information, see %INDNZ_PUBLISH_MODEL Macro Syntax.

Messages are written to the SAS log that indicate whether the scoring functions or files were successfully created.

Note: The %INDNZ_PUBLISH_JAZLIB macro and the %INDNZ_PUBLISH_COMPILEUDF macro (if needed) must be run before you can publish your scoring models using scoring functions. Otherwise, the %INDNZ_PUBLISH_MODEL macro fails. These macros are typically run by your system or database administrator. For more information about these macros, see the SAS In-Database Products: Administrator's Guide.

INDCONN Macro Variable

The INDCONN macro variable is used to provide credentials to connect to Netezza. You must specify server, user, password, and database information to access the machine on which you have installed the Netezza data warehouse. You must assign the INDCONN macro variable before the %INDNZ_PUBLISH_MODEL or the %INDNZ_CREATE_MODELTABLE macros are invoked.

Here is the syntax for the value of the INDCONN macro variable:

SERVER=server USER=user PASSWORD=password DATABASE=database

Arguments

SERVER=server

specifies the Netezza server name or the IP address of the server host.

USER=user

specifies the Netezza user name (also called the user ID) that is used to connect to the database.

PASSWORD=password

specifies the password that is associated with your Netezza user ID.

Tip	Use only PASSWORD=, PASS=, or PW= for the password argument. PWD= is not supported and causes an error.

DATABASE=database

specifies the Netezza database that contains the tables and views that you want to access.

Requirement

You must specify the DATABASE= argument if you use the SAS Embedded Process.

Tip

The INDCONN macro variable is not passed as an argument to the %INDNZ_PUBLISH_MODEL macro. This information can be concealed in your SAS job. For example, you can place it in an autoexec file and apply permissions to the file so that others cannot access the user credentials.

%INDNZ_PUBLISH_MODEL Macro Syntax

%INDNZ_PUBLISH_MODEL

(DIR=input-directory-path, MODELNAME=name
<, MECHANISM=STATIC | EP>
<, MODELTABLE=model-table-name>
<, DATASTEP=score-program-filename>
<, XML=xml-filename >
<, DATABASE=database-name >
<, DBCOMPILE=database-name>
<, DBJAZLIB=database-name>
<, FMTCAT=format-catalog-filename>
<, ACTION=CREATE | REPLACE | DROP >
<, MODE=FENCED | UNFENCED>
<, IDCASE=UPPERCASE | LOWERCASE >
<, OUTDIR=diagnostic-output-directory>
);

Note: Do not enclose variable arguments in single or double quotation marks. This causes the %INDNZ_PUBLISH_MODEL macro to fail.

Arguments

DIR=input-directory-path

specifies the directory where the scoring model program, the properties file, and the format catalog are located.

This is the directory that is created by the SAS Enterprise Miner Score Code Export node. This directory contains the score.sas file, the score.xml file, and (if user-defined formats were used) the format catalog.

Requirement	You must use a fully qualified pathname.
Interaction	If you do not use the default directory that is created by SAS Enterprise Miner, you must specify the DATASTEP=, XML=, and (if needed) FMTCAT= arguments.
See	Special Characters in Directory Names

MODELNAME=name

specifies the name that is prepended to each output function to ensure that each scoring function or filename is unique on the Netezza database. If you are using the SAS Embedded Process, the model name is part of the scoring filenames.

Restriction	The scoring function name is a combination of the model and output variable names. A scoring function name cannot exceed 128 characters. For more information, see Scoring Function Names.
Requirement	If you use scoring functions, the model name must be a valid SAS name that is ten characters or fewer. If you use the SAS Embedded Process, the model name cannot exceed 128 characters. For more information about valid SAS names, see the topic on rules for words and names in SAS Language Reference: Concepts.
Interaction	Only the EM_ output variables are published as Netezza scoring functions. For more information about the EM_ output variables, see Fixed Variable Names and Scoring Function Names.

MECHANISM=STATIC | EP

specifies whether scoring functions or scoring files are created. MECHANISM= can have one of the following values:

STATIC

specifies that scoring functions are created.

These scoring functions are used in an SQL query to run the scoring model.

See	Using Scoring Functions to Run Scoring Models

EP

specifies that scoring files are created.

These scoring files are used by the SAS Embedded Process to run the scoring model. A single entry in the model table is inserted for each new model. The entry contains both the score.sas and score.xml in separate columns. The scoring process includes reading these files from the table and transferring them to each instance of the SAS Embedded Process for execution.

Requirement	If you specify MECHANISM=EP, you must also specify the MODELTABLE= argument.
Note	The SAS Embedded Process might require a later release of Netezza than function-based scoring. For more information, see the SAS Foundation system requirements documentation for your operating environment.
See	Using the SAS Embedded Process to Run Scoring Models

Default

STATIC

MODELTABLE=model-table-name

specifies the name of the model table where the scoring files are published.

Default	sas_model_table
Restriction	This argument is available only when using the SAS Embedded Process.
Requirement	The name of the model table must be the same as the name specified in the %INDNZ_CREATE_MODELTABLE macro. For more information, see the MODELTABLE argument in %INDNZ_CREATE_MODELTABLE Macro Syntax.

DATASTEP=score-program-filename

specifies the name of the scoring model program file that was created by using the SAS Enterprise Miner Score Code Export node.

Default	score.sas
Restriction	Only DATA step programs that are produced by the SAS Enterprise Miner Score Code Export node can be used.
Interaction	If you use the default score.sas file that is created by the SAS Enterprise Miner Score Code Export node, you do not need to specify the DATASTEP= argument.

XML=xml-filename

specifies the name of the properties XML file that was created by the SAS Enterprise Miner Score Code Export node.

Default	score.xml
Restrictions	Only XML files that are produced by the SAS Enterprise Miner Score Code Export node can be used.
Restrictions	If you use scoring functions to run scoring models, the maximum number of output variables is 128. If you use the SAS Embedded Process, the maximum is 1600. However, Netezza also has a maximum row size of 64K. If you have very large character columns, you might exceed the row limit before you exceed the maximum number of variables.
Interaction	If you use the default score.xml file that is created by the SAS Enterprise Miner Score Code Export node, you do not need to specify the XML= argument.

DATABASE=database-name

specifies the name of a Netezza database to which the scoring functions and formats or the scoring files are published.

Requirement	You must specify the DATABASE= argument if you use the SAS Embedded Process.
Interaction	The database that is specified by the DATABASE argument takes precedence over the database that you specify in the INDCONN macro variable. For more information, see %INDNZ_PUBLISH_MODEL Macro Run Process.
Tip	You can publish the scoring functions and formats or the scoring files to a shared database where other users can access them.

DBCOMPILE=database-name

specifies the name of the database where the SAS_COMPILEUDF function is published.

Default	SASLIB
Restriction	This argument is ignored when MECHANISM=EP.
See	For more information about publishing the SAS_COMPILEUDF function, see the SAS In-Database Products: Administrator's Guide.

DBJAZLIB=database-name

specifies the name of the database where the SAS formats library is published.

Default	SASLIB
Restriction	This argument is ignored when MECHANISM=EP.

FMTCAT=format-catalog-filename

specifies the name of the format catalog file that contains all user-defined formats that were created by the FORMAT procedure and that are referenced in the DATA step scoring model program.

Restriction	Only format catalog files that are produced by the SAS Enterprise Miner Score Code Export node can be used.
Interactions	If you use the default format catalog that is created by the SAS Enterprise Miner Score Code Export node, you do not need to specify the FMTCAT= argument.
Interactions	If you do not use the default catalog name (FORMATS) or the default library (WORK or LIBRARY) when you create user-defined formats, you must use the FMTSEARCH system option to specify the location of the format catalog. For more information, see PROC FORMAT in the Base SAS Procedures Guide.

ACTION=CREATE | REPLACE | DROP

specifies one of the following actions that the macro performs:

CREATE

creates new functions or files.

REPLACE

overwrites the current functions or files, if a function or files by the same name is already registered.

DROP

causes all functions or files for this model to be dropped from the Netezza database.

Default	CREATE
Tip	If the function or file was published previously and you specify ACTION=CREATE, you receive warning messages that the function or file already exists and you are prompted to use REPLACE. If you specify ACTION=DROP and the function or file does not exist, an error message is issued.

MODE= FENCED | UNFENCED

specifies whether running the code is isolated in a separate process in the Netezza database so that a program fault does not cause the database to stop.

Default	FENCED
Restrictions	This argument is ignored when MECHANISM=EP.
Restrictions	The MODE= argument is supported for Netezza 6.0. The argument is ignored for previous versions of Netezza.
Tip	There are limited resources available in Netezza when you run in fenced mode. For example, there is a limit to the number of columns available.
See	Modes of Operation

IDCASE= UPPERCASE | LOWERCASE

specifies whether the variable names in the generated sample SQL code (SampleSQL.txt) appear in uppercase or lowercase characters.

Default	UPPERCASE
Restriction	This argument is ignored when MECHANISM=EP.
Tip	When you specify the IDCASE argument, the %INDNZ_PUBLISH_MODEL macro first determines which release of Netezza is being used. If Netezza release 5.0 or later is being used, the macro then checks to see whether the LOWERCASE option or UPPERCASE option is set for the database by using SQL statement SELECT IDENTIFIER_CASE. If the value of the IDCASE argument is different from the case configuration of the database, the macro overwrites the value of the IDCASE option and uses the case configuration of the database. If an earlier release of Netezza is being used, the macro uses the value of the IDCASE argument.
See	Viewing the Scoring Functions for more information about the SampleSQL.txt file

OUTDIR=diagnostic-output-directory

specifies a directory that contains diagnostic files.

Files that are produced include an event log that contains detailed information about the success or failure of the publishing process and sample SQL code (SampleSQL.txt). For more information about the SampleSQL.txt file, see Viewing the Scoring Functions.

Tip	This argument is useful when testing your scoring models.
See	Special Characters in Directory Names

Modes of Operation

The %INDNZ_PUBLISH_MODEL macro has two modes of operation: fenced and unfenced. You specify the mode by setting the MODE= argument.

The default mode of operation is fenced. Fenced mode means that the scoring function that is published is isolated in a separate process in the Netezza database when it is invoked. An error does not cause the database to stop. It is recommended that you publish the scoring functions in fenced mode during acceptance tests.

When the scoring function is ready for production, you can run the macro to publish the scoring function in unfenced mode. You could see a performance advantage if the scoring function is published in unfenced mode.

Note: The MODE= argument is ignored when MECHANISM=EP.

Note: The MODE= argument is supported for Netezza 6.0. The MODE argument is ignored for previous versions of Netezza.