Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Things you should know about REST API data upload :

Info

REST API  requires :

  •  HansaWorld version STDERP_8.1-2015-06-02 or later
  •  HansaWorld Webshop licence enabled for setup period

Please note : 

  • Currently Hansaworld Rest API connection pushes all data that is requested starting form period you want to start import from
  • Rest API currently can be as only data import option - it can not be mixed with Source files data upload. If rest appi connection suits only some of your imports (too much data in selected period, for example), you should  setup HAL package for automated File export / import in your Flex.bi account or choose manual File upload with HansaWorld Exports.

...

  1. You need to know the web port of your HansaWorld server (which is not the same as you normal port used for HansaWorld client). Normally it should be specified in Technics>>Program Mode.

    Note

    As web port can be overridden by server startup scripts, firewall or other configurations we recommend to contact your HansaWorld partner and/or hosting partner to find out the actual port number used

     

  2. You need to know the URL or IP address of your HansaWorld server that can be used for web requests from the Internet.
  3. Add new row in Webshop>>Settings>>Allow functions on web>>WebDataAPI (you can restrict the usage of this by specifying allowed ip addresses)
     
  4. Test in your browser or other software designed for REST API request testing that this functionality is working with URL
    http://ip:port/WebDataAPI.hal?register=BaseCurBlock

As a result you should get a short JSON formatted result with your base currencies from first company which means connection is working and flex.bi will care of the rest

Warning

We suggest that you discuss security measures with your HansaWorld or hosting partner to ensure that data access is secured only for flex.bi

Setting up Rest api connection in Flex.bi

To do an import click on the "Add new source application" button in your Source Data -> Source Applications tab. Select "HANSAWORLD" as your source application.

Note

REST API currently only supports the full import of registers (or from the specified import date, specific user defined intervals are available currently).

If you choose to use REST API as the main method of importing data into flex.bi you will not be able to use any other file import methods from HansaWorld

...


Press the button create.

A page similar to this should appear

...

In the source data URL enter the URL to your HansaWorld server. The URL should look similar to this: http://sample.url.com:1234/WebDataAPI.hal

The URL consists of the following elements

...

Once you are done with selecting everything you wish to import press the "Import" button and the import will begin. Importing with REST API does not upload any source files into the "Source files" section of flex.bi.