SAS Migration Utility
|
Migration
SAS Migration Utility: Properties
The tables in this topic describe properties that the SAS Migration Utility uses when creating a migration analysis report, or later in the process when the utility builds a migration package. To use these properties, add them to your SAS Migration Utility properties file. For more information, see the topic "Run the Migration Utility Using a Properties File" in SAS Intelligence Platform: 9.1.3 to 9.2 Migration Guide.
When SAS Intelligence Platform: 9.1.3 to 9.2 Migration Guide went to press, the book contained information about these properties. However, new versions of the SAS Migration Utility are expected to support properties that are not documented in the book.
Here is how you can determine whether a property is supported by the SAS Migration Utility that is included in your order: Look at the Analysis Report that is produced by your SAS Migration Utility. At the top of the page, you can see a version number like 9.1.3-1.0. Now check this topic. In the tables below, a version number is cited for each property. If the version number of your SAS Migration Utility is supported by a property, then you can use that property with your SAS Migration Utility.
- SAS Analytics Platform
- SAS BI Dashboard
- SAS Grid Manager
- SAS Information Delivery Portal
- SAS Marketing Automation SAS Tier
- SAS Marketing Automation SAS Middle Tier
- SAS Marketing Optimization SAS Tier
- SAS Marketing Optimization SAS Middle Tier
- SAS Web OLAP Viewer for Java
- SAS Web Report Studio
- WebDAV Content
- WebDAV Content - Non-Xythos Server
- WebDAV Content - Xythos Server
- General Properties for SAS Migration Utility
SAS Analytics Platform
| Property | SMU.apcore.dir |
| Example | SMU.apcore.dir=C:\\Program Files\\SAS\\SASAPCore |
| When to Use | Specifies the SAS Analytics Platform applications install directory. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.apcore.migration.is_enabled |
| Example | SMU.apcore.migration.is_enabled=true |
| When to Use | If you are migrating SAS Analytics Platform applications. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
SAS BI Dashboard
| Property | bidashmid.install.dir |
| Examples |
bidashmid.install.dir=C:\\Program Files\\SAS\\SAS
9.1\\mySASBIDashboard\\3.1
bidashmid.install.dir=/usr/local/SAS/SAS_9.1/my_SASBIDashboard/3.1 |
| When to Use | When SAS Business Intelligence Dashboard is not installed in the standard location, which is: installation-directory\SASBIDashboard\3.1. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
SAS Grid Manager
| Property | SMU.grid.appservers |
| Example | SMU.grid.appservers=SASMain,SASApp,SASApp2 |
| When to Use |
When multiple SAS grids are defined in a single metadata server.
Multiple grids are indicated by the presence of more than one grid monitoring server with each referencing different machines. Use SAS.grid.appservers to identify which SAS application servers (and their logical grid servers) that should be migrated with the grid monitoring server that references this machine. SMU.grid.appservers contains a comma-separated list of SAS application server names that should be migrated with this machine. The default value is a NULL string. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
SAS Information Delivery Portal
| Property | javaportal.war.dir |
| Examples |
javaportal.war.dir=C:\\mySAS\\myLev1\\myweb\\mywebapps
javaportal.war.dir=/my_config/mySAS/myLev1/myweb/mywebapps |
| When to Use | When the Portal.war file for the SAS Information Delivery Portal is not in the standard location, which is: configuration-directory\web\webapps (where configuration-directory is the value of the SMU.config.dir property). |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | javaportal.war.file |
| Examples |
javaportal.war.file=C:\\My Config\\mySAS\\myLev1\\myweb\\mywebapps\\myPortal.war
javaportal.war.file=/my_config/mySAS/myLev1/myweb/mywebapps/myPortal.war |
| When to Use | When the Portal.war file for the SAS Information Delivery Portal is not in the standard location, which is: configuration-directory\web\webapps (where configuration-directory is the value of the SMU.config.dir property), or when the WAR files does not have the default name, which is Portal.war. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | javaportal.install.dir |
| Examples |
javaportal.install.dir=C:\\My Program Files\\mySAS\\myWeb\\myPortal2.0.1
javaportal.install.dir=/mySAS/myWeb/myPortal2.0.1 |
| When to Use | When the installation directory for SAS Information Delivery Portal is not in the standard location, which is: sashome-directory\Web\Portal2.0.1 (where sashome-directory is the value of the SMU.SASHOME property). |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
SAS Marketing Automation SAS Tier
| Property | emasvrproces.install.dir |
| Examples |
emasvrproces.install.dir=C:\\Program Files\\mySAS\\SAS 9.1\\Mktauto\\Cmacros
emasvrproces.install.dir=/mySAS/SAS_9.1/myMktauto/myCmacros |
| When to Use | If the SAS Marketing Automation compiled macros are installed in a different directory than the default installation directory. Be sure to specify an absolute file system path. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | emasvrproces.appserver.context.directory |
| Examples |
emasvrproces.appserver.context.directory=C:\\SAS\\Config\\Lev1\\mySASMain
emasvrproces.appserver.context.directory=/SAS/Config/Lev1/mySASMain |
| When to Use | If the SAS Application Server context directory differs from the default SAS Application Server directory (SASMain). |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | emasvrproces.appserver.autoexec.directory.and.name |
| Examples |
emasvrproces.appserver.autoexec.directory.and.name=C:\\SAS\\Config\\Lev1\\mySASMain\\my_appserver_autoexec.sas
emasvrproces.appserver.autoexec.directory.and.name=/SAS/Config/Lev1/mySASMain/my_appserver_autoexec.sas |
| When to Use | If the SAS Application Server autoexec file is relocated from its default location under the application server context directory, or it is renamed from its default value of appserver_autoexec.sas, or both. The property value should be an absolute file system path and filename of the autoexec file (including its .sas extension) that performs a %include of MarketingOptimization_autoexec.sas. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | emasvrproces.mamisc.directory |
| Examples |
emasvrproces.mamisc.directory=C:\\mySAS\\Config\\myMAMisc
emasvrproces.mamisc.directory=/mySAS/Config/myMAMisc |
| When to Use | If the Marketing Automation MAMisc directory is relocated from its default location under the application server Data directory, or it is renamed from its default value of MAMisc, or both. The property value should be an absolute file system path and filename of the MAMisc directory. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | emasvrproces.generate.detailreports |
| Example | emasvrproces.generate.detailreports=false |
| When to Use | Set to false if you do not want detailed analysis reports regarding your SAS Marketing Automation data and metadata generated by the SAS Migration Utility in analyze mode. The values are: true (default) or false. (The migration utility interprets any other value as true.) |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
SAS Marketing Automation SAS Middle Tier
| Property | emacore.install.dir |
| Examples |
emacore.install.dir=C:\\Program Files\\mySAS\\SASMarketingAutomationCore
emacore.install.dir=/mySAS/SASMarketingAutomationCore |
| When to Use | If the SAS Marketing Automation Core middle tier is installed in a different directory than the default installation directory. Be sure to specify an absolute file system path. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | emacore.ear.directory.and.name |
| Examples |
emacore.ear.directory.and.name=C:\\mySAS\\Config\\Lev1\\Web\\Webapps\\sas.analytics.crm.ma.core.ear
emacore.ear.directory.and.name=/mySAS/Config/Lev1/Web/Webapps/sas.analytics.crm.ma.core.ear |
| When to Use | If the SAS Marketing Automation Core middle-tier EAR file is either relocated from its default location under the web/webapps directory, or it is renamed from its default value of sas.analytics.crm.ma.core.ear, or both. Be sure to specify an absolute file system path and be sure to include the complete filename including the .ear extension. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
SAS Marketing Optimization SAS Tier
| Property | mktopt.install.dir |
| Examples |
mktopt.install.dir=C:\\Program Files\\mySAS\\SAS 9.1\\Mktopt\\Ucmacros
mktopt.install.dir=/mySAS/SAS_9.1/Ucmacros/Mktopt |
| When to Use | If the SAS Marketing Optimization uncompiled macros are installed in a different directory than the default installation directory. Be sure to specify an absolute file system path. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.appserver.context.directory |
| Examples |
mktopt.appserver.context.directory=C:\\SAS\\Config\\Lev1\\mySASMain
mktopt.appserver.context.directory=/SAS/Config/Lev1/mySASMain |
| When to Use | If the SAS Application Server context directory differs from the default SAS Application Server directory (SASMain). |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.appserver.autoexec.directory.and.name |
| Examples |
mktopt.appserver.autoexec.directory.and.name=C:\\SAS\\Config\\Lev1\\mySASMain\\my_appserver_autoexec.sas
mktopt.appserver.autoexec.directory.and.name=/SAS/Config/Lev1/mySASMain/my_appserver_autoexec.sas |
| When to Use | If the SAS Application Server autoexec file is relocated from its default location under the application server context directory, or it is renamed from its default value of appserver_autoexec.sas, or both. The property value should be an absolute file system path and filename of the autoexec file (including its .sas extension) that performs a %include of MarketingOptimization_autoexec.sas. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.autoexec.directory.and.name |
| Examples |
mktopt.autoexec.directory.and.name=C:\\SAS\\Config\\Lev1\\mySASMain\\myMarketingOptimization_autoexec.sas
mktopt.autoexec.directory.and.name=/SAS/Config/Lev1/mySASMain/myMarketingOptimization_autoexec.sas |
| When to Use | If the SAS Marketing Optimization autoexec file is relocated from its default location under the application server context directory, or it is renamed from its default value of MarketingOptimization_autoexec.sas, or both. The property value should be an absolute file system path and filename of the Marketing Optimization autoexec file (including its .sas extension) that runs when the workspace server is invoked to execute SAS Marketing Optimization code. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.properties.autocopy |
| Example | mktopt.properties.autocopy=false |
| When to Use | Set to false if you do not want certain SAS Marketing Optimization property and macro variable values to automatically propagate when migrating to SAS 9.2 or Marketing Optimization 5.3. The values are: true (default) or false. (The migration utility interprets any other value as true.) |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.generate.detailreports |
| Example | mktopt.generate.detailreports=false |
| When to Use | Set to false if you do not want detailed analysis reports regarding your SAS Marketing Optimization data and metadata generated by the SAS Migration Utility in analyze mode. The values are: true (default) or false. (The migration utility interprets any other value as true.) Note: When this property is false, you are still able to run the SAS Marketing Optimization analysis tool from an interactive SAS session to generate reports that are specific to SAS Marketing Optimization. For more information, contact your SAS representative. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.detailreports.home |
| Example | mktopt.detailreports.home=mo |
| When to Use | Specify mo if you want your migration analysis reports to be generated in a subdirectory under the Marketing Automation configuration directory. The migration utility places your reports in a subdirectory named analysis_data (for example, C:\SAS\Config\Lev1\SASMain\Data\MarketingOptimization\analysis_data). By default, the migration utility writes Marketing Automation analysis reports to the mktopt/analysisReport subdirectory under its output directory (specified by SMU.Output.Dir). The values are: smu (default) or mo. (The migration utility interprets any other value as smu.) |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktopt.numeric.measures.autorename |
| Example | mktopt.numeric.measures.autorename=true |
| When to Use | Set to true if, during the migration utility analysis phase, you want to automatically rename numeric measure names in the datastore that exceed the 26-character length limit imposed by SAS 9.2 and Marketing Optimization 5.3. The values are: true or false (default). (The migration utility interprets any other value as false.) See the usage notes that follow this table. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
Usage notes for mktopt.numeric.measures.autorename:
-
Automatic renaming is possible only if it is determined that simple truncation of numeric measure names whose length exceeds 26 characters does not result in duplicate names and does not result in a name that occurs as a string within a character attribute.
-
Automatic renaming is an "all" or "none" feature. If requested, all numeric measure names exceeding 26 characters in length must be unique and must not appear as a string within other character attributes after truncation in order for automatic renaming to proceed. Otherwise, no numeric measures will be automatically renamed. Selective or partial automatic renaming is not supported.
-
If truncation would yield duplicate names or a string that occurs within a character attribute, automatic renaming will not be performed, regardless of the setting of this property. In other words, this property does not act as an override. In this case, it will be necessary to manually rename numeric measure names whose length exceeds 26 to conform to the 26-character length restriction.
-
Migration of Marketing Optimization 5.1 to Marketing Optimization 5.3 will not be allowed to proceed until all numeric measure names have been found to comply with the 26-character length restriction.
SAS Marketing Optimization SAS Middle Tier
| Property | mktoptmid.install.dir |
| Examples |
mktoptmid.install.dir=C:\\Program Files\\mySAS\\SASMarketingOptimizationServer
mktoptmid.install.dir=/mySAS/SASMarketingOptimizationServer |
| When to Use | If the SAS Marketing Optimization Server middle tier is installed in a different directory than the default installation directory. Be sure to specify an absolute file system path. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
| Property | mktoptmid.war.directory.and.name |
| Examples |
mktoptmid.war.directory.and.name=C:\\mySAS\\Config\\Lev1\\Web\\Webapps\\ sas.analytics.mo.server.war
mktoptmid.war.directory.and.name=/mySAS/Config/Lev1/Web/Webapps/sas.analytics.mo.server.war |
| When to Use | If the SAS Marketing Optimization Server middle-tier WAR file is relocated from its default location under the web/webapps directory, or it is renamed from its default value of sas.analytics.mo.server.war, or both. Be sure to specify an absolute file system path and be sure to include the complete filename including the .war extension. |
| Supported By | Version 9.1.3-1.10 and later of SAS Migration Utility |
SAS Web OLAP Viewer for Java
| Property | webolapviewr.war.dir |
| Examples |
webolapviewr.war.dir=C:\\My
Config\\SAS\\SASWebOlapViewerforJava\\3.1
webolapviewr.war.dir=/my_config/SAS/SASWebOlapViewerforJava/3.1 |
| When to Use | When SAS OLAP Web Viewer is not configured in the standard location, which is: configuration-directory\web\webapps. If you specify webolapviewr.war.dir, all instances in the specified location are processed. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | webolapviewr.war.file |
| Examples |
webolapviewr.war.file=C:\\Program
Files\\SAS\\SASWebOlapViewerforJava\3.1\\SASWebOlapViewerforJava.war
webolapviewr.war.file=/usr/local/SAS/SAS_9.1/SASWebOlapViewerforJava/3.1/SASWebOlapViewerforJava.war |
| When to Use | When multiple instances of SAS OLAP Web Viewer are deployed, but you want to migrate one instance only. By default, the SAS Migration Utility bases the configuration on all valid instances found. To override this behavior, you can specify the fully qualified location of the SAS OLAP Web Viewer war file for the utility to use. If you specify webolapviewr.war.file, only the specified instance is processed. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
SAS Web Report Studio
| Version | citationweb.war.dir |
| Examples | citationweb.war.dir=C:\\My Config\\SAS\\SASWebReportStudio\\3.1
citationweb.war.dir=/my_config/SAS/SASWebReportStudio/3.1 |
| When to Use | When SAS Web Report Studio is not configured in the standard location, which is: configuration-directory\web\webapps. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Version | citationweb.war.file |
| Examples | citationweb.war.file=C:\\Program
Files\\SAS\\SASWebReportStudio\3.1\\SASWebReportStudio.war
citationweb.war.file=/usr/local/SAS/SAS_9.1/SASWebReportStudio/3.1/SASWebReportStudio.war |
| When to Use | When multiple instances of SAS Web Report Studio are deployed, and you want to specify which instance to use for configuration of the new deployment. By default, the SAS Migration Utility bases the configuration on the first instance found. To override this behavior, you can specify the fully qualified location of the SAS Web Report Studio war file or folder for the utility to use. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
WebDAV Content
| Property | SMU.isdavtier |
| Example | SMU.isdavtier=true |
| When to Use | When you run the SAS Migration utility on the WebDAV tier and you want to migrate local WebDAV content. Specifying the SMU.isdavtier property in the properties file is equivalent to specifying the -DAVTIER option in the batch command. If Xythos is the WebDAV server, set the SMU.isdavtier property (or the -DAVTIER option) only on the node that Xythos is running on, so that the content is migrated on that node only. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.DAV.User |
| Example | SMU.DAV.User=my-user-id |
| When to Use | If a non-Xythos WebDAV server is being used at a site (such as Apache HTTP Server) and extraction of the content is desired. The user must have sufficient read permission to extract the desired content. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.DAV.Password |
| Example | SMU.DAV.Password=my-password |
| When to Use | If a non-Xythos WebDAV server is being used at a site (such as Apache HTTP Server) and extraction of the content is desired. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
WebDAV Content - Non-Xythos Server
| Property | SMU.DAV.URL |
| Example | SMU.DAV.URL=http://davnode.example.com:8300/sasdav |
| When to Use | To specify the DAV URL for the root of the WebDAV data if a non-Xythos (for example, Apache HTTP) content server is deployed in SAS 9.1.3. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
WebDAV Content - Xythos Server
| Property | SMU.WFS.XythosHome |
| Example |
SMU.WFS.XythosHome=C:\\Program Files\\SAS\\xythos\\2.2
SMU.WFS.XythosHome=/usr/local/SAS/xythos/2.2 |
| When to Use | To specify the absolute path where the Xythos Web File Server is installed. Specifying this property causes the migration utility to extract WebDAV content using a Xythos-specific mechanism that is more efficient than using standard WebDAV extraction. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.xythoshost |
| Example | SMU.xythoshost=davnode.example.com |
| When to Use | SMU.xythoshost identifies the machine on which the Xythos server is running. Use when migrating items in a Xythos DAV server to the SAS Content Server. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.xythosport |
| Example | SMU.xythosport=8301 |
| When to Use | Identifies the port on which the Xythos server is listening. If your site uses a different port than the default (8300), then use SMU.xythosport. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
General Properties for SAS Migration Utility
| Property | SMU.config.dir |
| Examples |
SMU.config.dir=C:\\SAS\\MetadataServer\\Lev1
SMU.config.dir=/users/sas/SAS/913BIPlatform/Lev1 |
| When to Use | Specifies the absolute path of the SAS 9.1.3 configuration directory that the SAS Migration Utility reads from. This should usually be the "Lev" directory. It usually contains a SASMain, Data, and product directories. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.SASROOT |
| Examples |
SMU.SASROOT=C:\\Program Files\\SAS\\SAS 9.1
SMU.SASROOT=/usr/local/SAS/SAS_9.1 |
| When to Use | Specifies the path to sas.exe that is used by the SAS 9.1.3 Metadata Server. Required if SMU.SASHOME is not used. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.SASHOME |
| Examples |
SMU.SASHOME=C:\\Program Files\\SAS
SMU.SASHOME=/usr/local/SAS |
| When to Use | Specifies the pathname to the top-level directory where SAS 9.1.3 products are installed. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.host.metadata |
| Example | SMU.host.metadata=metadata.example.com |
| When to Use | The metadata server host. This must be defined for the SAS Migration Utility to run successfully. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.port |
| Example | SMU.port.metadata=8561 |
| When to Use | The metadata server port defaults to 8561. If a different metadata port was used, use this property to set to the correct port. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.user |
| Examples |
SMU.user=mydomain\\adminuser
SMU.user=adminuser |
| When to Use | The metadata server administrative user. This must be an unrestricted user so all data can be read for metadata extraction. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.password |
| Example | SMU.password= |
| When to Use | The metadata server administrative user's password. The password should be encoded using the {sas001} method. Use PROC PWENCODEe to get the encoded password. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.profile |
| Example | SMU.profile=MyServer |
| When to Use | A workspace profile is acceptable as an alternative to providing the host, port, user, and password (if the password is in the profile). This can be just the profile name, which must be in the default location and the current working directory, or a full path to the profile. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.Output.Dir |
| Examples |
SMU.Output.Dir=/home/sas/smu_packages/metadata_tier
SMU.Output.Dir=C:\\SMU_packages\\metadata_tier |
| When to Use | Specifies the absolute path to the directory where the SAS Migration Utility should write its output. If the directory does not exist, the SAS Migration Utility creates it for you. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.localhost |
| Example | SMU.localhost=myserver.example.com |
| When to Use | Explicitly sets the machine host name on which the SAs Migration Utility is running. Use for machines that have multiple network interfaces or a dynamic name. Specify a fully-qualified host name for the machine. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
| Property | SMU.version |
| Example | SMU.version=1.0 |
| When to Use | DO NOT CHANGE THIS VALUE. This property is used by the SDW to verify the version of the migration utility that was used to create a migration package compared to the one in the installation package. |
| Supported By | Version 9.1.3-1.0 and later of SAS Migration Utility |
Contributing to Migration
The migration team appreciates your feedback. Send e-mail to Migration.Feedback@sas.com with questions and comments for our developers, testers, and writers.
