fmeobjects.FMELicenseManager¶

FMELicenseManager.get3rdLicenseProperty(…) Retrieves the value of a property from a 3rd party license file.

FMELicenseManager.getAllFactories() Returns all the factory names for the current license.

FMELicenseManager.getAllFormats() Returns all the format names for the current license.

FMELicenseManager.getAllFunctions() Returns all the function names for the current license.

FMELicenseManager.getAppLicenseProperty(…) Retrieves the value of a property for a given application.

FMELicenseManager.getFactoryLicenseProperty(…) Retrieves the value of a property for a given factory.

FMELicenseManager.getFactoryMinBaseCapability getFactoryMinBaseCapability(factoryName),

FMELicenseManager.getFunctionLicenseProperty(…) Retrieves the value of a property for a given function.

FMELicenseManager.getFunctionMinBaseCapability(…) Returns the minimum base capability for the specified function to be licensed.

FMELicenseManager.getLicenseProperty(property) Retrieves the value of a property from the current license.

FMELicenseManager.getLicenseType() Returns the current license type.

FMELicenseManager.getMaxFMEProcesses() This routine returns the maximum number of licensed fme processes.

FMELicenseManager.getMaxFMEWorkerProcesses() This routine returns the maximum number of licensed fmeworker processes.

FMELicenseManager.getReaderLicenseProperty(…) Retrieves the value of a property for a given reader.

FMELicenseManager.getReaderMinBaseCapability(…) Returns the minimum base capability for the specified reader to be licensed.

FMELicenseManager.getWriterLicenseProperty(…) Retrieves the value of a property for a given writer.

FMELicenseManager.getWriterMinBaseCapability(…) Returns the minimum base capability for the writer factory to be licensed.

FMELicenseManager.hasBaseCapability(capability) Returns whether or not the minimum base capability is met.

FMELicenseManager.isAppLicensed(appName) Returns whether or not an application is licensed.

FMELicenseManager.isArcGISInstalled(productName) Returns whether or not a given ArcGIS product is installed.

FMELicenseManager.isArcObjectsLicensed()

rtype:	bool

FMELicenseManager.isFactoryLicensed(factoryName) Returns whether or not a given factory is licensed.

FMELicenseManager.isFunctionLicensed(…) Returns whether or not a given function is licensed.

FMELicenseManager.isGtransInstalled() Returns whether or not the Gtrans reprojection library is installed.

FMELicenseManager.isReaderLicensed(readerName) Returns whether or not a given reader is licensed.

FMELicenseManager.isWriterLicensed(writerName) Returns whether or not a given writer is licensed.

FMELicenseManager.validateLicenseFile(…) This method is used to validate a license file.

class FMELicenseManager¶

Bases: object

FME License Manager Class

init()

This class provides an interface to security functionality.

__init__¶: Initialize self. See help(type(self)) for accurate signature.

get3rdLicenseProperty(licenseFileName, vendorID)¶

Retrieves the value of a property from a 3rd party license file.

Parameters:	licenseFileName (str) – The file name of a 3rd party license file. vendorID (int) – The custom key assigned by the vendor, used to verify that the property is licensed. vendorRegKey (int) – The registration code of the vendor assigned by Safe Software, used to verify that the property is licensed. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getAllFactories()¶

Returns all the factory names for the current license. For all factories the list will be populated with <factory name>/<license value> pairs. <license value> can be either kFME_FormatLicensed or kFME_FormatUnlicensed.

Return type:	tuple[str] or `None`
Returns:	All the factories for the current license or `None` if unsuccessful.

getAllFormats()¶

Returns all the format names for the current license. For all formats the list will be populated with <format name>/<license value> pairs. <license value> can be one of the following:

kFME_FormatRead: Only reader is licensed.

kFME_FormatWrite: Only writer is licensed.

kFME_FormatBoth: Both reader and writer are licensed.

kFME_FormatUnlicensed: Neither reader nor writer is licensed.

Return type:	tuple[str] or None
Returns:	All the formats for the current license or `None` if unsuccessful.

getAllFunctions()¶

Returns all the function names for the current license. For all functions the list will be populated with <function name>/<license value> pairs. <license value> can be either kFME_FormatLicensed or kFME_FormatUnlicensed.

Return type:	tuple[str] or None
Returns:	All the functions for the current license or `None` if unsuccessful.

getAppLicenseProperty(appName, property)¶

Retrieves the value of a property for a given application. This is only used for application in which there are different levels of support.

Parameters:	appName (str) – The name of the application. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getFactoryLicenseProperty(factoryName, property)¶

Retrieves the value of a property for a given factory. This is only used for factories in which there are different levels of support.

Parameters:	factoryName (str) – The name of the factory. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getFactoryMinBaseCapability()¶

getFactoryMinBaseCapability(factoryName),

Returns the minimum base capability for the specified factory to be licensed. Will return one of the following capability names:

DESKTOP
PROFESSIONAL
ENTERPRISE_GIS
ENTERPRISE_DB
SERVER
SMALLWORLD
NATIONAL
BASIC_RASTER
ADVANCED_RASTER
EXTRA_COST

Parameters:	factoryName (str) – The name of the factory.
Return type:	str
Returns:	The minimum base capability or `None` otherwise.

getFunctionLicenseProperty(functionName, property)¶

Retrieves the value of a property for a given function. This is only used for function in which there are different levels of support.

Parameters:	functionName (str) – The name of the function. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getFunctionMinBaseCapability(functionName)¶

Returns the minimum base capability for the specified function to be licensed. Will return one of the following capability names:

DESKTOP
PROFESSIONAL
ENTERPRISE_GIS
ENTERPRISE_DB
SERVER
SMALLWORLD
NATIONAL
BASIC_RASTER
ADVANCED_RASTER
EXTRA_COST

Parameters:	functionName (str) – The name of the function.
Return type:	str
Returns:	The minimum base capability or `None` otherwise.

getLicenseProperty(property)¶

Retrieves the value of a property from the current license.

Parameters:	property (str) – The name of the property to be retrieved.
Return type:	str
Returns:	The value of the property if successful or `None` otherwise.

getLicenseType()¶

Returns the current license type. Possible values are:

MACHINE SPECIFIC
OEM
GENERIC
FLOATING.

Return type:	str
Returns:	The current license type if successful or `None` otherwise.

getMaxFMEProcesses()¶

This routine returns the maximum number of licensed fme processes.

Return type:	int
Returns:	Returns the maximum number of licensed fme processes.

getMaxFMEWorkerProcesses()¶

This routine returns the maximum number of licensed fmeworker processes.

Return type:	int
Returns:	Returns the maximum number of licensed fmeworker processes.

getReaderLicenseProperty(readerName, property)¶

Retrieves the value of a property for a given reader. This is only used for reader in which there are different levels of support.

Parameters:	readerName (str) – The name of the reader. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getReaderMinBaseCapability(readerName)¶

Returns the minimum base capability for the specified reader to be licensed. Will return one of the following capability names:

DESKTOP
PROFESSIONAL
ENTERPRISE_GIS
ENTERPRISE_DB
SERVER
SMALLWORLD
NATIONAL
BASIC_RASTER
ADVANCED_RASTER
EXTRA_COST

Parameters:	readerName (str) – The name of the reader.
Return type:	str
Returns:	The minimum base capability or `None` otherwise.

getWriterLicenseProperty(writerName, property)¶

Retrieves the value of a property for a given writer. This is only used for writer in which there are different levels of support.

Parameters:	writerName (str) – The name of the writer. property (str) – The name of the property to be retrieved.
Return type:	str or None
Returns:	The value of the property if successful or `None` otherwise.

getWriterMinBaseCapability(writerName)¶

Returns the minimum base capability for the writer factory to be licensed. Will return one of the following capability names:

DESKTOP
PROFESSIONAL
ENTERPRISE_GIS
ENTERPRISE_DB
SERVER
SMALLWORLD
NATIONAL
BASIC_RASTER
ADVANCED_RASTER
EXTRA_COST

Parameters:	writerName (str) – The name of the writer.
Return type:	str
Returns:	The minimum base capability or `None` otherwise.

hasBaseCapability(capability)¶

Returns whether or not the minimum base capability is met.

Return type:	bool
Returns:	`True` if the capability is met, `False` otherwise.

isAppLicensed(appName)¶

Returns whether or not an application is licensed.

Parameters:	appName (str) – The name of the application.
Return type:	bool
Returns:	Returns `True` if the application is licensed and `False` otherwise.

isArcGISInstalled(productName)¶

Returns whether or not a given ArcGIS product is installed. The following products are supported:

ArcGIS Desktop
ArcGIS Engine
ArcGIS Server
None - any ArcGIS product

Parameters:	productName (str) – The name of the ArcGIS product.
Return type:	bool
Returns:	Returns `True` if the product is installed and `False` otherwise.

isArcObjectsLicensed()¶

Return type:	bool

isFactoryLicensed(factoryName)¶

Returns whether or not a given factory is licensed.

Parameters:	factoryName (str) – The name of a given factory.
Return type:	bool
Returns:	Returns `True` if the factory is licensed and `False` otherwise.

isFunctionLicensed(functionName)¶

Returns whether or not a given function is licensed.

Parameters:	functionName (str) – The name of a given function.
Return type:	bool
Returns:	Returns `True` if the function is licensed and `False` otherwise.

isGtransInstalled()¶

Returns whether or not the Gtrans reprojection library is installed.

Return type:	bool
Returns:	Returns `True` if the Gtrans reprojection library is installed and `False` otherwise.

isReaderLicensed(readerName)¶

Returns whether or not a given reader is licensed.

Parameters:	readerName (str) – The name of a given reader.
Return type:	bool
Returns:	Returns `True` if the reader is licensed and `False` otherwise.

isWriterLicensed(writerName)¶

Returns whether or not a given writer is licensed.

Parameters:	writerName (str) – The name of a given writer.
Return type:	bool
Returns:	Returns `True` if the writer is licensed and `False` otherwise.

validateLicenseFile(licenseFilePath)¶

This method is used to validate a license file. Note: It is not using the license file but rather merely returning whether or not the license file is valid for the current machine if it is installed.

Parameters:	licenseFilePath (str) – The full path of the license file.
Return type:	int
Returns:	If the file is valid it returns 0 otherwise a non-zero error code.