SmartNotes Interface Architecture

This document describes the functionality of importing data from Lucanet Rest API into SmartNotes.

For details on the SmartNotes system architecture, see the "SmartNotes Technical Documentation".

Prerequirements

The Lucanet Rest Api interface must be installed on your SmartNotes server. For more information and the installation file, please contact the SmartNotes technical hotline.

Lucanet Rest Api Import to SmartNotes

A new connector must be defined in the SmartNotes Import Administration that uses the "Lucanet Rest Api Import" as interface. If the entry "Lucanet Rest Api Import" is not present in the interfaces dropdown, please contact the SmartNotes technical hotline to provide the library.

Connector Definition

Mandatory Connector Parameters:

1. Host: Host that will be used for API endpoints

2. Database: Database name in LucaNet

3. NumberDecimalSeparator

4. NumberGroupSeparator

5. User: Your Lucanet Api username

6. Password: Your Lucanet Api password

7. Technical User:  if checked the Password will be stored, otherwise not

DataSource Definition

Mandatory DataSource Parameters:

1. Adjustment Level: Adjustment Level across which the data is to be requested.

2. Data Level: Data Level across which the data is to be requested.

3. First Month: The start date of the reporting period Yes Date, YYYYMM.

4. Ledger: the specific ledger (financial report).

5. Organization Elements: Organization Elements across which the data is to be requested.

6. Period Type: Periodicity of data requested.

Optional DataSource Parameters:

1. Display Currency: Display Currency across which the data is to be requested.

2. DrillDownLevel: Define until which depth level the ledger should be expanded. '-1' means all levels and '0' the root.

3. First Month of Fiscal Year: The first month of the fiscal year.

4. Last Month: Last month of the reporting period.

5. Partners: Partners across which the data is to be requested.

6. Period Request Type: The following values are available:

   1. STANDARD: Default value of the account on a given date (i.e. BALANCE on a balance account).

   2. START: Returns the start value of the account on a given date.

   3. TRANSACTION_FIGURES: Returns the change to the account on a given date.

   4. BALANCE: Returns the balance of the account on a given date.

7. Transaction Currency Transaction Currency across which the data is to be requested.

8. Transaction Types: Transaction Types across which the data is to be requested.

Mapping Definition 

Please refer to the normal SmartNotes user documentation or AMANA consulting for assistance with this step.

After the mapping definition has been done correctly, a non-empty position preview should be available. The import definition is then fully set up and an import can be performed.