Versions Compared

Key

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

Things you should know about Rest api data upload :

Noteinfo

        REST API is only available to users who:

  •  have purchased the flex.bi "Standard" or "Business" plan.
  •  have HansaWorld version STDERP_8.1-2015-06-02
  •  have Hansaworld Webshop licence enabled for setup period

Please note : 

  • Rest api connection pushes all data that is requested starting form period you want to start import from
  • Rest appi 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 choose manual File uplaod upload with Hansaworld Exports or setup HAL package for automated data export / import in your Flex.bi account.
 

Prepare your acount for Rest api connection

To be able to use REST API as a way to import your files you must first make sure you have the necessary plan parameters enabled:

...

Then you will be able to perform imports with REST API.

HansaWorld setup for Rest api 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

...

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.

...