adapter code for tibco® api exchange and joomla! installation

52
Adapter Code for TIBCO® API Exchange and Joomla! Installation Version 2.3.4 November 2021 Copyright © 2016-2021. TIBCO Software Inc. All Rights Reserved.

Upload: others

Post on 05-Apr-2022

4 views

Category:

Documents


0 download

TRANSCRIPT

Adapter Code for TIBCO® APIExchange and Joomla!InstallationVersion 2.3.4November 2021

Copyright © 2016-2021. TIBCO Software Inc. All Rights Reserved.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

2 | Contents

Contents

Contents 2

Overview 4What is an API Key? 4

Creating an Application to use API 4

Prerequisites for Installation 6

Linux Installation 7Overview of Installing Linux 7

Preparing the Machine 8

Installing and Setting Up Apache HTTP Server 9Extracting the File Contents 9

Installing Apache Portable Runtime (APR) 10

Installing Apache Portable Runtime Utility Library 10

Downloading and Install PCRE 10

Installing Apache HTTPD 11

Installing and Configuring MySQL 12Installing MySQL on Linux 12

Starting MySQL 13

Installing and Setting Up PHP 16Installing PHP 16

Configuring Apache to use PHP 18

Starting Apache 19

Installing PHPMyAdmin (Optional) 20

Installing the Adapter 21Editing the httpd.conf File 21

Configuring Portal Engine in High Availability (HA) Mode 22

Downloading the Distribution Files 23

Adapter Code for TIBCO® API Exchange and Joomla! Installation

3 | Contents

Restarting Apache 24

Creating a Database for Portal Data 24

Windows Installation 25Windows Installation Overview 25

Installing Required Software Using WAMP 26Downloading the Required Software 26

Installing and Configuring MySQL 33Starting MySQL 33

Installing and Setting Up PHP 34Installing PHP 35

Configuring Apache to use PHP 36

Starting Apache 36

Installing the Adapter 37Downloading the Distribution Files 37

Performing Tasks to Ensure the Portal Is Accessible 38

Restarting Apache 38

Creating a Database for Portal Data 38

Setting Up Joomla 40Configuring Joomla 40

Installing Cobalt Packages from the Adapter Code for TIBCO API Exchange andJoomla! Distribution 42

Setting up the Joomla! Mail Server 44

Post-Installation Tasks 45

TIBCO Documentation and Support Services 49

Legal and Third-Party Notices 51

Adapter Code for TIBCO® API Exchange and Joomla! Installation

4 | Overview

OverviewYou can create an application using the Developer Portal that the Adapter Code for TIBCOAPI Exchange and Joomla! enables. TIBCO® API Exchange Manager allows service providersto package and offer services or APIs to developers inside or outside their company. A self-service portal enables developers to search and browse available APIs and documentation,request access, register applications, generate developer keys, and test API functionality.

If you have installed the Adapter Code for TIBCO® API Exchange and Joomla! component ofTIBCO® API Exchange, you can use the Developer Portal that is provided with thecomponent.

Role of Application Developers

As an application developer, you can perform the following activities:

• Browse through a product catalog, such as packages of APIs.

• Register for an account.

• Create applications and generate API keys.

• Request access to offered or custom product plans, such as subscriptions.

What is an API Key?An API key is used to identify who is calling an API for authorization and tracing purposes.It is typically passed in through an HTTP header, a URI parameter, or through an OAuthgrant flow.

To generate a key, a developer registers an application through the portal. The applicationtypically represents a specific client that is calling or consuming the API. A client could be aTIBCO BusinessWorks™ process, a Java-based web application running in a web server, aJavaScript client running in a browser, or a native mobile application running on a tablet.

Creating an Application to use APIProcedure

Adapter Code for TIBCO® API Exchange and Joomla! Installation

5 | Overview

1. Create an application through the portal and requests an API key.

2. Request access to one or more products and plans.

3. Test the API and API key through the API Explorer.

4. Use the API key in calls to the API from their programming language of choice.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

6 | Prerequisites for Installation

Prerequisites for InstallationBefore installation of TIBCO API Exchange Joomla 2.3.4 ensure that your system is runningon the versions of software listed below:

Software Version

Joomla 3.9.24

PHP 7.4.16

My SQL 5.5.x

PHPMyAdmin 5.1.0

Adapter Code for TIBCO® API Exchange and Joomla! Installation

7 | Linux Installation

Linux InstallationYou can install the Adapter Code for TIBCO API Exchange and Joomla!. Some prerequistitesoftware is required if you are using a Linux system.

Note

The procedures described in this section are for a new installation of TIBCO APIExchange and Joomla!. If you are upgrading to release 2.1.1 from release 2.0.0, seethe “Migration and Compatibility” section in TIBCO API Exchange and Joomla! ReleaseNotes for upgrade instructions.

Overview of Installing LinuxProcedure

1. Installing prerequisite software (Apache, MySQL, PHP).

See the following sections:

— For instructions on installing Apache, see the Installing and Setting Up ApacheHTTP server section.

— For instructions on installing MySQL, see the Installing and Configuring MySQLsection.

— For instructions on installing PHP, see the Installing and Setting Up PHP section.

2. Installing and configuring the Joomla! package.

See the Installing the Adapter section.

3. Configuring Joomla!

See Setting Up Joomla for information on installing and configuring Joomla!

4. Installing Cobalt packages (included).

See Installing Cobalt Packages for information on installing the required Cobaltpackages.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

8 | Linux Installation

Preparing the MachineTo prepare the machine for installing Adapter Code for TIBCO API Exchange and Joomla!on Red Hat-based Linux systems, follow these instructions. You can adapt the instructionsfor other platforms as well.

Procedure

1. As root, update the machine:

yum update

2. Enter the following commands to install the required dependencies:

yum install gcc libxml2-devel gcc-c++libicu-devel libxslt-develbzip2 bzip2-devel libjpeg-devellibpng libpng-devel freetypefreetype-devel curl curl-develt1lib-devel unixODBC-devel

3. Update machine limits.

Here are some recommendations for /etc/security/limits.conf:

* soft nofile 8192* hard nofile 65536* soft memlock unlimited* hard memlock unlimited* soft as unlimited* hard as unlimited* hard nproc    32768* soft nproc 32768Here are some recommendations for /etc/security/limits.d/90-nproc.conf:* soft nproc 32768root soft nproc unlimited

4. If selinux is enabled, execute the following commands:

setsebool -P httpd_can_sendmail=1setsebool -P httpd_can_network_connect=1

5. Reboot the machine.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

9 | Linux Installation

Installing and Setting Up Apache HTTP ServerDownload Apache HTTP server 2.4.x and required dependencies from the followinglocation:

http://httpd.apache.org/dist/httpd

Download the files to the $APACHE_HOME directory.

Click the following files:

httpd-2.4.x.tar.gz

httpd-2.4.x-deps.tar.gz

Extracting the File ContentsAll instructions in this section are performed as a non-root user unless specified.

Procedure

1. Enter the following commands:

gunzip httpd*.gzmkdir depsmv httpd*deps*.tar depsmkdir apachemv httpd*.tar apachecd apache

2. Enter the following command:

tar xvf httpd-2.4.x.tar

(where x represents the Apache 2.4 version)

3. Enter:

cd depstar xvf httpd*deps*.tarcd httpd-2.4.x

(where x represents the Apache 2.4 version)

Adapter Code for TIBCO® API Exchange and Joomla! Installation

10 | Linux Installation

Installing Apache Portable Runtime (APR)Procedure

1. Enter the following commands:

cd deps/httpd*/srclib

2. Copy the apr and apr-util directories to the /srclib directory:

cp apr -R /home/httpd/apache/httpd-2.4.x/srclib/(where x represents the Apache 2.4 version)cp apr-util/ -R /home/httpd/apache/httpd-2.4.x/srclib/(where x represents the Apache 2.4 version)cd /home/httpd/apache/ls

3. Enter the following commands to install Apache runtime:

./configure --prefix=/opt/products/apache2makemake install

Installing Apache Portable Runtime Utility LibraryEnter the following commands:

cd deps/httpd*/srclib/apr-util./configure --prefix=/opt/products/apache2--with-apr=/opt/products/apache2makemake install

Downloading and Install PCREYou can download and install Perl Compatible Regular Expressions (PCRE).

Downloading PCRE

Download PCRE from the following location:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

11 | Linux Installation

http://sourceforge.net/projects/pcre/files/pcre/8.33/pcre-8.33.tar.gz

Extracting the PCRE Contents

Enter the following commands:

gunzip pcre*.gzmkdir pcremv pcre*.tar pcrecd pcretar xvf pcre*.tar

Installing PCRE

Enter the following commands:

cd pcre*./configure --prefix=/opt/products/apache2makemake install

Installing Apache HTTPDEnter the following commands:

cd $APACHE_HOME/httpd*./configure --prefix=/opt/products/apache2

--with-apr=/opt/products/apache2--with-apr-util=/opt/products/apache2--with-pcre=/opt/products/apache2--with-ldap --enable-so --enable-auth-digest--enable-authz_owner --enable-log_config--enable-logio --enable-ext_filter--enable-mime_magic --enable-expires--enable-deflate --enable-headers--enable-usertrack --enable-dav--enable-info --enable-vhost_alias--enable-speling --enable-substitute--enable-rewrite --enable-proxy--enable-proxy_balancer --enable-proxy_ftp--enable-proxy_http --enable-proxy_ajp--enable-proxy_connect --enable-cache--enable-version

Adapter Code for TIBCO® API Exchange and Joomla! Installation

12 | Linux Installation

makemake install

Installing and Configuring MySQLYou can install and configure MySQL. Supported databases listed in the readme can beused as an alternative.

Installing MySQL on LinuxProcedure

1. Download MySQL from http://dev.mysql.com/downloads/.

NoteThe rpm-bundle.tar version installs both the MySQL server and the MYSQL client.

2. To install MySQL 7.3.6, enter the following commands:

tar xvf MySQL-Cluster-gpl-7.3.6-2.rhel5.i386.rpm-bundle.tarrpm -ivh *.rpm

NoteIf there is not enough memory to install all of the RPM packages contained in theinstallation bundle, you can install the server and client packages separately.

During SQL installation, you can see a message indicating that a random password hasbeen set:

A RANDOM PASSWORD HAS BEEN SET FOR THE MySQL root USER !You will find that password in '/root/.mysql_secret'.My password: <password>

3. Make a note of this password. You must enter this password the first time that youconnect to MySQL.

4. To verify that MySQL installed correctly:

Enter the following command:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

13 | Linux Installation

mysql --version

If MySQL installed correctly, a message similar to the following appears:

mysql Ver 14.14 Distrib 5.6.19-ndb-7.3.6, for Linux (i686) usingEditLine wrapper

Go to the /usr/bin directory and verify that SQL files are installed.

Starting MySQLBefore starting MySQL, make a note of the random password generated during installation.The only command allowed the first time you connect to a just installed MySQL database is‘SET PASSWORD’.

To retrieve the password:

To retrieve the password (on Linux), enter the following command:

cat /root/.mysql_secret

The cat command returns the password, for example:

# The random password set for the root user at Thu Sep 26 15:44:18 2013(local time): IfXu2QTP

To run the start command:

Enter the following command:

service mysql start

The following message appears:

Starting MySQL..

Connecting to MySQL

Procedure

1. Enter the following command:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

14 | Linux Installation

mysql –uroot -pWhen prompted for password enter the password retrieved from/root/.mysql_secret.

Setting a New MySQL Password

Enter the following commands:

SET PASSWORD FOR 'root'@'localhost' = PASSWORD('tibco@123');exit

Setting MySQL to Autostart on Reboot

Enter the following commands:

chkconfig mysql --level 2345 on

Securing the MySQL Instance

Enter the following command:

mysql_secure_installation

There is no need to set a new password for root unless you want to.

Running mysql_secure_installation brings up an interactive configuration. The followingexample shows the output from the command.

Example Output for the mysql_secure_installation Script

In order to log into MySQL to secure it, we'll need the current

NoteRunning all parts of this recommended for all MySQL servers in production use.Please read each step carefully.

password for the root user. If you've just installed MySQL, andyou haven't set the root password yet, the password will be blank,so you should just press enter here.Enter current password for root (enter for none): (Press Enter)OK, successfully used password, moving on...Setting the root password ensures that nobody can log into the MySQL

Adapter Code for TIBCO® API Exchange and Joomla! Installation

15 | Linux Installation

root user without the proper authorisation.You already have a root password set, so you can safely answer 'n'.Change the root password? [Y/n] (Enter n)... skipping.

By default, a MySQL installation has an anonymous user, allowing anyoneto log into MySQL without having to have a user account created forthem. This is intended only for testing, and to make the installationgo a bit smoother. You should remove them before moving into aproduction environment.Remove anonymous users? [Y/n] (Enter y)... Success!

Normally, root should only be allowed to connect from 'localhost'. Thisensures that someone cannot guess at the root password from the network.Disallow root login remotely? [Y/n] (Press Enter)... Success!

By default, MySQL comes with a database named 'test' that anyone canaccess. This is also intended only for testing, and should be removedbefore moving into a production environment.Remove test database and access to it? [Y/n] (Press Enter) - Droppingtest database...- Removing privileges on test database...... Success!

Reloading the privilege tables will ensure that all changes made sofarwill take effect immediately.Reload privilege tables now? [Y/n] (Press Enter)... Success!

All done! If you've completed all of the above steps, your MySQLinstallation should now be secure.Thanks for using MySQL!

Allowing Access to the MySQL Instance from Outside

Create a superadmin user who can access the MySQL instance from outside. Access as‘root’ is allowed only from ‘localhost.’

To allow outside access to the MySQL instance, run the following command and enter apassword when prompted:

mysql -u root -p<enter password>CREATE USER 'superadmin'@'%' IDENTIFIED BY 'asg$uper@dmin';GRANT ALL ON *.* TO 'superadmin'@'%' WITH GRANT OPTION;

Enabling Access to MySQL Through a Firewall

If a firewall is enabled, allow access to MySQL instance by opening the port, as shown inthe following command example:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

16 | Linux Installation

iptables -I INPUT -m state --state NEW -m tcp -p tcp --dport 3306 -jACCEPTservice iptables saveservice iptables restart

To Restart MySQL

Enter the following command:

service mysql restart

Use any SQL client to validate that the superadmin user can connect to the remote MySQLinstance.

Installing and Setting Up PHPYou can install and configure for PHP.

Downloading PHP

Download PHP from the following location:

https://www.php.net/releases/

The PHP version is 7.4.16.

Extracting the PHP Distribution Contents

Enter the following commands:

gunzip php*.gzmkdir phpmv php*.tar phpcd phptar xvf php-7.4.16cd php-7.4.16

Installing PHPEnter the following commands:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

17 | Linux Installation

cd php*./configure --prefix /opt/products/php7

--with-config-file-path=/opt/products/apache2/conf--with-apxs2=/opt/products/apache2/bin/apxs--with-kerberos --with-unixODBC=/usr--with-gd --with-jpeg-dir --with-png-dir--with-freetype-dir --with-t1lib--enable-gd-native-ttf --with-bz2--enable-calendar --with-mysql --enable-intl--enable-mbstring --with-mysqli --enable-soap--enable-zip --with-xsl --with-zlib --with-xmlrpc--with-curl --enable-ftp --enable-sysvsem--enable-sysvshm --enable-shmop --enable-xslt--enable-mailparse --with-libdir=lib64

            --enable-xlstmakemake install

Copying and Editing Configuration Files

Procedure

1. Enter the following commands to copy the configuration files:

cp php.ini-production /opt/products/php7cd $PHP_HOMEcp php.ini-production php.ini

2. Edit the php.ini file and add the following line:

magic_quotes_gpc=Off

3. Locate the line that reads upload_max_filesize = xx.

4. Change the default value from 2M to 32M (32 MB). The line should read:

upload_max_filesize = 32MIncrease max_input_users from 1000 to 5000. The line should read:max_input_vars=5000

5. Save the php.ini file.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

18 | Linux Installation

Configuring Apache to use PHPProcedure

1. Go to the /opt/products/apache2/conf/ directory.

2. Edit the httpd.conf file. For example:

vi /opt/products/apache2/conf/httpd.conf

3. Make sure that there is a LoadModule statement to load the php5 module (the PHPinstallation should insert a LoadModule statement for this):

LoadModule php7_module modules/libphp7.so

4. Go to the end of the file and add the following PHP configuration information:

# PHP related configuration - Begin<FilesMatch \.php$>

SetHandler application/x-httpd-php</FilesMatch><FilesMatch "\.php$>

SetHandler application/x-httpd-php-source</FilesMatch>RewriteEngine OnRewriteRule (.*\php)s$ $1 [H=application/x-httpd-php-source]# PHP related configuration - End

5. Make sure that the following lines are uncommented to ensure the followingmodules are loaded (the PHP installation will have already enabled the ph5_moduleto be loaded).

LoadModule slotmem_shm_module modules/mod_slotmem_shm.soLoadModule rewrite_module modules/mod_rewrite.soLoadModule proxy_module modules/mod_proxy.soLoadModule proxy_connect_module modules/mod_proxy_connect.soLoadModule proxy_http_module modules/mod_proxy_http.so

6. Add the following lines:

# Add API Exchange related proxy info - BeginProxyPass /apiKey http://ec2-instance-public-dns:9122/apiKeyProxyPassReverse /apiKey http://$host:9122/apiKeyProxyPass /portalEvent http://$host:9122/portalEvent

Adapter Code for TIBCO® API Exchange and Joomla! Installation

19 | Linux Installation

ProxyPassReverse /portalEvent http://$host:9122/portalEventProxyPass /asg/ http://$host:9122/asg/ProxyPassReverse /asg/ http://$host:9122/asg/ProxyPass /ConfigUI http://$host:9200/ConfigUIProxyPassReverse /ConfigUI http://$host:9200/ConfigUI# Add API Exchange related proxy info - End

7. Save the httpd.conf file.

Validating PHP

Procedure

1. Go to the /opt/products/apache2/htdocs directory.

2. Enter the following commands to edit the phpinfo.php file:

mkdir infocd infovi phpinfo.php

3. Add the following lines:

<?phpphpinfo();?>

4. Save the phpinfo.php file and exit the editor.

5. Restart the Apache server.

Configuring Firewall Rules for Apache

Enter the following commands:

iptables -I INPUT -m state --state NEW -m tcp -p tcp --dport 80 -jACCEPTservice iptables saveservice iptables restart

Starting ApacheEnter the following commands:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

20 | Linux Installation

cd /opt/products/apache2/binsudo ./apachectl start

Note“sudo” is required only if Apache is running on port 80.

Validating the Apache HTTP and PHP Installation

Procedure

1. Access http://host/ to obtain a valid response from Apache.

2. Access http://<host>/info/phpinfo.php to view information about PHP, Apache,and MySQL.

NoteAfter you have validated Apache and PHP, you might want to move the phpinfo.phpfile from the /htdocs directory.

Installing PHPMyAdmin (Optional)You can install PHPMyAdmin to manage the MySQL database.

Downloading PHPMyAdmin

Download from the following location:

https://files.phpmyadmin.net/phpMyAdmin/5.1.0/phpMyAdmin-5.1.0-all-languages.zip

Setting Up PHPMyAdmin

Procedure

1. Extract the downloaded files to the following directory:/opt/products/apache2/htdocs/phpMyAdmin

2. Create a file called “config.inc.php” from “config.sample.inc.php.”

Restarting Apache

Enter the following commands:

cd /opt/products/apache2/bin

Adapter Code for TIBCO® API Exchange and Joomla! Installation

21 | Linux Installation

sudo ./apachectl start

Note“sudo” is required only if Apache is running on port 80.

Accessing PHPMyAdmin

Procedure

1. Go to the following URL:

http://<host>/phpMyAdmin

2. Enter MySQL credentials to get access.

Installing the AdapterInstallation of Joomla! and the Adapter Code for TIBCO API Exchange and Joomla! aresupported for the Linux platform.

Reviewing the README.txt File

Carefully review the information in the README.txt file for the Adapter Code for APIExchange and Joomla!. It contains important information regarding the softwaredistribution and trademark information that you need to be aware of.

Editing the httpd.conf FileProcedure

1. Locate the user and group.

2. Change the values of User and Group to the owner of the /htdocs directory.

For example:

# User/Group: The name (or #number) of the user/group to run httpd as.

# It is usually good practice to create a dedicated user and group for #running httpd, as with most system services.

#

User <owner of htdocs directory>

Group <group of htdocs directory>

Adapter Code for TIBCO® API Exchange and Joomla! Installation

22 | Linux Installation

3. Locate the DirectoryIndex entry and add index.php.

For example:

#

# DirectoryIndex: sets the file that Apache will serve if a directory # isrequested.

#

<IfModule dir_module>

DirectoryIndex index.html index.php

</IfModule>

4. Save the httpd.conf file.

Configuring Portal Engine in High Availability (HA) ModeTo run the two portal engines in active and active mode by configuring the load balance inApache server, complete the following procedure.

Procedure

Procedure

1. Make the following changes in the httpd.conf file:LoadModule lbmethod_byrequests_module modules/mod_lbmethod_byrequests.so

LoadModule proxy_balancer_module modules/mod_proxy_balancer.so

LoadModule slotmem_shm_module modules/mod_slotmem_shm.so

2. Add the following lines of code in the file:<Proxy balancer://portalEngineCluster>

BalancerMember http://localhost:9122

BalancerMember http://localhost:9123

</Proxy>

ProxyPass /joomla/apiKey balancer://portalEngineCluster/apiKey

ProxyPassReverse /joomla/apiKey balancer://portalEngineCluster/apiKey

ProxyPass /joomla/portalEvent balancer://portalEngineCluster/portalEvent

ProxyPassReverse /joomla/portalEventbalancer://portalEngineCluster/portalEvent

Adapter Code for TIBCO® API Exchange and Joomla! Installation

23 | Linux Installation

ProxyPass /joomla/asg/internal/productbalancer://portalEngineCluster/asg/internal/product

ProxyPassReverse /joomla/asg/internal/productbalancer://portalEngineCluster/asg/internal/product

3. Restart the Apache server.

4. Start the two portal engine instances in two of the different ports. For example: port9122 and port 9123.

5. To verify the request is routing to both the server in a round robin fashion enablethe apache debug log (httpd.conf file). You can see it in the following log file:balancer://portalEnginecluster: worker (http://localhost:9123) rewrittento http://localhost:9123/asg/internal/product/231

Downloading the Distribution FilesProcedure

1. Stop Apache if it is running.

2. Go to the following URL:

https://github.com/API-Exchange/JoomlaAdapter/wiki

3. Select the latest version.

4. Click TIB_api-exchange-joomla-adapter_version.zip.

5. The distribution zip file is downloaded and opens.

6. From the distribution file, extract the contents of the .zip file (or .tar file) and copythe /joomla directory to the $APACHE_HOME/htdocs directory.

For example:cp -r ./TIB_api-exchange-joomla-adapter_2.3.4/joomla/* $APACHE_HOME/htdocs/

7. Start Portal and upload cobalt packages.

8. Copy the contents of the /adapter/joomla directory in the distribution file, to the$APACHE_HOME/htdocs directory after cobalt packages are installed. For example:cp -r ./TIB_api-exchange-joomla-adapter_2.3.4/joomla/* $APACHE_HOME/htdocs/

9. Upload the com_baseline.zip and com_seeddata.zip from the JoomlaAdapter-ver\adapter\sql-scripts\baseline&seed_data directory.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

24 | Linux Installation

Restarting ApacheAfter copying the Joomla files, enter the following commands to restart Apache:

cd /opt/products/apache2/bin

sudo ./apachectl start

Note“sudo” is required on Linux only if Apache is running on port 80.

Creating a Database for Portal DataProcedure

1. Log in to MySQL:

mysql –u root –p

NoteLogin as “root” is only allowed from localhost.

Securing MySQL has ensured that root cannot access the database remotely—only“superadmin” can access the database remotely.

You are prompted for the MySQL password.

2. Enter the MySQL password.

3. Enter the following command:

CREATE DATABASE asg_openapi DEFAULT CHARACTER SET utf8 COLLATEutf8_general_ci;

Adapter Code for TIBCO® API Exchange and Joomla! Installation

25 | Windows Installation

Windows InstallationYou can install the Adapter Code for TIBCO API Exchange and Joomla!. Some prerequisitesoftware is required if you are using a Windows system.

Windows Installation OverviewInstalling the Adapter Code for TIBCO® API Exchange and Joomla! involves the followingmain steps:

Procedure

1. Installing prerequisite software (MySQL, Apache, PHP).

You can install all of the required prerequisite software packages using WAMP(Windows, Apache, MySQL, PHP) or individually.

See the Installing Required Software Using WAMP section for instructions oninstalling the prerequisite software using WAMP.

See the following sections for information on installing the individual prerequisitesoftware packages.

— For instructions on installing Apache, see the Installing and Setting Up ApacheHTTP Server section.

— For instructions on installing MySQL, see the Installing and Configuring MySQLsection.

— For instructions on installing PHP, see the Installing and Setting Up PHP section.

2. Installing and configuring the Joomla! package.

See the Installing the Adapter section for information on installing and configuringJoomla!.

3. Installing Cobalt packages (included).

See the Installing Cobalt Packages section for information on installing Cobalt.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

26 | Windows Installation

Installing Required Software Using WAMPTo simplify installation on Windows, you can use WAMP. WAMP stands for Windows ApacheMySQL PHP, which are required prerequisites for the Developer Portal installation. WAMPprovides an easy to use interface for managing all three components.

In addition, Joomla is required. You can obtain Joomla from the Adapter Code for TIBCOAPI Exchange and Joomla! download site on GitHub:

https://github.com/API-Exchange/JoomlaAdapter/releases/tag/version

The following sections describe the steps for downloading WAMP and Joomla.

Downloading the Required SoftwareComplete these tasks to download WAMP and the Joomla Adapter code.

Install the WAMP Server

Procedure

1. Go to the following URL:

http://www.wampserver.com/en/

2. Download WAMP 2.5 or later.

3. Right-click Wampserver.exe and click Run as administrator.

4. Install the Wampserver in a location of your choice (for example, c:\PortalServer).

You are prompted to associate a browser with WAMPserver.

5. Browse for the browser executable that you will use and then click Open.

For example, to use Mozilla Firefox, browse to C:/Program Files (X86)/Mozilla Firefox,and select firefox.exe.

The installer extracts and requires the WAMPserver files.

You are prompted for PHP mail parameters.

6. Enter the SMTP server name (for example, mail.tibco.com) and your email address,as shown in the following figure.

Alternatively, you can leave the default values and choose Next.

Specifying PHP Mail Parameters

Adapter Code for TIBCO® API Exchange and Joomla! Installation

27 | Windows Installation

7. Complete the following steps to update the server name from localhost to yourhostname for future access:

Browse to the C:\wamp\bin\apache\apache2.x.x\conf folder and open thehttpd.conf file.

Locate the line that reads ServerName localhost:80.

If you want to change your server name from localhost, change the server name.

Navigate to C:\Windows\System32\drivers\etc.

Edit the hosts file and change the entries to point to the hostname for the local host.

Each entry consists of two items:

- The IP address of a host

- The hostname associated with the IP address

Change the entries to point to the hostname for your local host. For examples

— 127.0.0.1 Change from “localhost” to the name of your local host

— 127.0.0.1 Change from “localhost” to the fully-qualified-hostname for the localhost.

Save the hosts file.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

28 | Windows Installation

8. Start the WAMP Server and validate that connecting to http://< hostname > lists thePHP index page with all the modules loaded.

The WAMP Server icon appears on our task bar. When the server is online, the icon isgreen.

9. Click the icon to bring up the WAMP server menu, shown in the following figure.

WAMPserver Menu

Configure MySQL for WAMP

Procedure

1. Click the WAMP Server icon on the task bar, on the WAMPServer menu, selectMySQL, and click MySQL console.

2. When prompted for a password press Enter.

The password is empty. The mysql prompt appears.

3. Enter the following command to set the password for root:

SET PASSWORD FOR 'root'@'localhost' = PASSWORD('tibco@123');

4. Enter the following command to create a database for portal data:

CREATE DATABASE asg_openapi DEFAULT CHARACTER SET utf8 COLLATEutf8_general_ci;

5. Enter exit to exit the MySQL console.

6. Browse to the C:\wamp\bin\php\php7.x.x folder and open the php.ini file.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

29 | Windows Installation

7. Locate the line that reads upload_max_filesize and check if the value is theminimum value (8M).

8. Click the WAMP server icon on the task bar and choose Restart All Services.

Download and Install the Joomla Adapter Code

The Adapter Code for TIBCO API Exchange and Joomla package is used to install the TIBCOAPI Exchange Developer Portal.

Procedure

1. Download TIB_api-exchange-joomla-adapter_version.zip from the GitHubrepository at the following location:

https://github.com/API-Exchange/JoomlaAdapter/releases

2. Extract the contents of the zip file to a temporary folder.

3. Copy the contents of both folders:

• Copy the contents of /joomla to C:\WAMP\www.

• Copy the contents of /joomla/adapter to C:\WAMP\www.

NoteDo not copy the entire folder. Copy the contents of the folders and overwrite fileswhen prompted.

4. To connect to MySQL, start the MySQL console, and then enter the following:

use asg_openapi

5. To run the asg-openapi.sql script, enter

source <tmp_directory>/adapter/sqlscripts/asg_openapi.sql

where tmp_directory is the path to the temp directory to which you unzipped theAdapter Code for TIBCO API Exchange and Joomla distribution.

MySQL updates the PHP tables with customizations for the API Exchange Adaptercode.

Configure Apache

Procedure

1. Edit the C:\wamp\bin\apache\apache<Version>\conf\httpd.conf file and add thefollowing lines at the end of the file:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

30 | Windows Installation

# Add API Exchange related proxy info - BeginProxyPass /apiKey http://ec2-instance-public-dns:9122/apiKeyProxyPassReverse /apiKey http://$host:9122/apiKeyProxyPass /portalEvent http://$host:9122/portalEventProxyPassReverse /portalEvent http://$host:9122/portalEventProxyPass /asg/ http://$host:9122/asg/ProxyPassReverse /asg/ http://$host:9122/asg/ProxyPass /ConfigUI http://$host:9200/ConfigUIProxyPassReverse /ConfigUI http://$host:9200/ConfigUI# Add API Exchange related proxy info - End#Oauth related proxyProxyPass /oauthClient/http://<apixgatewayhostname>:9122/oauthClient/ProxyPassReverse /oauthClient/http://<apixgatewayhostname>:9122/oauthClient/ProxyPass /asg/oauth2/http://<apixgatewayhostname>:9322/asg/oauth2/ProxyPassReverse /asg/oauth2/http://<apixgatewayhostname>:9322/asg/oauth2/#Analytics related proxyProxyPass /Analyticshttp://<apixgatewayhostname>:9122/APIXAnalyticsProxyPassReverse /Analyticshttp://<apixgatewayhostname>:9122/APIXAnalyticsProxyPass /APIXAnalyticshttp://<apixgatewayhostname>:9122/APIXAnalyticsProxyPassReverse /APIXAnalyticshttp://<apixgatewayhostname>:9122/APIXAnalytics# TIBCO API Exchange Proxy Settings - End

2. Uncomment the following LoadModule entries.

LoadModule proxy_module modules/mod_proxy.soLoadModule proxy_http_module modules/mod_proxy_http.so

3. Set display of PHP errors to off as indicated in the following figure.

Setting PHP Display Errors to Off

Adapter Code for TIBCO® API Exchange and Joomla! Installation

31 | Windows Installation

4. Click the WAMPserver icon on the task bar and choose Restart All Services.

5. Access http://localhost to access the portal.

6. Access http://hostname/adminstrator to access the portal administrator.

Edit the asg-portal.properties File

Before starting the portal engine, complete these steps:

Procedure

1. Edit the asg-portal.properties, file.

2. Search for joomla and remove it from the URL.

3. Check the asg_portal.properties file and verify the value of the Swagger URL.

Configure Joomla

For information on configuring Joomla, see Setting Up Joomla.

Installing and Setting Up Apache HTTP Server

Obtain the 64-bit Apache HTTP Server for Windows.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

32 | Windows Installation

For information on obtaining Apache for Windows, see the following URL:

http://httpd.apache.org/docs/2.4/platform/windows.html

Procedure

1. Go to the following URL:

http://httpd.apache.org/docs/2.4/platform/windows.html

2. Download the zip file containing the binary version of HTTP server and requireddependencies from one of the sites listed on the Apache website.

3. Unzip the zip file to C:\.

This creates a folder named Apache24 and extracts all the folders in the zip file to thatfolder.

4. Go to the $APACHE_HOME/bin folder (normally Apache24/bin).

5. Enter the following command to start Apache:

httpd.exe -k start

Note

If you see the following message:

The program can’t start because MSVCR110.dll is missing from yourcomputer. Try reinstalling the program to fix this problem

Then complete these steps:

• Download Visual C++ from http://www.microsoft.com/en-us/download/details.aspx?id=30679

• Enter the following command to restart Apache:

httpd.exe -k restart

6. Go to the following URL to verify that Apache started: http://localhost.

7. Enter the following command to stop Apache:

httpd.exe -k stop

Adapter Code for TIBCO® API Exchange and Joomla! Installation

33 | Windows Installation

Installing and Configuring MySQLYou can install and configure MySQL.

Procedure

1. Download MySQL from the following URL:http://dev.mysql.com/downloads/windows/installer/

Download the Windows (x86, 32-bit) MSI installer. This installs both 32- and 64-bitbinaries.

2. Run the installation executable.

3. If you see the following error:

This application requires.NET Framework 4.0. Please install the .NETFramework then run the installer again. For more information,please see http://go.microsoft.com/fwlink/?LinkId=181012

Then complete these steps:

Go to the link indicated in the error message.

You are redirected to another URL.

Follow the instructions on the web page that appears to download the .NETexecutable.

4. Re-run the MySQL executable.

Install MySQL into the c:/mysql directory.

When prompted for a user ID and password, provide root for the user ID and providethe root password.

Specify the service name for MySQL.

The default name is MySQL56.

Choose the “Start the MySQL Server at System Startup” option.

Starting MySQLDuring installation, we chose to start the MySQL service at system startup.

If you need to restart MySQL, go to the services dialog and right-click MySQL56-restart.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

34 | Windows Installation

Connecting to MySQL

On Windows, you connect to MySQL using MySQL workbench. The default user ID is rootand the default password is no password.

Setting a New Password

Procedure

1. Navigate to mysql/bin.

2. Enter the following command:mysql.exe -u root -p

3. When prompted for a password, press <Enter>.

4. In the MySQL command line, enter:mysql >CREATE USER 'superadmin'@'%' IDENTIFIED BY 'asg$uper@dmin';

mysql >GRANT ALL ON *.* TO 'superadmin'@'%' WITH GRANT OPTION;

Setting MySQL to Autostart on Reboot

Go to the MySQL service in services.msc and select auto for the MySQL service.

Allowing Access to the MySQL Instance from Outside

Create a superadmin who can access the MySQL instance from outside. Access as ‘root’ isallowed only from ‘localhost.’

To allow outside access to the MySQL instance, run the following command and enter apassword when prompted:

mysql -u root -p<enter password>CREATE USER 'superadmin'@'%' IDENTIFIED BY 'asg$uper@dmin';GRANT ALL ON *.* TO 'superadmin'@'%' WITH GRANT OPTION;

To Restart MySQL

If you need to restart MySQL, go to the services dialog and right-click MySQL56-restart.

Installing and Setting Up PHPYou can install and configure for PHP.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

35 | Windows Installation

Downloading PHP

Download PHP from the following location:

https://www.php.net/releases/

Install the Windows binaries.

Extracting the Contents

Extract the archive files for PHP and place them in the $PHP_HOME directory (for example,C:\php-7.0.0).

Installing PHP

Copy Configuration Files

Complete these steps to copy the required configuration files:

Procedure

1. Change directory to the $PHP_HOME directory.cd $PHP_HOME

2. Copy the php.ini-production file to php.ini.

3. Increase max_input_vars from 1000 to 5000. The line should read: max_input_vars=5000

Verify That the php_gd2.dll Extension Is Enabled and There is Sufficient UploadMemory

To ensure that GD images are displayed correctly in the Management Portal, open thephp.ini file and make sure that the php_gd2.dll extension is enabled:

Procedure

1. Go the directory where the php.ini file is located.

If you installed PHP in the C:/PHP folder, it is located there. It might also be locatedin the C:\Program Files (x86)\PHP\ folder.

2. Open the file in a text editor and locate the line that reads extension=php_gd2.dll.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

36 | Windows Installation

3. Make sure that this line is not commented out (if there is a semicolon (;) at thebeginning of the line, delete the semicolon).

4. Locate the line that reads upload_max_filesize = xx.

5. Change the default value from 2M to 32M (32 MB). The line should read:upload_max_filesize = 32M

6. Save the php.ini file.

Configuring Apache to use PHPProcedure

1. Go to the $APACHE_HOME/conf/ directory.

2. Edit the httpd.conf file.

3. Insert the following lines to ensure the PHP module for Apache 2.x is loaded:LoadModule php5_module "C:/php-7.0.0/php7apache2_4.dll"

AddHandler application x-httpd-php .php

4. Insert the following lines into the file:# configure the path to php.ini

PHPIniDir "C:/php-7.0.0"

5. Save the httpd.conf file.

6. In the C:\Apache24\htdocs\ directory, create a file named info.php that containsthe following line:<?phpinfo()?>

7. Restart Apache—Stop and start Apache from Windows.

Procedure

Procedure

Starting ApacheEnter the following commands:

cd $APACHE_HOME/bin

httpd.exe

Adapter Code for TIBCO® API Exchange and Joomla! Installation

37 | Windows Installation

To restart Apache, enter:

httpd.exe -k restart

Validating the Apache HTTP /PHP installation

Procedure

1. Access http://host/ to obtain a valid response from Apache.

2. Access http://<host>/info/phpinfo.php to view information about PHP, Apache,and MySQL.

NoteAfter you have validated Apache and PHP, you might want to move the phpinfo.phpfile from the /htdocs directory.

Restarting Apache

Enter the following commands:

cd $APACHE_HOME/binhttpd.exe -k restart

Installing the AdapterComplete the tasks described in this section to install the adapter on Windows.

Reviewing the README.txt File

Carefully review the information in the README.txt file for the Adapter Code for APIExchange and Joomla!. It contains important information regarding the softwaredistribution and trademark information that you need to be aware of.

Downloading the Distribution FilesProcedure

1. Stop Apache if it is running.

2. Go to the following URL:

https://github.com/API-Exchange/JoomlaAdapter/releases

Adapter Code for TIBCO® API Exchange and Joomla! Installation

38 | Windows Installation

3. Click TIB_api-exchange-joomla-adapter_version.zip.

4. The distribution zip file is downloaded and opens.

5. From the distribution file, extract the contents of the /joomla directory to the$APACHE_HOME/htdocs directory.

6. Start Portal and upload cobalt packages.

7. From the distribution file, merge the contents of the /adapter/joomla directory ontop of the $APACHE_HOME/htdocs directory after uploading cobalt packages.

8. Upload the baseline.sql and seed data to the TIB_api-exchange-joomla-adapter_version\adapter\sql-scripts directory.

Performing Tasks to Ensure the Portal Is AccessibleProcedure

1. Make sure that you have all permissions on the /htdocs folder.

2. Go to the $APACHE_HOME\htdocs\libraries\joomla\filter directory.

3. In the input.php file, change “mei” to “mi.”

4. In the php.ini file, locate the line that reads ;extension=php_mysql.dll anduncomment it (remove the semicolon - ;).

Restarting ApacheEnter the following commands:

cd $APACHE_HOME/binhttpd.exe -k restart

Creating a Database for Portal DataProcedure

1. Log in to MySQL:

mysql –u root –p

Adapter Code for TIBCO® API Exchange and Joomla! Installation

39 | Windows Installation

NoteLogin as “root” is only allowed from localhost.

Securing MySQL has ensured that root cannot access the database remotely—only“superadmin” can access the database remotely.

You are prompted for the MySQL password.

2. Press <Enter> (initially the password is blank).

3. Enter the following command to change the password:

SET PASSWORD FOR 'root'@'localhost'=PASSWORD('tibco@123');

Adapter Code for TIBCO® API Exchange and Joomla! Installation

40 | Setting Up Joomla

Setting Up JoomlaThis section mainly describes how to set up Joomla.

Configuring Joomla

Procedure

1. To access Joomla, go to the following URL:

http://<hostname>.<domain.name>

The main Joomla screen appears:

2. Enter the following information:

— Site Name  Enter the site name for the portal.

— Admin email  Enter the email for the site administrator.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

41 | Setting Up Joomla

— Admin Password  Enter the admin password, and then confirm it in the ConfirmAdmin Password field.

3. Scroll down to the Database configuration area.

4. In the Database Type field, from the pull-down list, choose MySql.

5. In the Host Name field, enter localhost.

6. Enter a username and password for the database user.

7. In the Database Name field, enter asg_openapi.

8. Make sure that the value in the Table Prefix field is openapi_ .

9. Click Next.

10.Review the information on the Finalisation window.

11.Click the Remove installation folder button.

The installation is now complete.

Note

You might run into some troubleshooting for step 1 listed in the Configuring Joomlatask. In order to overcome the blocker and continue with proper installation,complete the following steps:

1. Go to libraries\joomla\filter\input.php.

2. Search for:

$source = preg_replace('/&#(\d+);/me', "utf8_encode(chr(1))", $source); // decimal notation$source = preg_replace('/&#x([a-f0-9]+);/mei', "utf8_encode(chr(0x1))", $source); // hex notation

3. Replace the lines you found with the following text:

$source = preg_replace_callback('/&#x(\d+);/mi', function($m){return utf8_encode(chr('0x'.$m[1]));}, $source); // decimalnotation$source = preg_replace_callback('/&#x([a-f0-9]+);/mi', function($m){return utf8_encode(chr('0x'.$m[1]));}, $source); // hex notation.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

42 | Setting Up Joomla

Validating the Installation

Procedure

1. Access the API management portal landing page athttp://<hostaname>.<domain.name>.

2. Access the Joomla! Administrator user interface athttp://hostname>.<domain.name>/administrator and validate that Joomla canwrite to all directories.

Installing Cobalt Packages from the Adapter Code forTIBCO API Exchange and Joomla! DistributionProcedure

1. Log into the Joomla Administrator utility as administrator.

2. From the submenu at the left of the start window, choose Install Extensions.

The Upload Package window appears.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

43 | Setting Up Joomla

3. Click Choose File.

4. Browse to the directory where you unzipped the TIB_api-exchange-joomla-adapter_version.zip file and select the Cobalt packages.

5. Choose the pkg_cobalt.j3.everything.v.8.773.zip file and then click Upload &Install.

The package installs and a message appears indicating that the installation wassuccessful.

6. Choose the pkg_cobalt.j3.ip2country.v.8.0.zip file and then click Upload &Install.

The package installs and a message appears indicating that the installation wassuccessful.

7. From the Upload Package window, repeat steps 3-4, choose the pkg_cobalt.j3.media.v.8.9.7.zip file, and click Upload & Install.

The package installs and a message appears indicating that the installation wassuccessful.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

44 | Setting Up Joomla

Setting up the Joomla! Mail ServerProcedure

1. Log into the Joomla! Administrator user interface.

2. Click the Global Configuration tab.

3. Click the Server tab.

4. Locate the Mail Settings configuration area and set the mail settings as shown in thefollowing figure.

Joomla! Administrator Mail Settings Interface

Adapter Code for TIBCO® API Exchange and Joomla! Installation

45 | Setting Up Joomla

Post-Installation TasksAfter you have installed Joomla! and Cobalt, there are some tasks to peform on the hostthat is running Joomla!.

This section assumes that you have installed the TIBCO API Exchange Manager and TIBCOAPI Exchange Gateway components of TIBCO API Exchange on the target host.

For information on installing TIBCO API Exchange Gateway, see the TIBCO® API ExchangeGateway Installation guide.

For information on installing TIBCO API Exchange Manager, see the TIBCO® API ExchangeManager Installation guide.

Stopping Apache

Enter the following commands:

Linux

Adapter Code for TIBCO® API Exchange and Joomla! Installation

46 | Setting Up Joomla

cd /opt/products/apache2/binsudo ./apachectl stop

Note“sudo” is required only if Apache is running on port 80.

Windows

cd $APACHE_HOME/binhttpd.exe -k stop

Importing the MySQL Scripts

The Adapter Code for TIBCO API Exchange and Joomla! distribution contains an SQLinstallation utility that allows you to update the database contents.

Procedure

1. Import the scripts from the directory where you unzipped the TIB_api-exchange-joomla-adapter_version.zip file (the TIB_api-exchange-joomla-adapter_version/adapter/sql-scripts/asg_openapi.sql directory) into the asg_openapidatabase.

2. Connect to MySQL.

3. At the MySQL prompt, enter:

use asg_openapi

4. Run the source <tmp-directory>/adapter/sqlscripts/asg_openapi.sql script.

Add Proxies in the httpd.conf File

Note

The host running the portal might be a load balancer when multiple instances ofportal engine are running.

The default port, 9122, is for the portal engine and 9322 is the OAuth HTTP port. Bothof these can be changed in the asg-portal.properties file and the asg.propertiesfile, respectively.

Add the following lines to the httpd.conf file:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

47 | Setting Up Joomla

NoteReplace developer.company.com with the appropriate host name.

ProxyPass /apiKey http://developer.company.com :9122/apiKeyProxyPassReverse /apiKey http://developer.company.com :9122/apiKeyProxyPass/portalEvent http://developer.company.com :9122/portalEventProxyPassReverse /portalEvent http://developer.company.com:9122/portalEventProxyPass /asg/internal/product|http://developer.company.com :9122/asg/internal/productProxyPassReverse /asg/internal/product http://developer.company.com:9122/asg/internal/productProxyPass /ConfigUI http://developer.company.com :9200/ConfigUIProxyPassreverse /ConfigUI http://developer.company.com :9200/ConfigUI#Oauth related proxyProxyPass /oauthClient/ http://developer.company.com :9122/oauthClient/ProxyPassReverse /oauthClient/ http://developer.company.com:9122/oauthClient/ProxyPass /asg/oauth2/ http://developer.company.com :9322/asg/oauth2/ProxyPassReverse /asg/oauth2/ http://developer.company.com:9322/asg/oauth2/#Analytics related proxyProxyPass /Analytics http://developer.company.com :9122/SpotfireWebProxyPassReverse /Analytics http://developer.company.com:9122/SpotfireWebProxyPass /SpotfireWeb http://developer.company.com :9122/SpotfireWebProxyPassReverse /SpotfireWeb http://developer.company.com :9122/SpotfireWeb

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

Uncommenting LoadModule Items in the httpd.conf File

Uncomment the following lines in the httpd.conf file:

LoadModule proxy_module modules/mod_proxy.soLoadModule proxy_connect_module modules/mod_proxy_connect.soLoadModule proxy_http_module modules/mod_proxy_http.so

Restarting Apache

Go to the $APACHE_HOME/bin folder, and enter:

httpd.exe -k restart

Adapter Code for TIBCO® API Exchange and Joomla! Installation

48 | Setting Up Joomla

Specifying the ConfigUI for the API Manager Configuration and Email Templates

In the Joomla administrator, go to http://</administrator>System>Global Configuration>APIManager Configuration and Email Templates and specify the following URL in the ConfigUIfield:

http://developer.company.com :9200

Validating the Portal Installation

Procedure

1. Go to the URL where the portal is installed, for example:

http://<hostname>.<domain.name>

NoteIf you see warning messages in the portal, go to administrator (user:admin,pwd:admin) and in Global Configuration -> Server, change Error Reporting to “None.”

2. Verify that you see the Getting Started window. This window should be similar to thefollowing:

Adapter Code for TIBCO® API Exchange and Joomla! Installation

49 | TIBCO Documentation and Support Services

TIBCO Documentation and Support ServicesFor information about this product, you can read the documentation, contact TIBCOSupport, and join TIBCO Community.

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentationwebsite, mainly in HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current thanany other documentation included with the product.

Product-Specific Documentation

Documentation for Adapter Code for TIBCO® API Exchange and Joomla! is available on theAdapter Code for TIBCO® API Exchange and Joomla! Product Documentation page.

To directly access documentation for this product, double-click the following file:

TIBCO_HOME/release_notes/TIB_api-exchange-joomla-adapter_2.3.4_docinfo.htmlwhere TIBCO_HOME is the top-level directory in which TIBCO products are installed. OnWindows, the default TIBCO_HOME is C:\tibco. On UNIX systems, the default TIBCO_HOMEis /opt/tibco.

The following documents for this product can be found in the TIBCO Documentation site:

l Adapter Code for TIBCO® API Exchange and Joomla! Installation

l Adapter Code for TIBCO® API Exchange and Joomla! Administration Guide

l Adapter Code for TIBCO® API Exchange and Joomla! User's Guide

l Adapter Code for TIBCO® API Exchange and Joomla! Release Notes

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

l For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

l For accessing the Support Knowledge Base and getting personalized content aboutproducts you are interested in, visit the TIBCO Support portal athttps://support.tibco.com.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

50 | TIBCO Documentation and Support Services

l For creating a Support case, you must have a valid maintenance or support contractwith TIBCO. You also need a user name and password to log in tohttps://support.tibco.com. If you do not have a user name, you can request one byclicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employeesubject matter experts to share and access their collective experience. TIBCO Communityoffers access to Q&A forums, product wikis, and best practices. It also offers access toextensions, adapters, solution accelerators, and tools that extend and enable customers togain full value from TIBCO products. In addition, users can submit and vote on featurerequests from within the TIBCO Ideas Portal. For a free registration, go tohttps://community.tibco.com.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

51 | Legal and Third-Party Notices

Legal and Third-Party NoticesSOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENTWHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH ISDUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT ORCLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OFTHE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THESAME.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo are either registered trademarks or trademarks of TIBCOSoftware Inc. in the United States and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of OracleCorporation and/or its affiliates.

This document includes fonts that are licensed under the SIL Open Font License, Version 1.1, which isavailable at: https://scripts.sil.org/OFL

Copyright (c) Paul D. Hunt, with Reserved Font Name Source Sans Pro and Source Code Pro.

All other product and company names and marks mentioned in this document are the property oftheir respective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. See the readme file for theavailability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

Adapter Code for TIBCO® API Exchange and Joomla! Installation

52 | Legal and Third-Party Notices

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGESARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATEDIN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/ORCHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANYTIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUTNOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2016-2021. TIBCO Software Inc. All Rights Reserved.