Getting Started

Topic in this chapter:

• Login to OIP.
• Logout from OIP.

Login to OIP

1. Using the Google Chrome Version 71 and above above browser, enter the web address for OIP web portal and the main page will be displayed.

2. The Uniform Resource Locator (URL) for OIP web portal is https://datahub.oip.tmrnd.com.my

3. Click Signup Now button to create an account.

4. The main page of the system will be displayed if the sign in is successful.

5. The main page of the system will be displayed if the sign in is successful.

6. The menus are displayed at the left side of the main page.

7. Place the mouse pointer at the menu and its page will be displayed.

Logout from OIP

1. Click the user name at the menu at the upper right side of the screen.

2. A menu will be displayed.

3. Click Logout.

Datahub Functionalities

Add New Project

• Add-SCP-as-datasource
• Add-MYSQL-as-datasource

1. On the main menu, click at My Projects menu.

2. Click New Project button at the upper right side of the screen to add new project.

   

3. A click at New Project button would display Add Data Wizard window.

   

4. Select either excel sheet (.xls, .xlsx), CSV file (.csv), MYSQL and Service Creation Platform (SCP) as the datasource. For excel datasource, ensure that you are following the criterias that has been mentioned above the datasource dropdown.

   

5. Suppose data chosen is in CSV format. Click NEXT to proceed.

   

6. Choose file to upload. Once a file is selected, click SUBMIT button to proceed.

   

7. A window is displayed which contains data source recently inserted. Click NEXT button to proceed.

   

8. Give a name to the project and save it by a click to CREATE PROJECT button.

   

9. Tag a location to your project by typing the name of location itself or by dragging the map maker. Click SUBMIT button to proceed or click SKIP button to ignore it.

   

10. The new project created would have status Added.

    

11. Below MENU header, click at Action button.

    

12. Click at VIEW DETAIL. You could able to view detail of data in the project.

    

13. Mouse over to the red button if you want to remove the respective column.

    

14. Once remove column is selected, confirm the delete action by a click at DELETE button.

    

Add SCP as datasource

1. The steps taken are same as above Add New Project until step (4). Select datasource -Service Creation Platform (SCP)

   

2. Click NEXT button to proceed.

3. Enter information as required in Add Data Wizard form and click SUBMIT button.

   

4. Click SUBMIT button.

5. A Data Preview window would appear. Scroll and choose a list of data at top right corner of the screen. The triple dots at the row end means more data for preview. Click NEXT button to proceed with the rest of the data.

   

6. Click NEXT button to create data as a project. Key-in project name and click CREATE PROJECT button to proceed.

   

7. A Location Tagging window would appear. Tag your project by location by dragging the icon or by key-in the name of location. Click SUBMIT button to proceed or click SKIP to ignore it.

   

8. Once submitted, a project is created with status API Created and source from Service Creation Platform.

   

Add MYSQL as datasource

1. The steps taken are same as above Add New Project except step (4), Select datasource - MYSQL

   

2. Click NEXT button to proceed.

3. Enter information as required in Add Data Wizard form and click SUBMIT button. Information required are Database Host, Database Port, Username, Password, Database Name and Database Query.

   

4. A Data Preview window would appear. Click NEXT button to proceed.

   

5. Click NEXT button to create data as a project. Key-in project name and click CREATE PROJECT button to proceed.

   

Delete a Project

1. In My Projects, at header MENU, click Action of a project followed by View Detail. A new window name after the project name selected is displayed. Click a drop-down Action button at right-end of the screen. Choose Delete API.

   

2. Once Delete API is clicked, a confirmation pop-up window is displayed. Click DELETE button to proceed or CANCEL button to ignore.

   

Create API from a Project

In order to publish this data as an API in the Service Exchange Platform (SEP), you need to create the API first. This step converts your file into JSON format so that it can be used as the returned result of the API.

1. In My Projects, at header MENU, click Action of a project followed by View Detail. A new window name after the project name selected is displayed. Click a drop-down Action button at right-end of the screen. Choose CREATE API.

   

2. An API Creation Wizard would display. Click SUBMIT button if you agreed with property name as listed or else type a new name to the property.

   

3. Click SAMPLE API RESULT in case you would like to see how the API result looks like.

   

4. A message on API status would pop-up once SUBMIT button is displayed. Click OK button to proceed.

   

5. Project status is changed to API Created.

   

Add Group View

In order to use group view, the project must be in API Created status.
In other words, you must Create API out of the project created.

1. Click button GROUP VIEW button at top right-side menu.

   

2. If you have no group, create a new group by a click at NEW GROUP button at the top right menu.

   

3. An Add Group Wizard window would appear. Give a name to the group and click NEXT to proceed.

   

4. Select at least a project to the group recently created. Click SUBMIT to proceed.

   

5. A group is created with number of project listed at PROJECTS status. At ACTION status, you have some choices which include Delete Group,API Sandbox or Publish API.

   

6. A click at PROJECT VIEW at top-right side menu would list out the project which included in the group created.

   

API Sandbox

Before publishing the API, Datahub provides an API sandbox for you test the API. In this way, you are able to check how the returned data looks like.

1. In My Projects, at header MENU, click Action of a project followed by View Detail. A new window name after the project name selected is displayed. Click a drop-down Action button at right-end of the screen. Choose API Sandbox.

   

2. Information on Access Token and API ID is displayed. Click at Authorize button to proceed.

   

3. Copy the Access Token information and paste it at Value box at Availabe authorization window. Click Authorize button to proceed.

   

4. Click Close button to proceed or Logout button to cancel..

   

5. Expand the API Endpoint that you wish to try and click Try it out button. The API would require apiID as one of the parameter. Insert the provided API ID.

   

6. Click Execute to proceed. The result will appear under the Responses section.

   

Publishing an API

Once you are satisfied with your created API, you can publish it into Service Exchange Platform so that other OIP users may subscribe and use your API.

1. In My Projects, at header MENU, click Action of a project followed by View Detail. A new window name after the project name selected is displayed. Click a drop-down Action button at right-end of the screen. Choose Publish API.

   

2. A Publish API Wizard window is displayed.

   

3. All information as listed are required to be filled in. Otherwise submission is not allowed.

4. Key-in API Name to be published in Service Exchange Platform.

5. Provide brief description of the API.

6. Give version of the API. For first time submission, default version is 1.0.0

7. Select tag at API Tag and API Subtag pull down menu to make your API searchable in SEP.

8. Attach thumbnail or logo which represents you API.

9. Write publisher name and e-mail address.

10. To allow API created visible to OIP users under TM or TM Subsidiaries domain, tick the Private API box.

11. Click SUBMIT button.

12. Project status is changed to Publishing. The API is successfully published once the status changed to Published (You can click REFRESH LIST to retrieve latest update).

    

Viewing API in Service Exchange Platform

1. Go to Published API section.

   

2. Click View in SEP under desired API.

   

3. The SEP page will be opened in a new browser tab.

   

Updating Data

There is always a situation where your data need to be updated. Datahub provides two ways to update your data. Note that update functionality only available to project with status API Created or Published.

Method 1 : Replacing Existing Data with a New Data.

This method is recommended if your existing data in the project is already obsolete and you would want to replace the entire data with a new one.

1. Go to My Projects and click Action to View Detail of a project that you wish to update.

2. A new window name after the project name selected would be displayed. Click a drop-down Action button at right-end of the screen. Choose Update Data.

   

3. Click Update Data. Update data wizard will pop up. Select the first option and click Next.

   

4. Add Data Wizard window will pop up. Follow the instruction as stated in this tutorial titled Add New Project to complete the process.

Method 2 : Concatenate Existing Data with a New Data.

This method is recommended if you would like to provide more data into the project.

1. Go to My Projects and view detail of a project that you wish to update.

2. Click Action of a project followed by View Detail. A new window name after the project name selected is displayed. Click a drop-down Action button at right-end of the screen. Choose Update Data.

   

3. Click Update Data. Update data wizard will pop up. Select the second option and click Next.

   

4. Complete the required checklist in order to prevent data inconsistency of your API.

   

5. Add New Data wizard will pop up. Follow the instruction as stated in this tutorial titled Add New Project to complete the process.

Visualization

In order to use visualization feature, the project must be in API Created status.
In other words, you must Create API out of the project created.
Note: In current version of Datahub, visualization is not supported for Service Creation Platform (SCP) data source.

The Use Case

1. We will walk through the tutorial by using Issue Tracking as an example of our use case provided we have an excel sheet as below:

   

2. Based on above figure, it consists of equipment tracking issues at different customer sites. This example assumes that the project has been created in datahub with API already created and has named as Visualization Tutorial.

Bar Chart

1. To generate a bar chart, go to Visualization tab and select Visualization Tutorial project.

   

2. Add widget button will appear at the bottom right of the page. Hover on the button and select Bar Chart.

   

3. A widget will appear. Click on Menu button and select Configure.

   

4. Now based on the use case, we want to create a bar chart that shows the counting of each faulty equipment. Hence, we will be using Single Field variable as we want to do counting in Faulty field only. In the Configuration dialog, set the configuration as below and click Save.

   

5. As a result, a Bar Chart will get populated as below:

   

6. Next, we would like to create another Bar Chart to populate Estimated Days Required for each Report. Based on the data source, this involves two fields, Report No and Estimated Days Required. Create another Bar Chart widget and configure it as below:

   

7. Based on configuration above, we set the Variables option as Two Fields and set the respective X-Axis Parameter and Y-Axis Parameter. Direct X vs Y operations means we are taking the value in each row as it is. Click Save and the Bar Chart should look like this:

   

8. The bar colour used to represent the faulty equipment is similar to bar colour used in previous faulty equipment bar chart.
   Bar Chart also offers grouping feature. We can make use of grouping feature for this data by grouping each equipment issue by month and get total estimated days for that month. Create another Bar Chart widget and configure it as below:

   

9. The Bar Chart would look like this.

   

Pie Chart

1. Generating a Pie Chart is simpler than the Bar Chart because most of the time, it is meant to display count.
   To generate the Pie Chart, hover on Add Widget button and select Pie Chart.
   In this example use case, the Faulty Equipment Count Bar Chart can also be displayed in the form of Pie Chart. Visually, it gives a different view depending on user preference. Configure the Pie Chart as below:

   

2. As expectedly, the Pie Chart would look like this:

   

3. Depending on preference, user might want to view it as a Pie Grid. Simply set the Pie Grid option to Yes in the configuration and the Pie Grid will look like this:

   

Line Chart

1. Line chart is used to display time-based data. Thus, in this example use case, we would like to plot a Line Chart that counts total faulty equipment cases given the report date. Add a Line Chart widget and configure it as below:

   

2. Click Save and the line chart will look as like this:

   

3. The widget will create separate lines for each equipment and return the count on each date.