| Info |
|---|
The pace report service is required to run performance reports via the ReST API adhocReport endpoint; clients within EagleAccess should instead use the eql ReST endpoint, which does not utilize the pace-reportservice. |
Invoking the OLAP REST API describes how to invoke Eagle Data warehouse’s MC2 REST API Pace Report service. Topics CoveredHere you will learn details 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
From any Eagle window, click the Eagle Navigator button.
Enter Message Center Console and you
...
see below window. Type
...
eagle_default_deploy_
...
demand in the Stream name box. Once you choose the stream name,
...
click Search
...
.
...
The Stream Name
...
displays on the window, right-click on the stream and
...
click Run Now with Overrides
...
.
Choose the values as shown in the window below
...
to install the MC2
...
components and then click Ok.
The All Services value in the Component name will install all the services of MC2 components.
...
Now that the installation of MC2 components have kicked
...
off ensure the status of the installation by clicking the
...
EJM Tasks
...
button on the toolbar.
...
Choose the date and time on the left pane when the installation kicked
...
off and click and then click Search.
You can see the progress
...
as MC2 completes individual components
...
.
PACE-Report service
7. The pace-report service is not included in the deployment of ‘All Services’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 previously 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 click Eagle Navigator button.
13. Enter System Management Center in the Start Search text box and click the System Management Center link. Or, click All Programs and select System Management Center.
14. Launch System Management Center. Sort the list of services by Type.
...
15. To open a Web Server for customization, right -click on it and choose Show Details. You need to change the configuration of all web servers on the region. 
...
16. Now open the Configuration tab and find ini in the list of config files.
...
...
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.
The link to Swagger definitions for all supported REST resources may be retrieved using the link:
REST API will use the authentication provided by Eagle. Swagger UI is available at:
https://host/mc2/swagger-ui.html
20. Output File Location: OLAP REST API uses the Default Custom archive rule to generate report output files of all supported formats. Default's ROOT_DIR needs to be an NFS (Network File Share) mount in such a way that the report results saved in the folder are accessible across hosts.
