This application is an Application Starter Kit (ASK) that is designed to get you up and running quickly with a common industry pattern, and to provide information about best practices around Watson services. The Business Intelligence application was created to highlight the combination of the [AlchemyData News][alchemydata-news], [Alchemy Language][alchemy-language], and [Tone Analyzer][tone-analyzer] services as a Business Intelligence tool. This application can serve as the basis for your own applications that follow that pattern.
Give it a try! Click the button below to fork the repository that contains the source code for this application into IBM DevOps Services, which then deploys your own copy of this application on Bluemix automatically:
IMPORTANT: This application requires an AlchemyAPI key with high transaction limits. The free AlchemyAPI key that you request has a limit of 1000 transactions per day, which is insufficient for significant use of this sample application. See step 3 of the Getting Started section for information about requesting a higher transaction limit on your sample AlchemyAPI key.
- How this app works
- Getting Started
- Running the application locally
- About the Business Intelligence pattern
- Reference information
- User interface in this sample application
- Troubleshooting
This application provides a query interface that lets users search for information about a company and how it is publicly perceived. The query interface uses the semantic information available from AlchemyAPI to limit search results to company-related information.
AlchemyData News provides extensive access to news sources, which are then analyzed by the Tone Analyzer service to show how the company or its products are perceived. In addition, the overall customer sentiment about the company is displayed, as well as sentiment information about the top 10 related concepts.
The application is written in Node.js and uses npm. Instructions for downloading and installing these are included in the following procedure.
Important: If you used the Deploy to Bluemix button to deploy an instance of this application to Bluemix automatically, you will have to delete that application and the services that it used before you can build and deploy an application manually. You can use the cf apps command to see the instances of running applications, use the cf delete application-name command to delete the application, and use the cf delete-services service--name command to delete each of applications.
The following instructions explain how to fork the project on GitHub and push that fork to Bluemix using the cf command-line interface (CLI) for Cloud Foundry. If you want to run the application locally, see the next section, Running the application locally:
-
Log into GitHub and fork the project repository. Clone your fork to a folder on your local system and change to that folder.
-
Create a Bluemix account. Sign up in Bluemix or use an existing account. Watson services in beta are free to use, as are GA services in the standard plan below a certain usage threshold.
3. Get an [Alchemy API key][get-alchemyapi-key]. The page that displays after you create a key, provides a form that enables you to request a higher transaction limit than the default for free keys, which is 1000 transactions per day.
-
If it is not already installed on your system, download and install the Cloud-foundry CLI tool.
-
If it is not already installed on your system, install Node.js. Installing Node.js will also install the
npmcommand. -
Create a file named
api_key.txtin the folder that contains your fork. Copy your Alchemy API key into this file. -
Edit the
manifest.ymlfile in the folder that contains your fork and replaceapplication-namewith a unique name for your copy of the application. The name that you specify determines the application's URL, such asapplication-name.mybluemix.net.
```yml
applications:
- services:
- tone-analyzer-service
name: application-name
path: .
memory: 1024M
disk_quota: 1024M
```
- Connect to Bluemix by running the following commands in a terminal window:
```sh
$ cf api https://api.ng.bluemix.net
$ cf login -u <your-Bluemix-ID> -p <your-Bluemix-password>
```
- Create an instance of the Tone Analyzer service in Bluemix by running the following command:
```sh
$ cf create-service tone_analyzer beta tone-analyzer-service
```
**Note:** The Tone Analyzer service is currently a beta service.
- Push the updated application live by running the following command:
```sh
$ cf push
```
Follow the steps in the previous section and ensure that you are still logged in to Bluemix.
- Install any dependencies that a local version of your application requires:
```sh
$ npm install
```
-
Create a
.env.jsfile in the root directory of the project with the following content:'use strict'; module.exports = { VCAP_SERVICES: JSON.stringify({ tone_analyzer: [{ credentials: { url: 'https://gateway.watsonplatform.net/tone-analyzer-beta/api", username: 'TONE ANALYZER USERNAME HERE', password: 'TONE ANALYZER PASSWORD HERE' } }], VCAP_APP_PORT: 3000 })};
-
Copy the
username,password, andurlcredentials from yourtone-analyzer-serviceservice in Bluemix to the previous file. To see the service credentials for your Tone Analyzer service instance, run the following command, replacing<application-name>with the name of the application that you specified in yourmanifest.ymlfile:sh $ cf env <application-name>Your output should contain a section like the following:sh System-Provided: { "VCAP_SERVICES": { "tone_analyzer": [{ "credentials": { "url": "<url>", "password": "<password>", "username": "<username>" }, "label": "tone_analyzer", "name": "tone-analyzer-service", "plan": "beta" }] } } -
Start the application by running:
```sh
$ node app.js
```
- Open http://localhost:6001 to see the running application.
PLACEHOLDER
PLACEHOLDER
PLACEHOLDER
The following links provide more information about the AlchemyData News, Alchemy Language, and Tone Analyzer services, including tutorials on using those services:
- API documentation: Get an in-depth understanding of the AlchemyAPI services
- AlchemyData News reference: API and query gallery
- API documentation: Get an in-depth understanding of the Tone Analyzer service
- API reference: SDK code examples and reference
- API explorer: Try out the REST API
The user interface that this sample application provides is intended as an example, and is not proposed as the user interface for your applications. However, if you want to use this user interface, you will want to modify the following files:
public/index.html- Defines the items that are displayed in the footer for the sample application. By default, the items in the footer are placeholders for IBM-specific values because they are used in the running instance of this sample application. For example, the Terms and Conditions do not apply to your use of the source code, to which the Apache license applies.public/artifacts/main.css- Defines the graphics that are used at various places in the sample application
When troubleshooting your Bluemix app, the most useful source of information is the execution logs. To see them, run:
$ cf logs <application-name> --recentFind more open source projects on the IBM GitHub Page
This sample code is licensed under the Apache 2.0 license. Full license text is available in LICENSE.
See CONTRIBUTING.
// [get-alchemyapi-key]: https://console.ng.bluemix.net/catalog/services/alchemyapi/ [get-alchemyapi-key]: http://www.alchemyapi.com/api/register.html [tone-analyzer]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/tone-analyzer.html [alchemydata-news]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/alchemy-data-news.html [alchemy-language]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/alchemy-language.html