SetProduct (arcpy)

Summary

The SetProduct function defines the desktop license. SetProduct returns information on the license.

Legacy:

The product level should be set by importing the appropriate product module (arcinfo, arceditor, arcview, arcserver, arcenginegeodb, or arcengine) prior to importing arcpy. The SetProduct function is a legacy function and cannot set the product once arcpy has been imported.

For scripts using the arcgisscripting module, the equivalent SetProduct method is still supported.

Discussion

Tip:

The setting of the product and extensions is only necessary within stand-alone scripts. If you are running tools from the Python window or using script tools, the product is already set from within the application, and the active extensions are based on the Extensions dialog box.

Syntax

SetProduct (product)

Parameter	Explanation	Data Type
product	Product code for the product being set. arcview —ArcGIS for Desktop Basic product code arceditor —ArcGIS for Desktop Standard product code arcinfo —ArcGIS for Desktop Advanced product code engine —Engine Runtime product code enginegeodb —Engine Geodatabase Update product code arcserver — Server product code	String

Return Value

Data Type	Explanation
String	The function returns the status on the product license. There are four possible values: CheckedOut —License successfully set. AlreadyInitialized —License has already been set. NotLicensed —The license is not valid or available. Failed —A system failure occurred during the set request.

Code Sample

SetProduct example

Sets an ArcGIS for Desktop Basic product license using the arcview module.

# Set the ArcGIS for Desktop Basic product by importing the arcview module.
import arcview
import arcpy

arcpy.env.workspace = "c:/data/SanDiego.gdb"

arcpy.CreateRasterDataset_management(
    arcpy.env.workspace, "LandUse", "30", "8_BIT_UNSIGNED",
    "Freeways", 1)