Configuration

Copyright © TIBCO Software Inc. All Rights Reserved

Configuration

After you install TIBCO API Exchange, complete the following tasks to configure the various components required to view the API Analytics dashboard.

Task A Configuring TIBCO Spotfire Server

1.

Install and configure TIBCO Spotfire Server. Refer to TIBCO® API Exchange Gateway User’s Guide for instructions to configure the TIBCO Spotfire Server and Client.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 component, ensure that the TIBCO Spotfire Web Player instance and the Joomla server are hosted on machines whose fully qualified name share a common suffix that includes the domain name. For example: joomla.a.b.c.group-g.companyname.com and spotfirewp.x.group-g.companyname.com

2.

Enable Impersonation using the TIBCO Spotfire Configuration Tool.

3.

Create a user asgwebplayer and add the user to the Impersonator group. This user will be used in Task B to authenticate TIBCO Spotfire Web Player.

4.

Ensure that the Central Logger data is available at the following locations:

−

For MySQL: Database named asgstat.

−

For SQLServer: Database named asgstat

−

For Oracle: Schema named asguser

5.

Copy the content of the installed folder that matches your database type into <TIBCO_SPOTFIRE_SERVER_HOME>\tomcat\application-data\library:

−

templates/spotfire/mysql

−

templates/spotfire/oracle

−

templates/spotfire/sqlserver

6.

Using the TIBCO Spotfire Client > Tools > Library Administration menu follow these steps:

a.

Import ASG_CL.part0.zip to the root of the library.

b.

Choose the option to replace the existing item.

If you choose to keep the existing permissions, you might see warning messages about missing users. You can ignore these warnings.

Do NOT move or rename the imported resource ASG_CL.

7.

Using the TIBCO Spotfire Client > Tools > Information Designer > Elements menu, right-click on the resource /ASG_CL, choose Edit, and update the data source with your actual connection parameters. Provide valid credentials for authentication.

Do NOT move or rename the imported resource ASG_CL.

8.

Using the TIBCO Spotfire Client > Tools > Library Administration menu, import ASG.part0.zip to the root of the library.

9.

Open the resource /ASG/Host using File > Open from > Library….

10.

If the information link is not resolved, use the Browse option to locate that information link under /ASG/links/unfiltered.

11.

Click File > Save as > Library Item… to save the changes.

12.

Open the resource /ASG/Partner using File > Open from > Library…. I

13.

If any information link is not resolved, use the Browse option to locate the information link under /ASG/links/filtered.

14.

Click File > Save as > Library Item… to save the changes

15.

Ensure that the Impersonator group has read access to the /ASG directory and the files under it.

16.

If needed, you can now move or rename the /ASG directory and the /ASG_CL resource. If you move or rename the /ASG directory (for example, to /new_directory), update the property asg.portal.spotfire.library.path.prefix in asg-portal.properties to /new_directory. This lets the portal gateway know the path of the directory that contains the Host and Partner resources.

Do not rename the resources Host and Partner in the TIBCO Spotfire Library. If needed, you can move these resources to a common directory. Ensure that both the resources are available in a common directory. By default, these resources are available in the /ASG directory.

Task B Installing and Configuring TIBCO Spotfire Web Player

1.

Install TIBCO Spotfire Web Player to enable Web Player connection to the TIBCO Spotfire Server configured in Task A, Configuring TIBCO Spotfire Server.

During Web Player installation, do the following:

a.

When prompted to enter the Virtual directory to create in IIS:

Spotfire Web Player URL pattern: http[s]://<servername>/APIXAnalytics/

b.

Make sure that you specify the virtual directory as shown in the example above, as APIXAnalytics.

The name you type here will be part of the Spotfire Web Player URL.

For additional information, see the TIBCO Spotfire® Web Player 6.0 Installation and Configuration document—”Installer Options” in the Section 1.6 “Pre-Installation Checklist,” and Section 3.2, “Run the Installer.”

2.

Configure authentication as follows:

a.

Specify authentication either as Anonymous or as Basic Authentication. If you are using Basic Authentication, update the section on authentication and authorization in <TIBCO_SpotfireWebPlayer_root>/web.config as indicated in the following code sample.



























<authentication mode="None"></authentication>

<authorization>





<allow users="*" />

</authorization>

b.

Enable Impersonation in the Web Player. Specify the credentials for the user asgwebplayer created in Task A, Configuring TIBCO Spotfire Server for the impersonation.





<setting name="ImpersonationUsername" serializeAs="String">

<value>asgwebplayer</value>

</setting>

<setting name="ImpersonationPassword" serializeAs="String">

<value>asgwebplayer</value>

</setting>

c.

Enable Basic Authentication on the IIS server.

Refer to TIBCO Spotfire Web Player Installation > 3.3.1 Username and Password and TIBCO Spotfire Web Player Installation > 3.3.2 Anonymous (Pre-configured) Access for details.

3.

Configure the JavaScript API.

a.

Enable the JavaScript API.

b.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, set the domain name to the common part of the fully qualified name of the Joomla server and the TIBCO Spotfire server. For example, if you are using joomla.a.b.c.group-g.companyname.com and spotfirewp.x.group-g.companyname.com, set the domain name to either companyname.com or group-g.companyname.com.

Refer to section 6.2, “Advanced Web.Config Settings,” in TIBCO Spotfire Web Player Installation for details.

Task C Configuring TIBCO® API Exchange Gateway

1.

Configure the TIBCO Spotfire Domain to the same values as in Task B Step 3 b.

If you have installed Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, you can configure the TIBCO Spotfire Domain with the same value as specified in Task B Step 3 b. above from the Joomla! Administrator > System > Control Panel > Global Configuration > API Manager Configuration and Email Templates.

2.

Update the file asg-portal.properties located at <ASG_CONFIG_HOME> and edit the following properties:

−

Update asg.portal.spotfire.url.prefix to specify the hostname and port number of the TIBCO Spotfire Web Player. For example: http://hostname:port

−

If you selected Basic Authentication for TIBCO Spotfire Web Player, update the properties asg.portal.spotfire.username and asg.portal.spotfire.password to specify the username and password.

−

If you moved or renamed the /ASG directory in Task A step 16, update the property asg.portal.spotfire.library.path.prefix with the new location.

3.

Update the configuration file TargetOperation.cfg located at <ASG_CONFIG_HOME>\PortalProject\ and edit the host name and port number for the service request to provide the TIBCO Spotfire Web Player URL. If you use Basic Authentication, enter the username and password.

If you have installed Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, you can access the configuration for the Portal Project from the Developer Portal. Navigate and update the following URIs:

•

Portal Project > Routing > Facade Operations > Request > Operation URI to point to the TIBCO Spotfire Web Player.

•

Portal Project > Routing > Facade Operations > RequestGet > Operation URI to point to the TIBCO Spotfire Web Player.

•

Portal Project > Routing > Target Operations > Request and Portal Project > Routing > Target Operations > Request to point to the TIBCO Spotfire Web Player.

•

Portal Project > Routing > Target Operations > Request and Portal Project > Routing > Target Operations > RequestGet to point to the TIBCO Spotfire Web Player.

4.

Configure the proxies for the server that proxies requests between the browser and the portal gateway. Edit the file <apache_home>\conf\httpd.conf to update the following:

ProxyPass /Analytics http://developer.company.com :9122/SpotfireWeb

ProxyPassReverse /Analytics http://developer.company.com :9122/SpotfireWeb

ProxyPass /SpotfireWeb http://developer.company.com :9122/SpotfireWeb

ProxyPassReverse /

SpotfireWeb http://developer.company.com :9122/SpotfireWeb

where developer.company.com represents the URL used by your company.

Task D (Optional) Set Up One-Way SSL from the Spotfire Server to the Developer Portal

If you will use SSL for communication between the Spotfire server and the Developer Portal, specify SSL configuration settings in the following configuration files:

•

The asg_portal.properties file

•

The TargetOperation.cfg file of the Portal project.

Follow these steps to set up one-way SSL for the Spotfire server:

1.

Edit the asg_portal.properties file:

a.

Make sure the following URL is an HTTPS URL as in the following example:

asg.portal.spotfire.url.prefix=https://<spotfire_hostname>:<spotfire_https_port>

2.

Set the asg.portal.spotfire.ssl.property.file.path value to specify the absolute path to the SSL properties used for the Spotfire server, as follows:

asg.portal.spotfire.ssl.property.file.path=<absolute-path-to-ssl.properties>

For example:

asg.portal.spotfire.ssl.property.file.path=/opt/tibcoasgconfig/tibco/cfgmgmt/asg/PortalProject/wss/ssl.properties

3.

Add an ssl.properties file to the directory as stated above.

Example 1 shows a sample ssl.properties file.

Example 1 Sample ssl.properties File for Spotfire

com.tibco.trinity.runtime.core.provider.identity.trust.enableTrustStoreAccess=true

com.tibco.trinity.runtime.core.provider.identity.trust.trustStoreServiceProvider=class:com.tibco.trinity.runtime.core.provider.credential.keystore

com.tibco.trinity.runtime.core.provider.credential.keystore.keyStoreLocation=/root/Desktop/AllCerts/SpotfireServerCert.pfx

com.tibco.trinity.runtime.core.provider.credential.keystore.keyStorePassword=password

com.tibco.trinity.runtime.core.provider.credential.keystore.keyStoreProvider=

com.tibco.trinity.runtime.core.provider.credential.keystore.keyStoreRefreshInterval=60000

com.tibco.trinity.runtime.core.provider.credential.keystore.keyStoreType=PKCS12

4.

Edit the PortalProject configuration found under the TIBCO_CONFIG_HOME directory, and make sure the TargetOperation.cfg file contains a line configuring the HTTPS service for Spotfire, as in the following example:

service_Request|HTTPS|||20000,0,0,0|||||||||||/APIXAnalytics|gov-was.na.tibco.com|443|Administrator|!t1seasy|*,{uri_suffix},{query_string}|POST|ssl.properties|true

service_RequestGet|HTTPS|||20000,0,0,0|||||||||||/APIXAnalytics|gov-was.na.tibco.com|443|Administrator|!t1seasy|*,{uri_suffix},{query_string}|GET|ssl.properties|true

5.

Import the Spotfire certificate into the cacerts keystore found at: <TIBCO_HOME>/tibcojre64/1.7.0/lib/security cacerts.

To import the certificate, use the keytool command is as shown below:

keytool -import -keystore %jre_home%\lib\security\cacerts -alias <alias_name> -file <your_cert_file>

where alias_name is the name of the SSL alias and your_cert_file is the filename of your certificate file.