Versions Compared

Key

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

Invoking the OLAP REST API describes how to invoke Eagle Data warehouse’s MC2 REST API Pace Report service.

Topics CoveredHere you will learn about the following:

  • Interacting with the Interface
  • Configuring the RESTful web service environment
    • MC2 Components
    • Pace-report service
    • REST Endpoint Configurations

Interacting with the Interface

The API Communicates with the Eagle data warehouse MC2 Server to perform submit operations.

To program an interface using this API, you must have basic understanding of at least one programming language that supports RESTful web service, such as the Java programming or Python or Microsoft .Net framework service.

Configuring the RESTful Web Service Environment

Before you can invoke the API as RESTful web service, you must configure your environment for MC2, Pace-report service and REST Endpoints.

To configure your web service environment:

MC2 Components

  1. From any Eagle window, click the Eagle Navigator button.
    Image Added
  2. Enter Message Center Console and you will see below window. Type 'eagle_default_deploy_demand’ in the Stream name box.   Once you choose the stream name, hit 'click Search' button. Image Removed
    Image Added
  3. As you see Stream Name appears on the window, right click on the stream and click ' click  Run Now with Overrides'Image RemovedYou need to choose the .
  4. Choose the values as shown in the window below window to install the MC2 components first and click 'Ok' button. 'components and then click Ok. The All Services ' value in the Component name will install all the services of MC2 components.                                                                                                                                                                                     
  5. Now the installation of MC2 components have kicked off and you need to ensure the status of installation by clicking the ' EJM Tasks ' button on the toolbar.                                                       Image Removed
    Image Added                                                  
  6. Choose the date and time on the left pane when the installation kicked and hit 'Search' button. off and click and Search.
    You can see the progress of the individual components of MC2 is completed.                           Image Removed

...

  1. MC2 have been  completed.                           

PACE-Report service

7. The pace-report service is not included in the deployment of ‘All All Services’. The pace report service is required to run performance reports via the REST API. ‘Pace-reportservice' needs to be installed separately. Repeat step #3 and continue with step #8.

8. You need to choose Chose the values as shown in the below window to install 'the window below to install Pace-reportservice ' and click 'Ok' button. Installations kicked off and you need to ensure the status by clicking  ' . The Installation will begin To ensure the status click EJM Tasks

9. Both MC2 and Pace-reportservice would have been installed on the server and you need to configure the web service Endpoints now.

Enable RESTful Web service Endpoint

10. In order to access the Extract Service through a Web Service endpoint, the thin Eagle IIS server configuration has to be changed.

11. Change the EagleSTAR/tpe/cfg/starsecuity.ini on all THIN servers. Add the following lines to the REDIRECTURL_2SITES section:

[REDIRECTURL_2SITES]

/EagleMLWebService30=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26ExecuteEagleMLRequest

/EagleMLWebService30/=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26ExecuteEagleMLRequest

/EagleMLWebService30?wsdl=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26wsdl20

12. The same configuration can be done from 'System Management Center'. From any Eagle window, click the Eagle Navigator button.

...

17. In the right part of the window, you can now set the parameters in the [REDIRECTURL_2SITES] section. The following parameters should be added to enable the EagleMLWebService30 Web Services/SOAP Endpoint and supported REST endpoints:

[REDIRECTURL_2SITES]

/EagleMLWebService30=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26ExecuteEagleMLRequest

/EagleMLWebService30/=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26ExecuteEagleMLRequest

/EagleMLWebService30?wsdl=/ext/starsecurity.dll?statelessrouter&format=soap&cmd=4600%26200%26wsdl20

18. Save your changes with the button in the top pane.

19. Return to the Details tab and Restart Web Server to apply the changes.20. Do not forget to apply this configuration to all web servers in the region.

Note


The link to Swagger definitions for all supported REST resources may be retrieved using the link:

...