Understanding License Controls
All methods in the GX API require the user to have been granted the right to access that method in the way it is being used by your program. The entitlements of the end-user are checked when a GX (or external program) calls a GX function. Each function will fall under one of the license classes below:
Type | Description |
|---|---|
Public | Available with the free Viewer, and the GX Developer redistributable libraries. No entitlements are needed to access these classes and methods. Note, that some of the methods that are public may have reduced functionality. For example, any size database can be read, but there are restrictions in the size of data that can be written to a Public license user. |
Controlled | These methods require Oasis montaj to be installed with the Geosoft license installed for the end-user use the method. The GX_GEOSOFT_BIN_PATH environment variable, if defined, must point to the ' |
Extended | These methods require specific licenses to execute. Since the license structure that enables these methods is dynamic it is recommended that GX Developers not use Extended methods. |
A user that runs a GX or program that includes calls to method calls for which she is not entitled will receive an error like:
geosoft.GX.Error: Unable to bind the "?rGet_PG@@YANPAUh_gxx@@PBJ11@Z" wrapper function. The DLL may not be present or a license may be missing.
Well written programs or GXs should catch this error and report the problem to the user with a recommended course of action.
VIEWGX - Entitlement/License Analysis
To help GX developers determine the entitlement requirements for their GX to execute, the VIEWGX program can provide a license analysis of a GX. To view this analysis run:
VIEWGX –l MyGX.GX
This will produce a listing of licenses under which this GX can be used. For example:
This GX will execute with the following licenses: 10000 Oasis montaj Mapping and Processing System 10100 montaj Geophysics 10101 montaj Chimera Geochemistry 10102 montaj Drillhole Plotting 10103 montaj Induced Polarization 10104 montaj Geophysics Leveling 10105 montaj MAGMAP Filtering 10106 montaj Grav/Mag Interpretation 10107 montaj Airborne Quality Control 10108 montaj 256-Channel Radiometric Processing 10109 montaj Gravity and Terrain Correction 10110 montaj Gridknit 10111 montaj UX-Detect 10200 montaj DAP Administrator 10500 montaj plus Modeling Lite 10520 montaj plus GMSYS Basic Profile Modeling 10521 montaj plus GMSYS Intermediate Profile Modeling 10522 montaj plus GMSYS Advanced Profile Modeling 10523 montaj plus Modeling 3D 10524 montaj plus Depth To Basement 10525 montaj plus Isostatic Residual 10540 montaj plus Grav/Mag Filtering 10541 montaj plus Compudrape 30000 Target Surface and Drillhole Mapping 30101 Target Chimera Geochemical QA and Analysis
If a more detailed analysis is required, the –L options can be used to produce output as follows:
This GX will execute with the following licenses: 0 Public License missing Wrapper [Create_BIGRID] Marble missing Wrapper [Destroy_BIGRID] Marble missing Wrapper [iLoadParms_BIGRID] Marble missing Wrapper [Run_BIGRID] Marble 10000 Oasis montaj Mapping and Processing System OK 10100 montaj Geophysics OK 10101 montaj Chimera Geochemistry OK 10102 montaj Drillhole Plotting OK 10103 montaj Induced Polarization OK 10104 montaj Geophysics Leveling OK 10105 montaj MAGMAP Filtering OK 10106 montaj Grav/Mag Interpretation OK 10107 montaj Airborne Quality Control OK 10108 montaj 256-Channel Radiometric Processing OK 10109 montaj Gravity and Terrain Correction OK 10110 montaj Gridknit OK 10111 montaj UX-Detect OK 10200 montaj DAP Administrator OK 10500 montaj plus Modeling Lite OK 10520 montaj plus GMSYS Basic Profile Modeling OK 10521 montaj plus GMSYS Intermediate Profile Modeling OK 10522 montaj plus GMSYS Advanced Profile Modeling OK 10523 montaj plus Modeling 3D OK 10524 montaj plus Depth To Basement OK 10525 montaj plus Isostatic Residual OK 10540 montaj plus Grav/Mag Filtering OK 10541 montaj plus Compudrape OK 30000 Target Surface and Drillhole Mapping OK 30101 Target Chimera Geochemical QA and Analysis OK
Each general license supported by Geosoft will be listed along with either “OK” or the reasons this GX will not execute under this license. This program can be very useful in determining what licenses will be required to run your GX. Note that the license tables can and do change between versions so the 6.0 version of VIEWGX is only accurate for the 6.0 version.