API Keys
When deploying a SWF containing GMaps Plugin, you must authorize the domain for which the content will be hosted. By default, GMaps Plugin will function on your desktop PC so you can develop and test content locally.
Each version of GMaps Plugin has different requirements for authorization of domains:
GMaps Plugin Trial and GMaps Plugin Standard
GMaps Plugin
Bundle
GMaps Plugin Premier
Troubleshooting
GMaps Plugin Trial customers
GMaps Plugin trial users are required to use the Google Maps free API for testing / evaluation purposes only. The Google Maps free API is restricted to testing and development or for developing public available facing web sites per their terms of use. With GMaps Plugin trial installed, you need to obtain an API key to use the plugin and ensure that you can test the capabilities locally and on your server.
- Obtain the domain for which your SWF will be hosted (example: yoursite.com). If you do NOT have a domain that you will publish to and just want to test locally on your computer, enter the domain of you company (example: yoursite.com). If your site has sub-domains, port numbers, or sub folders where your SWF will reside, you should ONLY include the domain itself and EXCLUDE sub domains, ports, and folders.
Example URL: http://dev.server:8080/BOE/Infoview
What you will copy: http://server
With this URL handy you will now go to the Google site and obtain your key.
- Visit the Google Maps Free API Key website: http://code.google.com/apis/maps/signup.html
- At the bottom of the web page, you will paste your URL to obtain your Google Maps Key on the sign up page.
- Copy the resulting API key from the top of the Google page.
- Open Xcelsius and Paste the API key into your dashboard application's spreadsheet.
- Bind the API key property to your new API key
- Your map will appear on the canvas, and now you can start building your geo-dashboard analysis.
GMaps Plugin Bundle Customers
GMaps Plugin Bundle customers do NOT need to fuss with API keys because the enterprise version of Google Maps provides global control over domains. Like the free API, your organization must still authorize use of domains with Google Maps. However, instead of defining a single approved domain per dashboard, you can have one dashboard that can be published to multple domains, which is critical for seamless migration from dev to production. Though the process for obtaining the domain is the same, the authorization process is managed through Centigon Solutions support.
- Obtain the domain for which your SWF will be hosted (example: yoursite.com). If your site has sub-domains, port numbers, or sub folders where your SWF will reside, you should ONLY include the domain itself and EXCLUDE subdomains, ports, and folders.
Example URL: http://dev.server:8080/BOE/Infoview
What you will copy: http://server
With this URL handy you will now go to the Google site and obtain your key.
If you do NOT have a domain that you will publish to and just want to test locally on your computer, go to the Xcelsius behavior tab, and check "Development Mode".
- Copy the URL. You will require this URL to authorize its use within your organization.
- Visit Centigon Solutions support page
- Click on the Cases tab and create a new case
- Provide the domain(s) to Centigon Solutions support.
- The domain will be active for use within 24 hours of submission.
Existing Google Maps Premier Customers
- Obtain your Google Maps Premier ClientID and enter it into the Client ID field.
- Obtain the domain for which your SWF will be hosted (example: yoursite.com). If your site has sub-domains, port numbers, or sub folders where your SWF will reside, you should ONLY include the domain itself and EXCLUDE sub domains, ports, and folders.
Example URL: http://dev.server:8080/BOE/Infoview
What you will copy: http://server
- Send this domain to Google support for authorization.
Troubleshooting
If you see the "Initialization failed" error, this means the domain that you have authorized on the Google Maps web site, or through Centigon Solutions support is incorrect. The URL for which you access your SWF is what needs to be used. If you are still unsure if you have the correct URL, with the SWF open in your browser and the above error showing, do the following:
- Paste the following into the browser and hit enter.
- You will get a popup dialogue with a URL.
- Copy the URL. You will take the domain and NOT include the sub domain or port #. This is what you will enter into the API Key sign up page in step 2.
Example URL: http://dev.server:8080/BOE/Infoview
What you will copy: http://server
* As you can see you do NOT include any sub domains (dev) or port numbers (8080).
- For trial users, you will obtain a new API key and for GMaps Plugin Bundle users, we recommend contacting support so we can ensure you have the correct domain(s).
|
