Difference between revisions of "Global Address Object:Licensing"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Global Address Object:Reference|← Global Address Object Reference]]
+
{{GlobalAddressObjectNav
 
+
|IntroductionCollapse=
{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
+
}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
 
|-
 
| style="padding-right:220px;"|
 
|-
 
|
 
{| class="mw-collapsible" style="width:100%;"
 
|- align="left"
 
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
 
|-
 
|[[Global Address Object:Platforms and Methods|Platforms and Methods]]
 
|-
 
|[[Global Address Object:Licensing|Licensing]]
 
|}
 
|-
 
|
 
{| class="mw-collapsible mw-collapsed" style="width:100%;"
 
|- align="left"
 
! style="color:black;"|[[Global Address Object:Interface|Interface]]
 
|-
 
|[[Global Address Object:Address Handling|Address Handling]]
 
|-
 
|[[Global Address Object:Interface Use|Interface Use]]
 
|}
 
|-
 
|
 
{| class="mw-collapsible mw-collapsed" style="width:100%;"
 
|- align="left"
 
! style="color:black;"|[[Global Address Object:Methods|Methods]]
 
|-
 
|[[Global Address Object:Setup Methods|Setup Methods]]
 
|-
 
|[[Global Address Object:Input Methods|Input Methods]]
 
|-
 
|[[Global Address Object:Processing Methods|Processing Methods]]
 
|-
 
|[[Global Address Object:Output Methods|Output Methods]]
 
|}
 
|-
 
|
 
{| class="mw-collapsible mw-collapsed" style="width:100%;"
 
|- align="left"
 
! style="color:black;"|Parameters
 
|-
 
|[[Global Address Object:Input Parameters|Input Parameters]]
 
|-
 
|[[Global Address Object:Output Parameters|Output Parameters]]
 
|}
 
|-
 
|
 
{| class="mw-collapsible mw-collapsed" style="width:100%;"
 
|- align="left"
 
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
 
|-
 
|[[Global Address Object:Result Code Use|Result Code Use]]
 
|-
 
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
 
|-
 
|[[Global Address Object:Other Codes|Other Codes]]
 
|}
 
|}
 
 
 
  
 
{{CustomTOC}}
 
{{CustomTOC}}
  
 
==Licensing==
 
==Licensing==
The license string is a software key that unlocks the full functionality of the component. Without the license string, Global Address Object will not function.There are two methods of setting the license string, using an environment variable called MD_LICENSE or passing it as a parameter using the SetLicenseString function. Global Address Object employs a shared license and environmental variable with the rest of the Melissa Data product line of programming tools. This is important to consider if you are using Global Address Object with other Melissa Data products. If you are using multiple products, you only need one license string as long as that license string is enable for all the products you intend to use.
+
The License Key is a software key that unlocks the full functionality of the component. Without the License Key, Global Address Object will not function.There are two methods of setting the License Key, using an environment variable called MD_LICENSE or passing it as a parameter using the SetLicenseString function. Global Address Object employs a shared License Key and environmental variable with the rest of the Melissa Data product line of programming tools. This is important to consider if you are using Global Address Object with other Melissa Data products. If you are using multiple products, you only need one License Key as long as that License Key is enabled for all the products you intend to use.
  
 
===Environment Variable===
 
===Environment Variable===
You can set the license string using an environment variable called MD_LICENSE. If MD_LICENSE is set, it will override any value set using the SetLicenseString function.
+
You can set the License Key using an environment variable called MD_LICENSE. If MD_LICENSE is set, it will override any value set using the SetLicenseString function.
  
Using an environment variable is the recommended best practice. It is much easier to manage and update the license string when it is stored in an environment variable.
+
Using an environment variable is the recommended best practice. It is much easier to manage and update the License Key when it is stored in an environment variable.
  
 
The environment variable is shared with the Melissa Data product line of programming tools.
 
The environment variable is shared with the Melissa Data product line of programming tools.
Line 83: Line 22:
 
#Click New.
 
#Click New.
 
#Enter “MD_LICENSE” in the Variable Name box.
 
#Enter “MD_LICENSE” in the Variable Name box.
#Enter the license string in the Variable Value box, and then click OK.
+
#Enter the License Key in the Variable Value box, and then click OK.
  
Please remember that these settings take effect only upon initialization of the application. It may be necessary to stop and restart the program to utilize the license string.
+
Please remember that these settings take effect only upon initialization of the application. It may be necessary to stop and restart the program to utilize the License Key.
  
 
===Parameter===
 
===Parameter===
You can also pass in the license string as a parameter to the SetLicenseString function.
+
You can also pass in the License Key as a parameter to the SetLicenseString function.
  
As mentioned above, it is recommended to use an environment variable. If you set the license string in a parameter you run the risk of needing to edit and recompile any application using the Global Address Object any time you need to manage or update the license string.
+
As mentioned above, it is recommended to use an environment variable. If you set the License Key in a parameter you run the risk of needing to edit and recompile any application using the Global Address Object any time you need to manage or update the License Key.
  
===Demo License===
+
===Demo License Key===
If you have an existing MD_LICENSE but was given a demo license to try out Global Address Object, you can use the environment variable MD_LICENSE_DEMO. This avoids conflicts or confusion if you already have active subscriptions to other Melissa Data object products.
+
If you have an existing MD_LICENSE but was given a demo License Key to try out Global Address Object, you can use the environment variable MD_LICENSE_DEMO. This avoids conflicts or confusion if you already have active subscriptions to other Melissa Data object products.
  
  
Line 107: Line 46:
  
 
†Not required for all countries but are for most
 
†Not required for all countries but are for most
 
  
  
 
[[Category:Global Address Object]]
 
[[Category:Global Address Object]]
 
[[Category:Reference]]
 
[[Category:Reference]]

Latest revision as of 18:42, 16 December 2016

← Global Address Object Reference

Global Address Object Navigation
Introduction
System Requirements
Setup
Licensing
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Global Address Object Result Codes
Other Codes



Licensing

The License Key is a software key that unlocks the full functionality of the component. Without the License Key, Global Address Object will not function.There are two methods of setting the License Key, using an environment variable called MD_LICENSE or passing it as a parameter using the SetLicenseString function. Global Address Object employs a shared License Key and environmental variable with the rest of the Melissa Data product line of programming tools. This is important to consider if you are using Global Address Object with other Melissa Data products. If you are using multiple products, you only need one License Key as long as that License Key is enabled for all the products you intend to use.

Environment Variable

You can set the License Key using an environment variable called MD_LICENSE. If MD_LICENSE is set, it will override any value set using the SetLicenseString function.

Using an environment variable is the recommended best practice. It is much easier to manage and update the License Key when it is stored in an environment variable.

The environment variable is shared with the Melissa Data product line of programming tools.

Windows users can set environment variables using the following steps:

  1. Select Start > Settings, and then click Control Panel.
  2. Double-click System and then click the Advanced tab.
  3. Click Environment Variables, and then select either System Variables or Variables for the user X.
  4. Click New.
  5. Enter “MD_LICENSE” in the Variable Name box.
  6. Enter the License Key in the Variable Value box, and then click OK.

Please remember that these settings take effect only upon initialization of the application. It may be necessary to stop and restart the program to utilize the License Key.

Parameter

You can also pass in the License Key as a parameter to the SetLicenseString function.

As mentioned above, it is recommended to use an environment variable. If you set the License Key in a parameter you run the risk of needing to edit and recompile any application using the Global Address Object any time you need to manage or update the License Key.

Demo License Key

If you have an existing MD_LICENSE but was given a demo License Key to try out Global Address Object, you can use the environment variable MD_LICENSE_DEMO. This avoids conflicts or confusion if you already have active subscriptions to other Melissa Data object products.


Minimum Inputs

The Global Address Object has a set of minimum values it needs to have a chance at verifying an address record. The minimum fields required are as follows:

  • Address Line 1
  • Country

Within those minimum required fields, the minimum required content are:

  • Delivery address
  • (Locality and Administrative Area) or Postal Code†
  • Country Name or Country Code

†Not required for all countries but are for most