Revision History
Download 1.41 Mb. Pdf ko'rish
|
Lacerte SDK Developer Instructions
Interface
Name Usage Methods Description ILacerteAccess Provides multiple interface implementation to use .Net Library CreateTPRegister Create an interface which registers third party integration with SDK CreateDBFReader Create an interface which is capable of reading data from a DBF file CreateDBFWriter Create an interface which is capable of writing data from a DBF file ITPRegistration Can be created by calling CreateTPRegister, used for third party registration Register Provides a way to register third application to SDK IDBFReader Init Initialize the IDBFReader interface Lacerte Software Development Kit Developer Instructions pg. 19 Interface for reading data from DBF file ReadFromDBFData Read all data from a DBF file in XML file format IDBFWriter Interface for Writing data to DBF file WriteToDBFDatabase Write to a DBF file with specified field name IClient Interface for representing a Lacerte client IClientList List of IClient represents a Datapath SetDataPath CreateClient GetClientList Using SDK Library as a COM component SDK library is designed as a COM library and can be loaded as COM component by referencing COM tlb files. Below example gives an example of loading component as COM from a VB project. 1. Go to COM object reference (which will list all TLB registered) 2. Select LacerteSDK_Access, LacerteSDK_Interfaces and LacerteSDK_SharedInterfaces from list of available TLB files 3. Write your on method to use SDK library with sample code below: Lacerte Software Development Kit Developer Instructions pg. 20 Register Third-party Integration with Lacerte SDK To ensure the Lacerte customer’s data is properly protected, we require every third party application to “register” their integration with the SDK. This registration will show the consent dialog below for the Lacerte user to confirm and allow your application to access the data. Grant permission is required to use Lacerte data from any third party application. User experience of Registration Registration calls to SDK will show the user consent window once per user, per system for the application which is using the Lacerte SDK. Users have to click Grant permission to make any read or write operations using the SDK. Login to SDK Lacerte SDK needs user authentication similar to Lacerte login. When a user click on grant permission, it prompts a login UI as below, where-in user have to use Lacerte login credentials to login to the SDK. The login UI will prompt every 24 hour for re-login. Lacerte Software Development Kit Developer Instructions pg. 21 Steps to perform registration 1. Create an instance of ILacerteAccess interface 2. Using instance from #1, call ITPRegistration creation through CreateTPRegister 3. ITPRegistration instance can be used for calling register Sample code for registration as .Net library ILacerteAccess objLacdriverTest = new LacerteAccess (); ITPRegistration objReg = objLacdriverTest.CreateTPRegister(); TPSDKStatus Access = objReg.Register( "Lacerte Test Harness" , "9C3EF09C-DA54-4531-9A82-8F1EEA922AE0" , "2018" ); if (Access == TPSDKStatus .AccessGranted) { MessageBox .Show( "Access Granted" ); } Sample code for registration as COM object (from a VB Project) Dim AccessObj As LacerteSDK_Access.LacerteAccess Dim RegObj As LacerteSDK_SharedInterfaces.ITPRegistration Set AccessObj = New LacerteSDK_Access.LacerteAccess Dim Status As TAPIStatus Set RegObj = AccessObj.CreateTPRegister Status = RegObj.Register("Test-App", "99999-897", "2018") Lacerte Software Development Kit Developer Instructions pg. 22 Above code will pop-up an access dialogue box followed a by sign in windows to login to SDK. Parameters for Register function 1. String – ThirdPartyName (Third party application name) 2. String – AppID – Unique GUID to recognize the third party application 3. String – TaxYear – Tax year of the program where third party application reading data. Return Status: (TPSDKStatus status enum) Download 1.41 Mb. Do'stlaringiz bilan baham: |
Ma'lumotlar bazasi mualliflik huquqi bilan himoyalangan ©fayllar.org 2024
ma'muriyatiga murojaat qiling
ma'muriyatiga murojaat qiling