Page Comparison

After Burti Rest API package has been added to your HW client this page will show you basics how to set up and use this functionality.

...

1. Preparing for the use of package
2. Setting up the API register definitions
3. Writing and reading the registers

Preparing

First you need to go to main API register - module: Burti - JSON API> Registers> API Register definitions

...

1. Adding the entries manually
2. Adding the entries using module: Burti - JSON API> Routines> Imports> Export/Import format file

Mainly using the Import is easier (at least for the first times) - next Next steps are shown using the method with Import through: Burti - JSON API> Routines> Imports> Export/Import format file

Choosing the register to use, defining them and setting up register entry

...

Once this been found copy the registers name (remembering it will also work - but might be tricky). Launch again the report Technics> Reports> Export/Import format but this time in specification set the report for this register and choose the media as "File" this will save the registers information in txt file.

...

 find the matrix and delete it  in  

in places where it is in register  until it is no longer present  . 

...

• Name - Shows the name of the field;
• Type - Type of the field;
• Location - Can be set if needed Matrix or Header;
• In list - Lets to include or exclude the information from the full list regime;
• In full - Lets to include or exclude the information from the short list regime;
• Filter by - Lets filter by specific field (include=allowed, exclude=not allowed). For example to filter items with specific class.

• Index names - is something usually set by HAL programmers - needed for faster filtering

 Important to also set the Main key code in appropriate main key row for column "Index names" as in examples:

Image Added Image Added

Writing and reading the registers

...