Tib Bc Gtwserver Admin

7/21/2019 Tib Bc Gtwserver Admin

1/49

TIBCO BusinessConnect

Gateway Server

AdministrationSoftware Release 6.1

May 2013

Two-Second AdvantageTM


2/49

Important Information

SOME 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 LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND ANAGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright laws andtreaties. No part of this document may be reproduced in any form without the written authorization of TIBCOSoftware Inc.

TIBCO, The Power of Now, TIBCO Hawk, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO ActiveMatrixBusinessWorks, TIBCO Administrator, and TIBCO Designer are either registered trademarks or trademarks ofTIBCO Software Inc. in the United States and/or other countries.

EJB, J2EE, JMS and all Java-based trademarks and logos are trademarks or registered trademarks of SunMicrosystems, Inc. in the U.S. and other countries.

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

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALLOPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFICOPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR

IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.

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

Copyright 1999-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information


3/49

TIBCO BusinessConnect Gateway Server Administration

Contents | iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Gateway Server Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 Gateway Server Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Gateway Server Deployment and Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

gsengine Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 3 Gateway Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Managing Gateway Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Viewing Gateway Instances Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 4 Gateway Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuring Gateway Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 5 Gateway Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Creating Gateway Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Create a New Gateway Token using TIBCO Administrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Create a New Gateway Token using CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Managing Gateway Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
http://lof.pdf/http://lof.pdf/


4/49


iv | Contents

Chapter 6 Network Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Using Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Filtering Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Filter Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Creating Network Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Edit a Network Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37


5/49


|v

Preface

TIBCO BusinessConnectsoftware is a B2B (business-to-business) gateway thatallows your company to engage in electronic commerce with your businesspartners.

Topics

Related Documentation, page vi

Typographical Conventions, page viii

Connecting with TIBCO Resources, page xi


6/49


vi | Related Documentation

Related Documentation

The following documents form the BusinessConnect documentation set:

TIBCO BusinessConnect Installation and Configuration. Read this guide tolearn how to install and configure TIBCO BusinessConnect.

TIBCO BusinessConnect Concepts: Read this guide to learn about TIBCOBusinessConnect architecture, deployment modes, protocols, and security.

TIBCO BusinessConnect Interior ServerAdministration: Read this guide in

order to administer, operate, and manage TIBCO BusinessConnect InteriorServer.

TIBCO BusinessConnect Gateway ServerAdministration: Read this guide inorder to administer, operate, and manage TIBCO BusinessConnect GatewayServer.

TIBCO BusinessConnect Trading Partner Administration: Read this guide toconfigure and manage trading partners.

TIBCO BusinessConnect Scripting Deployment Users Guide: Read this guide toconfigure and manage TIBCO BusinessConnect using the command lineinterface.

TIBCO BusinessConnect Release Notes: Read this document to learn aboutnew features, changes in functionality, deprecated features, known issues, andclosed issues for each release. This document is supplied for each release andis available only in PDF format.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCOproducts, which may be used or integrated with BusinessConnect:

TIBCO Administratorsoftware: The software allows you to manage users,machines and applications defined in a TIBCO Administration Domain. The

TIBCO Administrator graphical user interface enables users to deploy,monitor, and start and stop TIBCO applications.

TIBCO ActiveMatrix BusinessWorkssoftware: This software is a scalable,extensible, and easy to use integration platform that allows you to developintegration projects. TIBCO BusinessWorks includes a graphical user interface(GUI) for defining business processes and an engine that executes the process.

TIBCO Designersoftware: This graphical user interface is used for

designing and creating integration project configurations and building an


7/49


Preface |vii

Enterprise Archive (EAR) for the project. The EAR can then be used by TIBCOAdministrator for deploying and running the application.

TIBCO Runtime Agentsoftware: This software suite is a prerequisite forother TIBCO software products. In addition to TIBCO Runtime Agentcomponents, the software suite includes the third-party libraries used byother TIBCO products such as TIBCO Designer, Java Runtime Environment(JRE), TIBCO Hawk, and TIBCO Rendezvous.

TIBCO Rendezvous: This software enables programs running on manydifferent kinds of computers on a network to communicate seamlessly. Itincludes two main components: the Rendezvous programming language

interface (API) in several languages, and the Rendezvous daemon. TIBCO Enterprise Message Service software: This software provides a

message service that enables integration of applications within an enterprisebased on the Java Message Service (JMS) specifications.


8/49


viii | Typographical Conventions

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

ENV_HOME

BC_HOME

Many TIBCO products must be installed within the same home directory. Thisdirectory is referenced in documentation as TIBCO_HOME. The default value ofTIBCO_HOMEdepends on the operating system. For example, on Windows

systems, the default value is C:\tibco.

Other TIBCO products are installed into an installation environment. Incompatibleproducts and multiple instances of the same product are installed into differentinstallation environments. An environment home directory is referenced indocumentation as ENV_HOME. The default value of ENV_HOMEdepends on theoperating system. For example, on Windows systems the default value isC:\tibco.

TIBCO BusinessConnect installs into a directory within TIBCO_HOME ORENV_HOME. This directory is referenced in documentation as BC_HOME. Thedefault value of BC_HOMEdepends on the operating system. For example onWindows systems, the default value is C:\tibco\bc\version.

code font Code font identifies commands, code examples, filenames, pathnames, andoutput displayed in a command window. For example:

Use MyCommandto start the foo process.

bold code

fontBold code font is used in the following ways:

In procedures, to indicate what a user types. For example: Type admin.

In large code samples, to indicate the parts of the sample that are ofparticular interest.

In command syntax, to indicate the default parameter for a command. For

example, if no parameter is specified, MyCommandis enabled:MyCommand [enable| disable]


9/49


Preface | ix

italic font Italic font is used in the following ways:

To indicate a document title. For example: See TIBCO BusinessConnectConcepts.

To introduce new terms. For example: A portal page may contain severalportlets. Portletsare mini-applications that run in a portal.

To indicate a variable in a command or code syntax that you must replace.

For example:MyCommand

PathName

Keycombinations

Key names separated by a plus sign indicate keys pressed simultaneously. Forexample: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after theother. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for

example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to applythe information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example,data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Contd)

Convention Use

Table 2 Syntax Typographical Conventions

Convention Use

[ ] An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

| A logical ORthat separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand para1 | param2 | param3


10/49


x | Typographical Conventions

{ } A logical group of items in a command. Other syntax notations may appearwithin each logical group.

For example, the following command requires two parameters, which can beeither the pair param1and param2, or the pair param3and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parametercan be either param1or param2and the second can be either param3or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters.The first parameter must be param1. You can optionally include param2as thesecond parameter. And the last parameter is either param3or param4.

MyCommand param1 [param2] {param3 | param4}

Table 2 Syntax Typographical Conventions

Convention Use


11/49


Preface |xi

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, andresident experts; a place to share and access the collective experience of theTIBCO community. TIBCOmmunity offers forums, blogs, and access to a varietyof resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO Documentation

After you join TIBCOmmunity, you can access the documentation for allsupported product versions here:

http://docs.tibco.com/TibcoDoc

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, pleasecontact TIBCO Support as follows:

For an overview of TIBCO Support, and information about getting startedwith TIBCO Support, visit this site:

http://www.tibco.com/services/support

If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a username and password. If you do not have ausername, you can request one.
http://www.tibcommunity.com/http://docs.tibco.com/TibcoDochttp://www.tibco.com/services/supporthttps://support.tibco.com/https://support.tibco.com/http://www.tibco.com/services/supporthttp://docs.tibco.com/TibcoDochttp://www.tibcommunity.com/


12/49


xii | Connecting with TIBCO Resources


13/49


|1

PollerTab

Chapter 1 Introduction

This chapter introduces TIBCO BusinessConnect Gateway Server and explainsits functionality.

Topics

Gateway Server Overview, page 2


14/49


2 | Chapter 1 Introduction

Gateway Server Overview

TIBCO BusinessConnect Gateway Server is located in the demilitarized (DMZ)zone outside of the companys firewall. It receives B2B communications directlyfrom the Internet and performs SSL validation. The firewall between the GatewayServer and the rest of your system protects against the threat of maliciouscommunications.

TIBCO BusinessConnect Gateway Server does not depend either on ActiveMatrixBusinessWorks or on TIBCO Runtime Agent installation; however, it still needsTIBCO Rendezvous to communicate with the Interior server.

The Gateway Server installation includes FILE and HTTP event sources. It isinstalled using TIBCO Universal Installer, which allows that only this server isselected for installation. See TIBCO BusinessConnect Installation and Configuration.

Once TIBCO BusinessConnect Interior Server is deployed and running, you cancreate a Gateway Token, export it, and then import this token to the GatewayServer to start and deploy it.

A diagram of the Gateway Server and Interior Server communications is depictedin Figure 1.

Figure 1 Gateway and Interior Server Communication

Gateway

Server

Management Port

RVDMZ-MSH

Interior

Server RV/JMS PrivateProcess

RV

DB

Administrator

Firewall

Data Port

streaming

Management Port

Firewall

JDBC

G S O i |3


15/49


Gateway Server Overview |3

The Gateway Server is:

Backward compatible Same communication is used between the GatewayServer and Interior Server as it was between the DMZ Server and Interior

Server in previous releases.

Flexible Configurations are pulled from the Interior Server when eventsources are configured or updated.

Secure Uses secure streaming DDTP (DMZ Data Transfer Protocol) insteadof FCP, which is not secure.

Management of the Gateway Server is performed using the secure JMX

management protocol; using TIBCO Administrator, users can remotely controlwhich component to start or stop.

For more details about the Gateway Server, see TIBCO BusinessConnect Concepts,Interior Server and Gateway Server Architecture.

http://../concepts/concepts.pdfhttp://../concepts/concepts.pdf


16/49



|5


17/49


|5

Chapter 2 Gateway Server Quick Start

This chapter gives the basic steps to quickly install and deploy the GatewayServer.

Topics

Gateway Server Deployment and Start, page 6

gsengine Commands, page 9

6 | Chapter 2 Gateway Server Quick Start


18/49



Gateway Server Deployment and Start

To deploy and start the TIBCO BusinessConnect Gateway Server, follow thesesteps:

Task A Create a Gateway Token

On the machine where the Interior Server is already running:

1. Using TIBCO Administrator, select BusinessConnect > Gateway.

2. Click on Gateway Tokens link.

3. In the Gateway Tokens dialog, click New.

In the Enter Token Parameters window enter information as in Table 9.

4. Click Create.

Task B Export the Gateway Token

On the machine where the Interior Server is already running:

1. In the Gateway Tokens window, check the checkbox next to the token youwant to export.

2. Click Export.

3. Save the file securetoken.dat on a desired location.

Task C Start a Gateway Server Container

On the machine where the Gateway Server will be deployed:

1. Import the previously exported Gateway Token file (securetoken.dat) tothe directory BC_HOME/gs/token.

2. (Optional) Go to the directory BC_HOME/bin and edit the file gsengine.tra.

Enable the DEBUGmode by editing the propertyjava.property.gs.logger.level=INFO

and set it to

java.property.gs.logger.level=DEBUG

The token file should only be readable to the Gateway server process to which it iscopied. Any other instances of the file must be safely deleted. The token can bere-exported at any time until it is revoked or deleted from the BusinessConnectconfiguration.

Gateway Server Deployment and Start |7


19/49


y p y |

3. Make sure that the Interior Server is already running!

4. Start the Gateway Server container from the directory BC_HOME/bin byinitializing the file gsengine. Execute

gsengine on UNIX, or

gsengine.exe on Windows.

Upon startup, the Gateway Server registers itself with the Interior Server,which provides real time updates from the Gateway Server and allows theInterior Server to manage the life cycle of the Gateway Services at theGateway Server. Through TIBCO Administrator, the Interior Server can start

and reassign Gateway Services at the Gateway Server.

Task D Configure a Gateway Service

On the machine that will be used to deploy the Gateway Server:

1. Using TIBCO Administrator, select BusinessConnect> Gateway.

2. Click on Gateway Services link.

3. Click New.

4. Add the service name and select the transport type: FILE or HTTP.

More Gateway services are available upon installation of various plug-ins tothe BusinessConnect Gateway, such as PX and FTPS.

5. Click OK.

The window New Gateway Service appears.

6. Depending on the selected transport, continue configuration as explained inHTTP, page 19or FILE, page 22.

To configure services for TIBCO PartnerExpress, see TIBCO PartnerExpressUsers Guide.

To configure services for TIBCO BusinessConnect Plug-in for FTP Server, seeTIBCO BusinessConnect Plug-in for FTP Server Users Guide.

Task E Assign the Gateway Service to the Gateway Instance

On the machine that will be used to deploy the Gateway Server:


2. Select the radio button next to an active running Gateway Server containerwhere you wish to deploy public transports (Gateway Services) and clickManage.

3. Choose a transport type to deploy.



20/49


|

This transport must be previously enabled under System Settings> PublicTransports.

4. Select Assign.

5. In the Configure Service screen, choose the Gateway Server Group and choosethe Group from the drop-down list.

6. Click OK.

7. In the Manage Service screen, click DONE.

8. Start the public transports assigned on this Gateway Server container byclicking START.

The transport is now activated and ready for inbound requests.

gsengine Commands |9


21/49


|

gsengine Commands

The command gsengineitself starts the Gateway Server, as explained in Task C,Start a Gateway Server Container, page 6.

When combined with additional command options, gsengineis used to managethe Gateway instances.

Syntax gsengine --propFile

where can be one of the following command switches:

--install Installs a wrapped application as a service

--uninstall Uninstalls a previously installed service

--update Updates a previously installed wrapped application, or installs it if theapplication does not exist

--start Starts a previously installed service

--stop Stops a running service

--run Runs a wrapped application as a console application



22/49


|11


23/49


Chapter 3 Gateway Instances

This chapter explains how to view and manage the Gateway Instances.

Topics

Managing Gateway Instances, page 12

Viewing Gateway Instances Statistics, page 14

12 | Chapter 3 Gateway Instances


24/49


Managing Gateway Instances

After a Gateway Token is exported from the Interior Server to the Gateway Serverand an instance of the Gateway Server is started, it can be viewed and managed inthe Gateway Instances window.

On the machine where the Gateway Server has been deployed:


2. Click on Gateway Instances link.

The Gateway Instances window opens and lists all registered active Instances.

Figure 2 Gateway Instance

3. You can manage the listed Service Instances using the provided buttons:

Start to start an instance

Stop to stop an instance

Remove to remove an instance

Manage to remove an instance or

to assign a Gateway service to an instance (see Assign a Gateway Service toa Gateway Instance, page 12)

Refresh To refresh the screen

Assign a Gateway Service to a Gateway Instance

To use a Gateway Service, first you must assign it to a running Gateway Instance.

1. In the Gateway Instances window, select the radio button next to an instance.

2. Click Manage.

3. In the Manage Service window, select the radio button next to the service you

want to manage: HTTP or FILE.

Managing Gateway Instances |13


25/49


4. Click Assign.

5. In the Configure Services window, select the service from the Gateway ServerGroup drop-down list.

6. Click OK.

The Manage Service window shows now that a service is assigned to aninstance presented with the transport type used.

7. Click Done.

The Gateway Instances window now shows the complete status of theassigned service.

Figure 3 Gateway Service Assigned to an Instance

8. To start the assigned service, click Start.

After the service is started the State column displays RUNNING-serviceinstead

of IDLE.



26/49


Viewing Gateway Instances Statistics

BusinessConnect administrators can obtain audit trail information about theGateway instance activity that is currently occurring.

They can get information such as:

Type of the currently running Gateway event sources

Status of the different event Sources such as HTTP and FILE.

Information about the ports that are used to communicate with the Interior

ServersTo obtain the audit trail information:

1. Using TIBCO Administrator, select BusinessConnect> Log Viewer.

2. In the Log Viewer window, select the radio button next to the Gateway ServiceInstance.

3. Click the Auditbutton.

The Audit log of the Gateway Service instance appears, with the status ANY.

4. Choose the status of the transactions you want to view:

ANY

COMPLETED

ERROR

PROCESSED

PROCESSING

5. Click on Search, to filter the results.

Viewing Gateway Instances Statistics |15


27/49


Figure 4 Audit Log: Completed Transaction

6. To see the details for the transaction in the audit log, click on the documenticon next to the transaction.

The Transaction Details window opens.

Figure 5 Audit Log: Transaction Details



28/49


|17


29/49


Chapter 4 Gateway Services

This chapter explains the functionality and management of the Gateway Services.

Topics

Overview, page 18

Configuring Gateway Services, page 19

18 | Chapter 4 Gateway Services


30/49


Overview

If a Gateway Service has been started successfully and registered with the InteriorServer at least once and using at least one Gateway Service, the Gateway Serverwill remember that information and will automatically restart the next time withthe same groups.

After a restart, users dont have to return to the GUI and reassign these groups tothat same Gateway Server container, provided no changes to the groups areneeded. The Gateway Server itself returns to the GUI and captures the latestinformation associated with a specific container.

In order to make changes to the Gateway Services, make any desired changes tothe groups using the GUI, and then restart the edited Gateway service so that newsetting is captured.

Configuring Gateway Services |19


31/49


Configuring Gateway Services

After an empty container has been started, you need to deploy a Gateway Servicein that container.

To create a Gateway Service (a public transport group):


2. Click on Gateway Services link.

3. Click New.

The window New Gateway Service appears. Depending on the selectedservice, different configuration options will be available.

HTTP, page 19

FILE, page 22

FTPS: See TIBCO BusinessConnect Plug-in for FTPS Server Users Guidefor information.

PX: See TIBCO BusinessConnect Plug-in for PartnerExpress Users Guidefor information.

4. Enter the name for the new service, select the service type and Click OK.

HTTP

To configure the HTTP service, you will use the following tabs:

General Tab for HTTP, page 19

Credentials Tab for HTTP, page 20

Transport Tab for HTTP, page 20

General Tab for HTTP

Check the checkbox Activeto activate the service.



32/49


Credentials Tab for HTTP

This tab allows you to select a private key used by the Gateway Service.

1. Click on New Private Key.

2. Click Save.

The new Private key is now listed under Credential Name.

Transport Tab for HTTPThis tab contains two subtabs to configure the Gateway Service settings

Table 3 HTTP Service: New Private Key for the Group

Field Description

Alias Enter the name for the new private key.

CurrentCredential

To set a new key or to replace an existing one, click change.

Upload the new private key from your machine.Password Add the password to protect the key (required).

Table 4 HTTP Service: Ports Tab

Field Description

Plain Port Default is 6700

Secure Port Default is 6705

Secure CA Port Default is 6707

Private KeyCredential forSecure Ports

Select a private key that was previously configured for the Gateway Service usingthe Credentials Tab for HTTP, page 20.

To disable secure communications on HTTP, enter 0 or leave the Secure Port orSecure CA Port fields empty.



33/49


3. Click Save.

Table 5 HTTP Service: Advanced Tab

Field DescriptionSecurity

MinimumEncryptionStrength

Select the encryption strength from the dropdown list:

All

Only Stronger Than Export Policy

Only 128-Bit and Stronger Only Stronger Than 128 Bit

Only 256 Bit and Stronger

Gateway to Interior Settings

Data StreamingThreshold (KB)

Default is 10000

This threshold value controls when data streaming is utilized to transfer thepayload data between the Gateway Server and the Interior Server.

Request Timeout(secs)

This timeout value controls how long the Gateway Server should wait forthe request from the Interior Server to complete.

The default is 3600 seconds.



34/49


FILE

To configure the FILE service, you will use the following tabs:

General Tab for FILE, page 22

Transports Tab for FILE, page 22

General Tab for FILE

Check the checkbox Activeto activate the service.

Transports Tab for FILE

This tab contains three subtabs:

Poller Tab, page 22

Fault Tolerance Tab, page 23

Advanced Tab, page 23

Poller Tab

This tab is used to configure the File Poller, as explained in Table 6.

Table 6 FILE Service: Poller Tab

Field Description

Monitor Directory

(required)

The directory to be monitored by the File Poller.

This directory must start with '/' or '\' or '//' or '[a-zA-Z]:' and must endwith '/' or '\'

Example: C:\tibco\bc\6.0\monitorFiles\file.txt

Polling Interval(secs)

A period of time specified in seconds. The Poller monitors the specifiedlocation for the new and updated files.

The default is 300 seconds.

Delete Files afterProcessing

When this checkbox is checked, the files will be deleted after processing (thisis the default).

Directory to PlaceError Files(required)

Assign a directory where the error files will be placed.

This directory must start with '/' or '\' or '//' or '[a-zA-Z]:' and must endwith '/' or '\'


F lt T l T b


35/49


Fault Tolerance Tab

TIBCO Rendezvous is used to achieve fault tolerance for the FILE service. Use thistab to configure the transport as explained in Table 7.

Advanced TabThis tab is used to configure communication settings between the Gateway Serverand the Interior Server.

Click Save.

Table 7 FILE Service: Fault Tolerance Tab

Field Description

RV Service Name of the service. This is the default value and is carried over from theApplication Management> BusinessConnect> Configuration>BusinessConnect> Component Settings>IntercomponentCommunication>Gateway Server settings

RV Network Network on which the service is running. This is the default value and is carriedover from theApplication Management> BusinessConnect> Configuration>BusinessConnect> Component Settings>IntercomponentCommunication>Gateway Server settings

RV Daemon Host used by the RV daemon. The value is carried over from the ApplicationManagement> BusinessConnect> Configuration> BusinessConnect> ComponentSettings>Intercomponent Communication>Gateway Server settings

ActivationInterval (secs)

Default is 15

HeartbeatInterval (secs)

Default is 5

Table 8 FILE Service: Advanced Tab

Field Description

Gateway to Interior Setting

Data StreamingThreshold (KB)

Default is 10000.This threshold value controls when data streaming is utilized to transfer thepayload data between the Gateway Server and the Interior Server.

Request Timeout(secs)

Request a timeout for the start of the Gateway to Interior Servercommunication. The default is 3600 seconds.



36/49


|25

Ch t 5 Gateway Tokens


37/49


Chapter 5 Gateway Tokens

This chapter explains the functionality and management of the Gateway Tokens.

Topics

Overview, page 26

Creating Gateway Tokens, page 27

Managing Gateway Tokens, page 29

26 | Chapter 5 Gateway Tokens

Overview


38/49


Overview

The Gateway Token is a secured configuration file that is used to establish atrusted connection between the Gateway Server and the Interior Server. Itsconfiguration involves setting up a Management Port for the secure JMX to beopened and monitored from the Interior Server Administrator to the GatewayServer. Configuration also requires a secure Data Port to be used for streaming thepayload between the Gateway Server and the Interior Server.

The Gateway Token also defines the TIBCO Rendezvous communication portsbetween the Gateway engine and the Interior Server for message initiation and

discovery process for the Interior Server.

The Gateway Server container reads the Gateway Token to start establishing asecure trusted connection with the Interior Server.

The Gateway Token also defines policy control and validates policies uponstartup.

After exporting the token (securetoken.dat) and transferring the file to the

Gateway engine (for example by using a flash drive), only the engine processshould have read access to this file. The token file should then be safely deletedfrom any other location than the dedicated Gateway server. The BusinessConnectconfiguration will retain this token until it is revoked or deleted.

Creating Gateway Tokens |27

Creating Gateway Tokens


39/49


Creating Gateway Tokens

Create a New Gateway Token using TIBCO Administrator

When a new Gateway token is created using TIBCO Administrator, the file isdownloaded and saved under the name securetoken.dat,which then needs tobe placed in the folder BC_HOME/gs/token.

1. Select BusinessConnect > Gateway Server.

2. Click on the Gateway Tokens link.

3. In the Gateway Tokens dialog, click New.

In the Enter Token Parameters window enter information as in Table 9..

Table 9 Enter Token Parameters

Field Description

Name Name of the Gateway Token

Description Brief description for the Gateway Token

Management Port The port used for JMX based management of the Gateway Server.

The default is 11000

Data Port The port used for streaming payload data from the Gateway Server to theInterior Server.

Default is 12000

Policy Policies are optional configuration parameters that are used to secure that theGateway Token is used for Gateway engines only for the specified publictransport and/or management and data port binding addresses.

When a Gateway Token is created using the IP addresses defined on publictransport bindings and/or for management and data port bindings, these

specified values are checked when the Gateway engine is started.

Public TransportBinding

This binding can be used to bind the public inbound listeners on a specific IPaddress in a multi-homed host.

If no value is specified, the Gateway Server will bind to all IP addresses andimpose no restriction on a particular address for external communication withtrading partners.


Table 9 Enter Token Parameters


40/49


4. Click Create.

Create a New Gateway Token using CLI

If the new Gateway token is not saved under the default name securetoken.datbut under a different file name, such as newsecuretoken.dat, then the Gatewayserver should be started using the CLI command:

cdBC_HOME/gs/token

gsengine -gstoken newsecuretoken.dat

Management andData TransportBinding

This binding can be used to bind the management listeners on a specific IPaddress in a multi-homed host.

If no value is specified, the Gateway Server will bind to all IP addresses andimpose no restriction on a particular address for external communication withthe Interior Servers.

Advanced

RV Network This Rendezvous network is used for Gateway to Interior Servercommunication. The value is carried over from theApplicationManagement>BusinessConnect>Configuration>BusinessConnect>Component Settings>Intercomponent Communication>Gateway Serversettings.

RV Service This Rendezvous service is used for Gateway to Interior Servercommunication. The value is carried over from the ApplicationManagement>BusinessConnect>Configuration>BusinessConnect>Component Settings>Intercomponent Communication>Gateway Serversettings.

RV Daemon Port This Rendezvous daemon is used for Gateway to Interior Servercommunication. The value is carried over from the ApplicationManagement>BusinessConnect>Configuration>BusinessConnect>Component Settings>Intercomponent Communication>Gateway Serversettings.

Field Description

Managing Gateway Tokens |29

Managing Gateway Tokens


41/49


g g y

Add a New Token

In the Gateway Tokens window, click Newto add a new token.

All added tokens will be listed in the Name column.

Remove a Token

To remove unwanted tokens, select one or more tokens and click Remove.

Export a Token

To export a token for deployment on the Gateway Server, select one token andclick Export.

Save the file securetoken.datin the BC_HOME/gs/tokendirectory. Thisdirectory is located on the Gateway Server side.

Edit a Token

To edit an existing token, select the token link.

In the Edit TokenSettings window, edit the desired settings as explained inTable 9.

Revoke TokensTo revoke Gateway Tokens:

1. Select BusinessConnect> Manage.

2. In the Configuration Repository, section Revoke Getaway Tokens, clickRevoke.

A message will pop-up to warn you that invalidating all trusted Gateway

Tokens exported with this installation will shut down all currently runningGateway instances.

3. Click OK,



42/49


|31

Chapter 6 Network Filters


43/49


p

This chapter explains the functionality and management of the Gateway Servernetwork filters.

Topics

Overview, page 32

Creating Network Filters, page 35

32 | Chapter 6 Network Filters

Overview


44/49


Network filters are used to define where the inbound traffic to a Gateway Serverwill be coming from based on the IP address or based on the trading partners.

Using Filtering

The property bc.ipfilter.enabledcan be used to enable or disable IP filtering.If disabled (check box unchecked), no filtering takes place at any level and allincoming requests will be allowed to pass with any remote IP address. If enabled

(check box checked), then every incoming request will be evaluated as follows:

DENY If there is no matching filter expression, regardless of type DenyorAcceptAND the default policy is Deny.

DENY If there is at least one filter expression that matches the address and isof type Deny.

ACCEPT If there is no matching filter expression regardless of type DenyorAccept

AND the default policy isAccept.

ACCEPT If there is no matching filter expression of type DenyAND there is atleast one matching filter expression of type Accept.

Filtering Levels

Network filters can perform two levels of filtering:

Filtering based on the IP address (first level)

Filtering based on the trading partner name (second level)

First level of filtering, where IP addresses are specified, takes precedence over thesecond level of filtering.

First Level Filtering

The first level of filtering is used to deny or accept an IP address. It is exercised forthe inbound HTTP or FTPS traffic. It decides whether certain messages will bedenied or accepted and then passed to the Interior Server.

If there is any disabled individual filter expression that matches the address, itwill not participate in the filtering decision but it can be reactivated at any time.

Overview |33

Second Level Filtering


45/49


Second level filtering using the field From Participant is exercised on the InteriorServer only for d FTPS transports. It is performed before user authentication and

during on login for FTPS.

Filter Level Precedence

First level of filtering is performed only when the FromParticipantfield, asrequired for the second level of filtering, is not specified.

You can also define the first level filtering by selecting BusinessConnect >System Settings > Activated Protocol Plug-ins and Properties>

BusinessConnect Serverand then looking for the entrybc.ipfilter.default.noMatchPolicy.

From the dropdown menu select the Default IP Filter Policy:

Accept

Deny

Based on this selection, the default first level filtering will either deny or acceptthe traffic from a certain IP address if no existing (and active) rules have matchedthe address.

Filter Expressions

Only one filter expression can be created with a single filter entry and can matchthe remote IP addresses directly, or can define any arbitrary ranges with a specificpattern syntax.

IPv4 canonical textual representation: N1.N2.N3.N4 where N1-4 are segmentsbetween 0 and 255 inclusive.

Matching Patterns

Here are some examples of matching patterns to use:

1.2.3.4 Matches the IPv4 address 1.2.3.4 directly. Any other address on

this pattern will be non-matching.

1.2.3.* Matches all the IPv4 addresses between 1.2.3.0 and 1.2.3.255inclusive, a total of 256 addresses.

1.2.3.4-12 Matches all the IPv4 addresses between 1.2.3.4 and 1.2.3.12inclusive, a total of 9 addresses.

1.2.3-5.* Matches all the IPv4 addresses between 1.2.3.0 and between

1.2.5.255, a total of 768 addresses.


1.2.* Matches all the IPv4 addresses between 1.2.0.0 and 1.2.255.255, a totalof 65,536 addresses.


46/49


of 65,536 addresses.

Any combination of ranges (n1-n2) and wildcards *are allowed for a

different segment. The expression *.*.*.* can be used to match every possibleIPv4 address.

If the pattern doesn't specify every segment, they are canoncicalized so that theymatch every address for the given segments' range.

Creating Network Filters |35

Creating Network Filters


47/49


To create a network filter:

1. Select BusinessConnect> Gateway> Network Filters.

2. Click Add.

3. Enter filter parameters as described in Table 10.

4. Click Save.

5. The new filter will be displayed in the Network Filters window.

Table 10 Network Filter Parameters

Field Description

Name Enter the filter name.

Enable Check this field to enable the filter.

Default is checked.

Type This field defines whether a single IP address, or a range of IP addresses, will bedenied or accepted:

Deny Indicated that a matching IP address will be denied

or

Accept Indicated that a matching IP address will be accepted

IP Expression This is first level filtering based on the IP address denial or acceptance and isrequired. Enter the IP address information by using wildcards * or a range -.

No regular expressions or comma-delimited expressions are allowed.

Example: 1.2.1-100.*

For more details see Matching Patterns on page 33.

FromParticipant

This is second level filtering based the trading partner name and is performedbefore user authentication and during login for SFTP or FTPS.

This field is not required.

For more details see Filtering Levels on page 32.


6. Use the Network Filters window to:

Add a new filter


48/49


Add a new filter

Delete an existing filter

Edit a Network Filter, page 36

Figure 6 New Filter Created

Edit a Network Filter

To edit an existing network filter:

1. In the Network Filters window, click on the filter link.

The EditfilterSettings window appears. Edit the filter settings as explained inTable 10 on page 35.

Index |37

Index


49/49


C

configuring Gateway Services 19

Credentials tab for HTTP 20

FILE transport 22

General tab for HTTP transport 19

customer support xi

E

ENV_HOME viii

G

GatewayServerPX.Partner.Ports 19

General tab for FILE transport 22

S

support, contacting xi

T

technical support xi

TIBCO_HOME viii

Transports tab for File

Advanced tab 23

Fault Tolerance tab 23

Poller tab 22

V

viewing Gateway instances statistics 14

Tib Bc Gtwserver Admin

Documents

Transcript of Tib Bc Gtwserver Admin