User-Defined Properties

Organization-Specific User-Defined Properties

Overview of User-Defined Properties

You can create user-defined properties to keep information that is specific to your organization or business in the appropriate folders in the Project Tree. User-defined properties can be added by using the Details section of the Project category view or by using the SAS Model Manager Template Editor. When you use the Template Editor, you can add a user-defined property to a user-defined model template or you can upload a UserDefinedProperties.xml file. For information about adding user-defined properties to a user-defined model template, see User-Defined Model Templates.

User-defined properties that are added using the Details section of the Project category view are added as a property only for the selected node. You name the property and can assign it a value.

When you add a user-defined property using the UserDefinedProperties.xml file, you specify the name of the property, the initial value of the property, and the type of node in the project tree for which it applies. The user-supplied property is created for the specified node type when the node is added to the project tree. For example, if the XML file specifies a user-defined property Version Date for a node type of Document, each time a Documents folder is added to the project tree, the folder has a property of Version Date. User-supplied properties are not added to existing nodes in the project tree.

You can specify these node types in the UserDefinedPropertyies.xml file:

AdHocReport
AggregatedReport
AnalyticalModel
ClassificationModel
ClusteringModel
Document
Milestone
MilestoneAction
ModelGroup
ModelRetrain
ModelRetrainReport
PerformanceMonitor
PredictionModel
Project
ReportingTask
ScoringTask
Version

Create User-Defined Properties Using the Properties Tab

To create a user-defined property:

In the Properties tab, right-click and select Add User-Defined Property. The Add User-Defined Property window appears.
In the Name field, add a name. The name can contain letters, the underscore character ( _ ), and hyphens ( - ). The name cannot begin with a hyphen. Spaces cannot be used in the name.
In the Value field, enter a value for the user-defined property. Click OK. The user-defined property is added to the Properties section under User-Defined Properties.

Create User-Defined Properties Using the UserDefinedProperties.xml File

CAUTION:

Deleting the BusinessContext and DbmsTable properties might result in unexpected results.

SAS Model Manager provides user-supplied properties for use with SAS Real-Time Decision Manager and SAS In-Database scoring. Unexpected results might occur in these environments if you delete the BusinessContext property or the DbmsTable property. For more information, see SAS User-Defined Properties.

To create a user-defined property:

Open the Template Editor by selecting ToolsManage Templates
Select BrowseBrowse TemplatesUserDefinedProperties.xmlOpen.
Add properties using a <Property/> element for each property. These arguments are required:

name="property-name"

specifies the name of the property.

initial="initial-value "

specifies a value for the property when it is added as a property for the specified project tree node. If you do not want to specify an initial value, use two double quotation marks, initial=""

target="node-type"

specifies the project tree node for which the user-supplied value applies. For a list of node types, see Overview of User-Defined Properties.

Example: <Property name="Version Date" initial=" " target="Documents"/>
To upload the file to the SAS Content Server, select FileUpload FileOK.

Here is an example of a UserDefinedProperties.xml file:

<?xml version="1.0" encoding="UTF-8" ?>
<FolderTemplate
	name="User_Defined_Properties">
<!-- 
   Target defines to apply the property to  which folder type . Basically, 
   it is referred as the argument type in MMRepositoryImpl.createNamedObject()
  -->
<Properties>
   <Property name="BusinessContext" initial="" target="Project"/>
   <Property name="DbmsTable" initial=""  target="Project"/>
   <Property name="Division" initial="" target="Version"/>
   <Property name="Consultant" initial=""  target="ClassificationModel"/>
   <Property name="Tester" initial=""  target="ClassificationModel"/>
   <Property name="Version Date" initial="" target="Documents"/>

</Properties>
</FolderTemplate>

SAS User-Defined Properties

SAS creates some user-defined properties that are used by the SAS Real-Time Decision Manager and for scoring that is performed using SAS In-Database processing, such as scoring within a database.

Here are the user-defined properties that are used by the SAS Real-Time Decision Manager. These fields must be completed by the user:

Property Name	Description
BusinessContext	Specifies the business context for which the project is used.
DbmsTable	Specifies the name of the input table that is used in scoring functions. This field should be specified for the project properties before you publish a scoring function if you plan to reference it with a scoring application or in SAS code.

When you publish a model to a database for the first time, SAS creates some project user-defined properties. Some of these property values are assigned by SAS after you complete the Publish Name field in the Publish Models to a Database window.

Here are the publish models to a database user-defined properties.

Property Name	Description
ModelNameForEP	Specifies the publish name of the model that has been published to the database using the SAS Embedded Process.
ScoringFunctionName	For a model that has been published to the database using the scoring function, specifies the user-defined portion of the scoring function name. The name can contain letters, the underscore character ( _ ), and hyphens ( - ). The name cannot begin with a hyphen. Spaces cannot be used in the name.
ScoringFunctionPrefix	Specifies a prefix for the scoring function name. The prefix has a length of 10 characters and in the format of Yyymmddnnn. You cannot modify this value. The naming convention for the prefix is the following: Y is a literal character and is fixed for all prefixes. yymmdd is the Greenwich Mean time (GMT) timestamp of when you select the Publish Modelsto a database menu option. nnn is a counter that increments by one each time the scoring function is successfully completed.