Baidu Map Widget Installation & Extension User Guide

Transcription

1 Baidu Map Widget Installation & Extension User Guide Version 1.0b July 2015

2 Table of Contents 1. Introduction and Installation Baidu Map Extension: Configuration and Use Compatibility... 9

3 1. Introduction and Installation Extensibility is a core aspect of the architecture and design of ThingWorx. Partners, third parties, and users, as well as ThingWorx can easily add new functionality into the system in a seamless manner. Extensions can be Service (function/method) libraries, Connector Templates, Widgets, and more. This document provides installation and usage instructions for the Baidu Map Extension About the Baidu Map Extension The Baidu Map extension package implements a new Widget into the ThingWorx Mashup builder. The widget allows a Baidu-Map plugin to be embedded in a panel in the mashup, similar to the Google Maps widget. Use and implementation of the Baidu Map widget requires a Baidu Developer API Access Application key, which can be obtained through the developer.baidu.com website after providing a valid Baidu user account. This guide will walk through the process of obtaining an API key. You will need the following before beginning with the setup of this extension: Baidu Widget Extension zip file Internet access An account A cell phone number for SMS code confirmation Google Chrome (preferred) And/Or a written understanding of Chinese. Obtaining a Baidu Map Widget API Key 1. To begin, you must login to Baidu from the developer page: Note: In Chrome, right-click on any white space in the webpage and select Translate to English if English is required to navigate the site. 1

4 2. Scroll down the page until the Application Key button is visible, and click on it. 3. Select Register Now if you don t already have an account. If you do, skip ahead to Create Application Key (Step #7) 4. In the first field, enter a valid address (Note that the field will say Mobile/ ). In the second field, create a password, and in the third field, enter the security code shown in the box on the right. 5. In your account, find an from passport@baidu.com and click on the link in the message. Note that additional security verification may be required at this point. If you cannot read the symbols, a dictionary or translation utility may help. 6. When you have completed the security verification, you will be redirected to Scroll down and click the Application Key button once more. 2

5 7. On the next page, fill out the developer or company information as applicable. Note: For Phone Number, you ll need to enter your valid cell phone number. If it s not a Chinese mainland number, enter the country code first in parentheses. For the US, this will be done as follows: (1) After a mobile phone number is entered, click Send Verification Code. A timer will begin and an SMS should be sent to your provided phone number. You will be required to enter the code provided in the SMS in the Code field. Do this before the timer reaches 0, or you ll need to start over. 9. After successfully creating a developer account, navigate to and click on the Application Key button here once more. 3

6 10. Click I agree at the service agreement page to accept the terms of use. 11. Click the blue Create Application button on the next page: 12. Fill out the fields, and leave all the boxes checked to use the full suite of the Baidu Map functionality. Enter an application name (can be anything; such as ThingWorx-CompanyName ), and enter an IP whitelist if desired. If you do not wish to whitelist any IP addresses, enter /0 in this field, and click Submit. 13. At this point, a key should have been created for you. Take note of the Access Application (AK) Key created here. 4

7 2. Baidu Map Extension: Configuration and Use Configure the Baidu Extension 1. Open the Baidu Widget Extension zip file, and inside it, find the metadata.xml file. 2. Open the metadata.xml file for editing (use Notepad or a similar text editor). 3. Within the xml file, find the following line: <FileResource type="js" url=" D" description="" isdevelopment="false" isruntime="true" /> 4. In the xml file, replace the KEYREQUIRED text with the exact AK key noted earlier from the Baidu Developer page. Replace the text in the xml file so that there are no extra spaces or other erroneous characters. 5. Save and close the metadata.xml file back into the archive (zip file), and close the zip file. 6. Proceed with importing the extension in ThingWorx. Import the Configured Extension 1. From a web browser, launch ThingWorx composer on your desired server. 2. Login to ThingWorx as an administrator. 5

8 3. Go to Import/Export and select Import from the menu at the top right. 4. Click Choose File, and select the Baidu Widget extension zip file. 5. Click Import. Note: If the import is not successful, double-check that the metadata.xml file is still within the zip file at the root directory. If you still experience problems, contact your ThingWorx system administrator for help. 6. Click Yes to refresh composer after the import is successful. 7. To use the Widget, open up a new Mashup in Composer, and click OK on the pop-up window. 6

9 8. From here, locate the new Baidu Map widget, and you should be able to drag and drop the map widget onto the mashup in any open Panel. 9. The Widget may be configured by using the Properties window at the bottom-left of the screen while a Baidu Map widget is selected. 7

10 Properties Once the Baidu Map Widget is created, its properties may be configured and customized using the properties window in the Mashup builder. The Baidu Map extension may be bound to data for showing current location, similar in operation to the Google Maps Widget Extension. 8

11 3. Compatibility The current version of the Baidu Map Extension has been tested for compatibility with the following ThingWorx platforms and Java JRE versions: ThingWorx Platform Version Java JRE Version ThingWorx Java version 8, update 45 9