Difference between revisions of "API:FAQ:New Wrapper"

From Melissa Data Wiki
Jump to navigation Jump to search
 
Line 6: Line 6:
Please use the Powershell (Windows) or Bash (Linux) scripts to generate the Wrapper Library located within the github links below. The new sample projects and wrapper interfaces can be found using the hyperlinks provided below.
Please use the Powershell (Windows) or Bash (Linux) scripts to generate the Wrapper Library located within the github links below. The new sample projects and wrapper interfaces can be found using the hyperlinks provided below.


===Programming Language Support===
<h3 class="productfield">Programming Language Support</h3>
The following languages '''are supported''' with the new wrapper interface and sample projects:
:The following languages '''are supported''' with the new wrapper interface and sample projects:


*[[#Java|Java]]
:*[[#Java|Java]]
*[[#DotNet|DotNet]]
:*[[#DotNet|DotNet]]
*[[#Python3|Python3]]
:*[[#Python3|Python3]]


The following languages are '''no longer supported''' with the new wrapper interface and sample projects:
:The following languages are '''no longer supported''' with the new wrapper interface and sample projects:


*Perl
:*Perl
*PHP
:*PHP
*Ruby
:*Ruby
*SQLServer
:*SQLServer
*PLSQL
:*PLSQL


===License String===
<h3 class="productfield">License String</h3>
The new scripts will prompt you for a license string. You may have stored this as an environment variable (<code>MD_LICENSE</code>).
:The new scripts will prompt you for a license string. You may have stored this as an environment variable (<code>MD_LICENSE</code>).


To obtain a license string and get started, please contact a sales representative by:
:To obtain a license string and get started, please contact a sales representative by:


*Calling 1-800-MELISSA
:*Calling 1-800-MELISSA
*Emailing Sales@melissa.com
:*Emailing Sales@melissa.com


===Melissa Updater===
<h3 class="productfield">Melissa Updater</h3>
By default, the scripts use an additional tool called '''MelissaUpdater'''. '''MelissaUpdater''' will download the latest release library and data files for each object.
:By default, the scripts use an additional tool called '''MelissaUpdater'''. '''MelissaUpdater''' will download the latest release library and data files for each object.


Note, you can disable either the library or data file download by modifying the script prior to running the script.
:Note, you can disable either the library or data file download by modifying the script prior to running the script.
 
<h3 class="productfield">Releases Browser</h3>
:Melissa Updater uses the Releases web service on the back end.
 
:You can also get the latest (and previous) releases via the Releases Browser at [https://releases.melissadata.net/browse Data Download Browse].
 
<h3 class="productfield">Github</h3>
:The wrapper code and sample projects are also available via Git at https://github.com/MelissaData.
 
:The sample projects will also include instructions for using Melissa Updater to keep your binaries and data files up to date.




Line 47: Line 57:
:*If a '''jar''' file is required by your application, replace '''both''' the new jar file and the wrapper library (.dll or .so).
:*If a '''jar''' file is required by your application, replace '''both''' the new jar file and the wrapper library (.dll or .so).


:;Wrapper
:;Wrapper (Git)


:*https://github.com/MelissaData/AddressObject-Java-Wrappers
:*https://github.com/MelissaData/AddressObject-Java-Wrappers
Line 53: Line 63:
:*https://github.com/MelissaData/NameObject-Java-Wrappers
:*https://github.com/MelissaData/NameObject-Java-Wrappers
:*https://github.com/MelissaData/PhoneObject-Java-Wrappers
:*https://github.com/MelissaData/PhoneObject-Java-Wrappers
:;Wrapper (Releases Browser):
:*https://releases.melissadata.net/browse?MFT=dq_java_wrappers&RELEASE=latest


:;Sample Projects (Windows)
:;Sample Projects (Windows)
Line 75: Line 89:
:*Instead, we provide a .cs file that can be included in the project and called directly from the code.
:*Instead, we provide a .cs file that can be included in the project and called directly from the code.


:;Wrapper
:;Wrapper (Git)


:*https://github.com/MelissaData/AddressObject-Dotnet-Wrappers
:*https://github.com/MelissaData/AddressObject-Dotnet-Wrappers
Line 81: Line 95:
:*https://github.com/MelissaData/NameObject-Dotnet-Wrappers
:*https://github.com/MelissaData/NameObject-Dotnet-Wrappers
:*https://github.com/MelissaData/PhoneObject-Dotnet-Wrappers
:*https://github.com/MelissaData/PhoneObject-Dotnet-Wrappers
:;Wrapper (Releases Browser):
:*https://releases.melissadata.net/browse?MFT=dq_dotnet_wrappers&RELEASE=latest


:;Sample Projects (Windows)
:;Sample Projects (Windows)
Line 100: Line 118:
:;Quick Notes:
:;Quick Notes:


:*We no longer generate wrapper library for Python.
:*We no longer generate a wrapper library for Python.
:*Instead, we provide a .py file that can be included in the project and called directly from the Python code.
:*Instead, we provide a .py file that can be included in the project and called directly from the Python code.


:;Wrapper
:;Wrapper (Git)


:*https://github.com/MelissaData/AddressObject-Python3-Wrappers
:*https://github.com/MelissaData/AddressObject-Python3-Wrappers
Line 109: Line 127:
:*https://github.com/MelissaData/NameObject-Python3-Wrappers
:*https://github.com/MelissaData/NameObject-Python3-Wrappers
:*https://github.com/MelissaData/PhoneObject-Python3-Wrappers
:*https://github.com/MelissaData/PhoneObject-Python3-Wrappers
:;Wrapper (Releases Browser):
:*https://releases.melissadata.net/browse?MFT=dq_python3_wrappers&RELEASE=latest


:;Sample Projects (Windows)
:;Sample Projects (Windows)
Line 123: Line 145:
:*https://github.com/MelissaData/NameObject-Python3-Linux
:*https://github.com/MelissaData/NameObject-Python3-Linux
:*https://github.com/MelissaData/Phonebject-Python3-Linux
:*https://github.com/MelissaData/Phonebject-Python3-Linux
==Releases Browser==
Several major programming languages are supported via wrapper code. These wrappers are maintained and released along with our objects via the Releases service and via Github as mentioned in [[#Programming Language Notes|Programming Language Notes]].
<h3 class="productfield">Browser Location</h3>
:;Links to the released wrappers for each product can be found here<nowiki>:</nowiki> [https://releases.melissadata.net/browse Data Download Browse.]
:*(Select Manifest: *_wrappers)
:*You do not need to enter your License to get download links for wrappers.
<h3 class="productfield">Wrappers</h3>
:;Wrappers for Address, Email, Name, and Phone objects (select a "Release" and click "Update" for past releases)<nowiki>:</nowiki>
:*https://releases.melissadata.net/browse?MFT=dq_addr_wrappers&RELEASE=latest
:*https://releases.melissadata.net/browse?MFT=dq_email_wrappers&RELEASE=latest
:*https://releases.melissadata.net/browse?MFT=dq_name_wrappers&RELEASE=latest
:*https://releases.melissadata.net/browse?MFT=dq_phone_wrappers&RELEASE=latest

Latest revision as of 18:16, 22 September 2023

June 2023 - New Wrapper and Sample Project Release

As of June 2023, Melissa has released new wrapper interfaces with a console-based sample program for all DQT Suite objects. We recommend that you start using the new Wrapper interface to leverage all of the new features.

Note, all of our previous Wrapper Interfaces will still work as intended, but will not include new methods that may have been added with the June 2023 release.

Please use the Powershell (Windows) or Bash (Linux) scripts to generate the Wrapper Library located within the github links below. The new sample projects and wrapper interfaces can be found using the hyperlinks provided below.

Programming Language Support

The following languages are supported with the new wrapper interface and sample projects:
The following languages are no longer supported with the new wrapper interface and sample projects:
  • Perl
  • PHP
  • Ruby
  • SQLServer
  • PLSQL

License String

The new scripts will prompt you for a license string. You may have stored this as an environment variable (MD_LICENSE).
To obtain a license string and get started, please contact a sales representative by:
  • Calling 1-800-MELISSA
  • Emailing Sales@melissa.com

Melissa Updater

By default, the scripts use an additional tool called MelissaUpdater. MelissaUpdater will download the latest release library and data files for each object.
Note, you can disable either the library or data file download by modifying the script prior to running the script.

Releases Browser

Melissa Updater uses the Releases web service on the back end.
You can also get the latest (and previous) releases via the Releases Browser at Data Download Browse.

Github

The wrapper code and sample projects are also available via Git at https://github.com/MelissaData.
The sample projects will also include instructions for using Melissa Updater to keep your binaries and data files up to date.


Programming Language Notes

Java

Quick Notes
  • The Jar file is no longer required but can be generated with the following commands:
javac com/melissadata/*.java
  • This command compiles the java files inside the com/melissadata folder
jar cvf {OUTPUTNAME}.jar com
  • This command will zip up all the files inside the com folder. {OUTPUTNAME} should be renamed as mdAddr.jar, mdEmail.jar, mdPhone.jar, or mdName.jar
  • If a jar file is required by your application, replace both the new jar file and the wrapper library (.dll or .so).
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)


Dotnet

Quick Notes
  • We no longer generate wrapper libraries for DotNet and DotNetCore.
  • Instead, we provide a .cs file that can be included in the project and called directly from the code.
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)


Python3

Quick Notes
  • We no longer generate a wrapper library for Python.
  • Instead, we provide a .py file that can be included in the project and called directly from the Python code.
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)
Retrieved from "http://wiki.melissadata.com/index.php?title=API:FAQ:New_Wrapper&oldid=19922"