Inventorying Your Current SAS Deployment : SAS Help Center

Overview of Inventorying Your Current SAS 9.4 Deployment

A key to successfully migrating your SAS 9.4 content—data and configuration—is knowing exactly what SAS products you are running on each machine at your site. SAS provides a tool to help you do just that. The SAS Migration Utility sweeps a machine to locate your current SAS 9.4 content, and then determines whether the content can be migrated to another SAS 9.4 deployment. During this analyze phase, the migration utility generates a migration analysis report. Using this report, you can determine which SAS products are eligible for automatic migration with the .

Note: You can also use SAS 9 Content Assessment. SAS 9 Content Assessment is a collection of applications designed to help you understand various characteristics of your SAS 9.4 deployment. SAS Content Assessment delivers information that is critical to helping you upgrade to a newer version of SAS 9.4 or migrate to SAS Viya. It provides a comprehensive view of content on your SAS 9.4 system, giving you invaluable transparency and knowledge. You determine issues before upgrading or migrating so that you can proactively address them with SAS Technical Support. Download SAS Content Assessment to get started.

You can get the SAS Migration Utility in two ways: by downloading it from support.sas.com/downloads or by locating the version that is shipped with your SAS 9.4 order. Later, when you are instructed to build a migration package, make sure that you use the version of the migration utility that is shipped with the SAS 9.4 order containing the version that you are migrating to. For more information, see Create the Migration Package.

Here are the steps for inventorying your current SAS deployment:

Complete a Migration Utility Checklist

The SAS Migration Utility relies on a set of input values, such as where you have installed SAS and connection information. You should compile a list of the necessary input values before you run the migration utility.

Note: If you have not installed SAS in the same directory on each machine, then complete the following table for every machine in your current SAS deployment.

SAS Migration Utility Checklist
Migration Utility Input	Default Value	Actual Value
Absolute path to the SAS configuration directory	`C:\SAS\configuration-name` `/users/sas/SAS/configuration-name`
Absolute path to the SAS executable	`C:\Program Files\SASHome\SASFoundation\9.4` `/users/sas/SASHome/SASFoundation`
Absolute path to the top-level directory where SAS products are installed	`C:\Program Files\SASHome` `/users/sas/SASHome`
Metadata server connection profile path name1	`C:\Documents and Settings\user-ID\Application Data\SAS\MetadataServerProfiles\myprofile.swa` `$HOME/ MetadataServerProfiles/myprofile.swa`	information
Metadata server name	No default value
Metadata server port	8561
Unrestricted user ID and its password	sasadm
Product-specific properties For more information, see the sections in Review Product-Specific SAS Migration Utility Properties.	Not applicable
JDBC connection credentials for the Shared Services database2 For more information, see SMU.webinfpltfm.dbms.userid.	SharedServices

SMU.isMultipleTierMachine= true Set this property to true when multiple SAS tiers are deployed on the same machine. For more information, see SMU.isMultipleTierMachine.	To set property to true: SMU.isMultipleTierMachine=true
1You can use a connection profile or provide the equivalent metadata server information on the migration utility command line or in a utility properties file.
2(In SAS 9.4, this is referred to as the SAS Web Infrastructure Platform database.)

Note: The connection profile that you use should access the SAS Metadata Server using a fully qualified host name or an IP address. Do not refer to the metadata server as localhost or its IP equivalent (127.0.0.1) unless all of the machines in your SAS deployment are able to connect to the server using that host name.

Check Backups in SAS 9.4 or SAS 9.4_M1

In SAS 9.4 and SAS 9.4M1, there is a defect with the Deployment Backup and Recovery Tool that involves multiple instances of the tool. Before you create your migration package, check for multiple instances of the web archive file, sas.svcs.admin.backup.war, under your SAS Web Application Servers. If you find multiple instances, then contact SAS Technical Support before attempting your migration. By default, backup WAR files are located under SAS-configuration-directory/Web/WebAppServer/SASServer1_n/sas_webapps.

Prepare Your Metadata Repositories

Before you your metadata repositories, prepare for migration by performing the following steps:

Before you begin preparing your metadata repositories, back them up.

For more information, see the SAS Intelligence Platform: System Administration Guide.

Note: If you are using the %OMABAKUP macro, do not specify the REORG option.
In SAS Data Integration Studio, check in all objects from project repositories.

For more information, see Administering SAS Data Integration Studio in SAS Intelligence Platform: Desktop Application Administration Guide.
Delete any unused directory objects such as libraries, stored processes, and deployed jobs.
Delete any servers or definitions that are not being used.
Remove user directories for users that no longer exist.
If you imported user definitions from an enterprise source using the import macros, rerun these macros and reconcile new and deleted users.
Back up your metadata repository again.

Note: If you are using the %OMABAKUP macro, specify the REORG option.
Delete any orphaned metadata objects.

The migration analysis report on your metadata tier helps you identify orphaned objects. You might want to perform this step later, after reviewing the report.
Document any custom values in your metadata, such as the following:
- additional users and group profiles in your Foundation Services deployments
- server start-up commands
- configuration values for servers
Note: The migration utility ignores metadata repositories with a state of OFFLINE or READONLY.

SAS Migration Utility Requirements

Here are the requirements for installing and running the SAS Migration Utility:

The SAS 9.4M9 Migration Utility requires Java 21. The SAS 9.4M9 Migration Utility will not continue if Java 21 is not provided.

The SAS 9.4M8 Migration Utility requires Java 11. The SAS 9.4M8 Migration Utility will not continue if Java 11 is not provided.

Note: If you are migrating from a SAS installation on an operating system that does not support the necesssary version of Java, and you want to use the SAS Migration Utility to migrate to a more recent SAS 9.4 maintenance release, then you must first migrate your SAS installation to a machine that is running an operating system that supports the necessary version of Java and that is in the same family as your SAS installation's operating system. This migration requires the use of the SAS Migration Utility that corresponds to the SAS installation.

Note: Solaris operating system is not supported on SAS 9.4M9. If you are running on this operating system and you want to migrate, you must migrate to an operating system that is supported on SAS 9.4M9 and that is in the same operating system family.

Perform the following steps to capture a migration package from a SAS system prior to SAS 9.4M9 for migrating to SAS 9.4M9:

Migrating to SAS 9.4M9:

SAS recommends using the Java 21 that came with your SAS 9.4M9 order. You can find the Java 21 in your containing your SAS 9.4M9 order by navigating to the Products directory, and then the privatejre directory that matches the operating system on which you are running the SAS 9.4M9 Migration Utility. For example, products\privatejre__99584__lax__xx__sp0__1.

Operating Systems and Directories
Operating System	Directory Name
Windows	win
Microsoft Windows for x64	wx6
Linux for x64	lax
64-bit Enabled AIX	r64

Note: The HP-UX IPF operating system is not supported on SAS 9.4M9. If you are running on this operating system and you want to migrate, you must migrate to an operating system that is supported on SAS 9.4M9 and that is in the same operating system family.

Note: Starting at SAS 9.4M9, z/OS 64-bit (z64) requires Java 21. You need to install Java 21 SDK directly from IBM.

Using your preferred extraction tool, extract the contents of the archive file to a directory on which you are able to run the JRE.
1. Before running the SAS 9.4M9 Migration Utility on UNIX, in the shell in which the migration utility will be invoked, set the environment variable SMU_JAVA to the path where Java 21 was extracted. For example, if you extracted the privatejre archive into a folder named JRE21, you would set the option like this:
  
  export SMU_JAVA=/install/JRE21/jre
2. When running the SAS 9.4M9 Migration Utility on Windows, set the -JREHOME option to the path where Java 21 was extracted. This option must be the first option on the command line. For example, if you extracted the privatejre archive into a folder named JRE21, you would set the option like this:
  
  ./smu94_x64.exe -jrehome c:\deploy\JRE21\jre -properties c:\deploy\SMU\smu.properties -analyze
If your source SAS system on which you intend to capture a migration package does not support Java 21 or is no longer supported in SAS 9.4M9, you must do one of the following:
1. Upgrade your operating system to a version that supports Java 21. Then, create a migration package.
2. Migrate your source SAS installation to a new machine with an operating system that supports Java 21. Then, this new SAS installation to SAS 9.4M9.
3. Perform a new installation of SAS 9.4M9 on an operating system version that is supported by SAS 9.4M9. Then, content from your source SAS installation to the newly installed SAS 9.4M9 system. Depending on the SAS software that you have installed, there are restrictions to what content can be promoted. For more information, see Content That Migrates and Migration Issues in SAS Viya Platform: Content Migration From SAS 9.4.

Perform the following steps to successfully capture a migration package from a SAS system prior to SAS 9.4M8 for migrating to SAS 9.4M8:

Migrating to SAS 9.4M8:

SAS recommends using the Java 11 that came with your SAS 9.4M8 order. You can find the Java 11 in your SAS Software Depot containing your SAS 9.4M8 order by navigating to the Products directory, and then the privatejre directory that matches the operating system on which you are running the SAS 9.4M8 Migration Utility. For example, products\privatejre__99584__lax__xx__sp0__1.

Operating Systems and Directories
Operating System	Directory Name
Windows	win
Microsoft Windows for x64	wx6
Linux for x64	lax
64-bit Enabled Solaris	s64
Solaris on x64	sax
64-bit Enabled AIX	r64

Note: The HP-UX IPF operating system is not supported on SAS 9.4M8. If you are running on this operating system and you want to migrate, you must migrate to an operating system that is supported on SAS 9.4M8 and that is in the same operating system family. You must get Java 11 for HP-UX IPF from the vendor's website because SAS does not provide it.

Note: SAS 9.4M8, z/OS 64-bit (z64) requires IBM Java 8. (It does not require Java 11.)

Using your favorite extraction tool, extract the contents of the archive file to a directory on which you are able to run the JRE.
1. Before running the SAS 9.4M8 Migration Utility on UNIX, in the shell in which the migration utility will be invoked, set the environment variable SMU_JAVA to the path where Java 11 was extracted. For example, if you extracted the privatejre archive into a folder named JRE11, you would set the option like this:
  
  export SMU_JAVA=/install/JRE11/jre
2. When running the SAS 9.4M8 Migration Utility on Windows, set the -JREHOME option to the path where Java 11 was extracted. This option must be the first option on the command line. For example, if you extracted the privatejre archive into a folder named JRE11, you would set the option like this:
  
  ./smu94_x64.exe -jrehome c:\deploy\JRE11\jre -properties c:\deploy\SMU\smu.properties -analyze
If your source SAS system on which you intend to capture a migration package does not support Java 11, you must do one of the following:
1. Upgrade your operating system to a version that supports Java 11. Then, create a migration package.
2. Migrate your source SAS installation to a new machine with an operating system that supports Java 11. Then, upgrade this new SAS installation to SAS 9.4M8.
3. Perform a new installation of SAS 9.4M8 on an operating system version that is supported by SAS 9.4M8. Then, promote content from your source SAS installation to the newly installed SAS 9.4M8 system. Depending on the SAS software that you have installed, there are restrictions to what content can be promoted. For more information, see Content That Migrates and Migration Issues in SAS Viya Platform: Content Migration From SAS 9.4.

The migration utility must be run on every machine that is running the current version of the SAS Intelligence Platform. (Run the migration utility on machines that contain the SAS server tier or only. Do not run the migration utility on middle-tier horizontal cluster machines and machines that contain SAS clients only.)

For SAS multi-machine deployments, you should copy the utility to shared network storage that is accessible from every SAS machine to avoid having to copy the migration utility separately on each machine. You can then log on to each machine and execute the utility from this shared network storage location.
On SAS multiple machine deployments, run the migration utility first on the machine hosting the SAS Metadata Server.
On SAS deployments that use clustered metadata servers, run the migration utility on the first metadata server node. For more information, see Packaging SAS Content on a Metadata Server Cluster.
The user account with which you run the migration utility (the SAS Installer account) must have Read access to all directories in the current SAS configuration directory for each machine.

CAUTION

To avoid unauthorized access to sensitive information, the location where the migration utility writes package information (SMU.Output.Dir) should be properly secured with file access permissions and readable by the migration utility user and SAS Installer user only.
On SAS multi-machine deployments, the migration utility must be able to write to (and read from) its output directory.

The utility output directory should be on shared network storage accessible to every SAS machine in the deployment. For an example, see the following figure:

Sample Migration Utility Directory Structure

If no shared storage is available, then you must copy the migration package to each successive machine to cause the migration utility to add the machine's content to the migration package. (The metadata server must be packaged first.) If you use File Transport Protocol (FTP) to copy the migration package, make sure that you set the file transfer type to binary.
The SAS Content Server on Windows runs, by default, under the LOCALSYSTEM account, which does not have network privileges. If you are writing the SAS Content Server package to shared storage, then see Packaging SAS Content Server on Windows .
SAS Foundation and certain SAS client applications require the use of a Java Runtime Environment (JRE). Starting with SAS 9.4, a private JRE is provided by SAS and installed by the SAS Deployment Wizard on all platforms other than z/OS. For information about the JRE required by SAS on z/OS, see Third-Party Software Requirements.

The migration utility requires the JRE and uses the JRE that your SAS deployment uses. The migration utility locates the JRE using the SMU.SASHOME property or the sasproductdir command-line option.

Download the SAS Migration Utility

You do not have to wait for your SAS 9.4 order to arrive to begin using the SAS Migration Utility. Simply go to the SAS product download site to download the migration utility.

Ensure that you have met the requirements listed in SAS Migration Utility Requirements.
On a machine that has internet access, point a web browser to the following URL:

http://www.sas.com/apps/demosdownloads/setupintro.jsp
Search for SAS Migration Utility.

Note: SAS provides a migration utility template file (smu.properties.template) that includes examples for how to use various properties. You can find the template file at the same URL where you download the SAS Migration Utility.
After you have downloaded the migration utility, move the utility to a storage location that is accessible to your current SAS deployment (such as a shared network drive).

There is a unique SAS Migration Utility for each supported operating system family. If your current SAS deployment is a multi-platform deployment, you need to download the appropriate migration utility for the operating systems on which you have deployed SAS: Windows, UNIX, and z/OS.

Note: This version of the SAS Migration Utility is provided for users who have not yet received their SAS 9.4 software and are interested in assessing the scope of migration for their currently installed products. When you receive your SAS 9.4 software, you should use the version of the SAS Migration Utility that is included with the order to perform the migration, guaranteeing compatibility with the versions of the products ordered.
On UNIX and z/OS, remember to assign Execute permissions before running the downloaded file.

For more information, refer to your UNIX or z/OS documentation.

Develop a Common SAS Migration Utility Properties File

As the SAS Migration Utility is run from an operating system prompt or command line, entering a set of invocation options can be error prone. If you deployed SAS in a similar way across multiple machines, you can benefit from creating a common migration utility properties file and reduce the amount of input that you must enter on the migration utility command line.

Note: SAS has a migration utility template file (smu.properties.template) that provides examples for how to use various properties. You can find the template file at the same URL where you download the SAS Migration Utility. SAS provides a template with the SAS Software Depot in the smu94 subdirectory under utilities. For more information, see Running the Migration Utility Using a Properties File.

Follow these steps to create a common migration utility properties file:

Complete a migration utility checklist using Complete a Migration Utility Checklist.
Add any necessary product-specific migration utility properties. (See Review Product-Specific SAS Migration Utility Properties.)
Make sure that you have Write access to a migration utility executable directory that is network-shared and accessible from each machine on which you are running SAS.
Referring to your completed migration utility checklist and to the following table, use a text editor to add the required migration utility properties to your properties file.

CAUTION

You should encode any passwords used in a migration utility properties file or specified on the command line. The migration utility accepts passwords that are encoded using PROC PWENCODE. The location where the migration utility writes package information should be properly secured with file access permissions readable by the migration utility user and SAS Installer user only.

Save your properties file in the migration utility executable directory.

Required SAS Migration Utility Properties
Required Migration Utility Property	Example
SMU.config.dir	SMU.config.dir=C:\\SAS\\BIServer\\Lev1 SMU.config.dir=/users/sas/SAS/biserver/Lev1 SMU.config.dir=/usr/lpp/SASConfig/Lev1
SMU.SASROOT	SMU.SASROOT=C:\\Program Files\\SASHome\\SASFoundation\\9.4 SMU.SASROOT=/users/sas/SAS/SASFoundation/9.4 SMU.SASROOT=/usr/lpp/SASHome/SASFoundation/9.4
SMU.SASHOME1	SMU.SASHOME=C:\\Program Files\\SAS SMU.SASHOME=/users/sas/ SMU.SASHOME=/usr/lpp/SASHome
SMU.Output.Dir	SMU.Output.Dir=C:\\SMU\\94_Deployment SMU.Output.Dir=/smu/94_deployment SMU.Output.Dir=/u/user-ID/SMU/SMU_Package
SMU.webinfpltfm.dbms.userid SMU.webinfpltfm.dbms.password	SMU.webinfpltfm.dbms.userid=myDatabaseUserID SMU.webinfpltfm.dbms.password={SAS002}DBCC571245AD0B31433834F80BD2B99E16B3C969
SMU.isMultipleTierMachine2	SMU.isMultipleTierMachine=true
1Paths containing spaces in properties files do not require double quotation marks.
2Required when multiple SAS tiers are deployed on the same machine.

CAUTION

To avoid unauthorized access to sensitive information, the location where the migration utility writes package information (SMU.Output.Dir) should be properly secured with file access permissions and readable by the migration utility user and the SAS Installer user only.

Review Product-Specific SAS Migration Utility Properties

Some SAS products have unique 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. For more information, see Product-Specific SAS Migration Utility Properties Overview.

Create a Migration Analysis Report

The SAS Migration Utility has two execution modes: an analyze mode and a package mode. Before creating a migration package that the SAS Deployment Wizard uses to perform the actual migration, you should run the migration utility in analyze mode to create a migration analysis report. This report is useful in helping you determine exactly which SAS products are deployed on each machine in your current SAS system.

Sample Migration Analysis Report

Follow these steps to create a migration analysis report:

Review the migration utility requirements.

For more information, see SAS Migration Utility Requirements.
If you have not already, complete a migration utility checklist.

For more information, see Complete a Migration Utility Checklist.
Verify that the SAS Metadata Server is running.
If you are creating a migration package on a middle-tier machine, verify that all data servers in your SAS environment, including the SAS Web Infrastructure Platform Database, are running on the middle-tier.
Log on to the SAS machine (the source machine) that you want to inventory.

Note: On SAS multi-machine deployments, run the migration utility first on the machine hosting the SAS Metadata Server. You can run the migration utility on the remaining tiers in any order. Do not run the migration utility on middle-tier cluster machines and machines that contain SAS clients only.
If the version of the migration utility that you are using has changed from one that you have used previously, then be sure to delete the migration utility's output directory. (For example, in the past, you might have downloaded and run an earlier version of the migration utility to create a migration analysis report. If so, delete the output created by the older migration utility.)
Change to the SAS Migration Utility executable directory. By default, this is a subdirectory under the utilities directory in your SAS Software Depot.
Review smu Command Notes.
Use the common migration utility properties file and the common connection profile that you have developed, unless the source machine requires any special modifications (for example, SAS is installed on a machine-specific path).

For more information, see Develop a Common SAS Migration Utility Properties File.
Add any necessary product-specific migration utility properties to your properties file. (See Review Product-Specific SAS Migration Utility Properties.)
Invoke the migration utility to run in analyze mode, using the following command from an operating system prompt or command line:

SAS 9.4 on Windows 32-bit

smu94_32 -analyze -properties absolute pathname to property file -replace

SAS 9.4 on Windows 64-bit

smu94_x64 -analyze -properties absolute pathname to property file -replace

SAS 9.4 on UNIX

./smu94 -- -analyze -properties absolute pathname to property file -replace

SAS 9.4 on z/OS

./smu94.zos -- -analyze -properties absolute pathname to property file -replace

For more information about migration utility commands, see SAS Migration Utility Overview.

Note: If you are including WebDAV content in your migration package, it does not matter where the WebDAV store is located in your current SAS environment. The migration utility copies WebDAV content to the configured WebDAV location in your SAS 9.4 environment. In a default SAS 9.4 configuration, that WebDAV location is the SAS Content Server.
The migration utility writes the report (FullReport.html) to the AnalysisReport subdirectory under the output directory that you specified in the migration utility properties file.
To verify that the report successfully completed, open the migration utility log file, and scroll to the very end of the log. (The migrate.log file is in the top-level directory of your migration utility output directory.)

If you see output similar to the following, then the migration utility finished executing the report:

10:52:55,719 [INFO ] SMU Product analyses completed: 61

10:52:55,720 [INFO ] SMU No packaging was performed due to the mode setting.

If you do not see output lines similar to these, then the migration utility was unable to complete. A common cause can be lack of available disk space.
If you have a multi-tier SAS deployment, you need to create a migration analysis report for each machine. There are specific options depending on the tier (for example, -davtier). For more information, see SAS Migration Utility Overview .

Note: You cannot run the migration utility on more than one machine simultaneously because the migration schema might be updated by more than one process at the same time.

View and Analyze Your Migration Analysis Report

With your migration analysis report, you and your SAS representative can determine what, if any, further maintenance must be applied to your current SAS products in order for your system to be eligible for automatic migration with the SAS Deployment Wizard.

To view your migration analysis report, open FullReport.html in your web browser. (FullReport.html is in the AnalysisReport subdirectory in the output directory that you specified when you last ran the SAS Migration Utility.)

Using the report, answer these questions:

Has the SAS Migration Utility identified any SAS products that are not eligible for automatic migration to SAS 9.4?
Are my SAS products deployed on the machines where I expected them?

The migration analysis report also generates a list of all the SAS products configured in your deployment.

List of Configured Products in Your Current SAS Deployment

This list of configured products can be helpful in creating a SAS 9.4 to use with the SAS Deployment Wizard during the installation and migration task of your SAS 9.4 migration.

Starting in SAS 9.4M1, the migration analysis report offers version analysis. The SAS Migration Utility compares the versions of SAS offerings on your source deployment with a product migration matrix, and then lists all versions of SAS offerings that are unable to be directly migrated to SAS 9.4.

Migration Analysis Report Showing Migration Version Analysis

Using this information, you can review your SAS Software Summary (ordersummary.html) to determine whether the products in your order are supported for automated migration to SAS 9.4. The software summary resides in your SAS Software Depot in install_doc/order-number/ordersummary.html.

SAS Software Summary

TipWhen considering version analysis, carefully choose which version of the SAS Migration Utility to run. As a planning exercise, you can download and run the migration utility from support.sas.com to determine whether you are ready to place your SAS software order. However, new product updates after you place your order might include support for migration. Therefore, running the migration utility that accompanies your order ensures accurate version analysis in your migration analysis report.

View and Analyze the Migration Log

In addition to studying your migration analysis report, the log file produced by the SAS Migration Utility can detect possible problems with your content. The migration utility creates a login the output directory for each machine on which it is run (for example, C:\migration_package\web_tier\migrate.log).

A Note about SAS Tables Stored under the SAS Configuration Directory

Even though the SAS automated migration tools migrate SAS tables that are in the current SAS configuration directory and in a SASEnvironment or Data folder, the best practice is to store your SAS tables outside the SAS configuration directory. Migrating large amounts of data encountered under the configuration directory slows migration utility performance.