Académique Documents
Professionnel Documents
Culture Documents
You should put here an overview of the document including appropriate things
Consulting like the intent of the document, the intended audience, prerequisite knowledge,
Services etc.
Document Revisions:
http://www.tibco.com
Global Headquarters
3303 Hillview Avenue
Palo Alto, CA 94304
Tel: +1 650-846-1000
Toll Free: 1 800-420-8450
Fax: +1 650-846-1005
©Copyright 2004, TIBCO Software Inc. All rights
reserved. TIBCO, the TIBCO logo, The Power of
Now, and TIBCO Software are trademarks or
registered trademarks of TIBCO Software Inc. in
the United States and/or other countries. All other
product and company names and marks
mentioned in this document are the property of
their respective owners and are mentioned for
identification purposes only. 0204
TIBCO Deployment and Operations Guide for <Project Name>
This document template provides a comprehensive structure for recording the information regarding where the various
TIBCO (and related non-TIBCO) components are deployed for a project. Depending upon how your project is
organized, this document may be left as a single document, it may be split into several documents, or its contents can
be used to augment the outlines of existing project documentation.
Single Document: for relatively independent small projects (less than 10 people on the technical team) the document
outline can be used as-is.
Separate Deployment Guide and Separate Operations Guide – If there are 2 different teams at the customer site-
one for deployment of the projects and other for maintainance and operations then this document can be divided into 2
separate documents. Chapters 1-4 can be split off into a separate deployment guide while 5-8 can be part of
Operations guide.
As hinted above, each service/project will generally will have its own document with a structure similar to this one
covering the deployment and operations of that service as an entity unto itself.
2
TIBCO Deployment and Operations Guide for <Project Name>
Copyright Notice
COPYRIGHT© 2004 TIBCO Software Inc. This document is unpublished and the foregoing notice is affixed to protect
TIBCO Software Inc. in the event of inadvertent publication. All rights reserved. No part of this document may be
reproduced in any form, including photocopying or transmission electronically to any computer, without prior written
consent of TIBCO Software Inc. The information contained in this document is confidential and proprietary to TIBCO
Software Inc. and may not be used or disclosed except as expressly authorized in writing by TIBCO Software Inc.
Copyright protection includes material generated from our software programs displayed on the screen, such as icons,
screen displays, and the like.
Trademarks
Technologies described herein are either covered by existing patents or patent applications are in progress. All brand
and product names are trademarks or registered trademarks of their respective holders and are hereby acknowledged.
Confidentiality
The information in this document is subject to change without notice. This document contains information that is
confidential and proprietary to TIBCO Software Inc. and may not be copied, published, or disclosed to others, or used
for any purposes other than review, without written authorization of an officer of TIBCO Software Inc. Submission of this
document does not represent a commitment to implement any portion of this specification in the products of the
submitters.
Content Warranty
The information in this document is subject to change without notice. THIS DOCUMENT IS PROVIDED "AS IS" AND
TIBCO MAKES NO WARRANTY, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO ALL
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. TIBCO Software Inc. shall
not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing,
performance or use of this material.
3
TIBCO Deployment and Operations Guide for <Project Name>
Table of Contents
Consulting
Services....................................................................................................................................1
1 Document Overview........................................................................................7
1.1 Background........................................................................................................................7
1.2 Document Purpose.............................................................................................................7
1.3 Related Documents............................................................................................................7
3 Deployment Architecture..............................................................................11
3.1 Deployment Pre-requisites...............................................................................................11
3.2 Deployment Server Inventory ..........................................................................................11
3.3 TIBCO Product Deployment Checklist .............................................................................12
3.4 Subject/Destination Names .............................................................................................12
3.5 Ports Inventory ................................................................................................................13
4 Deployment Instructions...............................................................................14
4.1 Deployment Specific Values.............................................................................................14
4.2 Global Variable ................................................................................................................15
4.3 Hawk Configuration Steps................................................................................................15
4.4 Deployment Verification....................................................................................................15
5 Monitoring.......................................................................................................16
6 Operating Procedures...................................................................................17
6.1 Start the System ..............................................................................................................17
6.2 Maintenance Shutdown of the System.............................................................................17
6.3 Maintenance Task (if any)................................................................................................18
6.4 Production Change Request and Migration Procedures...................................................18
7 Troubleshooting.............................................................................................19
7.1 Email Notifications............................................................................................................19
8 Support Information......................................................................................21
8.1 <Customer> Support Structure.........................................................................................21
8.1.1 Teams and Members...........................................................................................21
8.1.2 Support Strategy and Escalation Channels.........................................................21
8.1.3 Application Errors.................................................................................................21
8.1.4 System Errors......................................................................................................21
8.1.5 General Contact Information................................................................................21
8.2 TIBCO Support Information..............................................................................................22
8.2.1 Product maintenance...........................................................................................22
8.2.2 TIBCO Product Support Procedures....................................................................23
8.2.3 Reporting TIBCO Product problems....................................................................24
4
TIBCO Deployment and Operations Guide for <Project Name>
5
TIBCO Deployment and Operations Guide for <Project Name>
Table of Figures
Figure 1 Integration Use Cases...........................................................................8
Figure 2 Logical Architecture..............................................................................9
Table of Tables
Table 1 Integration Use Case Descriptions........................................................9
Table 2 TIBCO Components..............................................................................10
Table 3 Databases...............................................................................................10
Table 4 Deployment Physical Inventory...........................................................11
Table 5 Deployment Object................................................................................12
Table 6 Deployment Product Checklist............................................................12
Table 7 Subject/Destination Names..................................................................13
Table 8 UDP Ports Inventory.............................................................................13
Table 9 TCP Ports Inventory..............................................................................13
Table 10 Deployment Steps...............................................................................14
Table 11 Deployment Specific Environment Variables...................................15
Table 12 Deployment Specific Global Variables..............................................15
Table 13 Troubleshooting Instructions............................................................19
Table 14 Email Notifications..............................................................................20
Table 15 <Customer Name>Support Contact Info...........................................21
Table 16 TIBCO Support Contact Info..............................................................23
6
TIBCO Deployment and Operations Guide for <Project Name>
1 Document Overview
1.1 Background
Explain how this particular project fits in the overall context of the enterprise. If this project is a subset of a larger
project, detail its relationship to the larger overall effort. Explain what motivated the project.
The “Quote to Cash” Service consists of a number of Business Works processes and adapters, and operates in
conjunction with the Siebel CRM and Lawson ERP system. The objectives of this document include the physical
deployment of various TIBCO components involved in this service, the operational monitoring of the service, and basic
troubleshooting of the service. This document does not cover the deployment and operation of either the Siebel or
Lawson system.
The Operations Guide is intended as a reference to the operations and support staffs in order to properly maintain and
operate the TIBCO software used for the <Project Name>. The contents will also serve as background for external
support resources needing a quick understanding of the <Project Name> environment as they begin to work with the
teams in supporting or consulting roles.
This document should be a living document, maintained by <Customer Name> local administrator(s) and/or contractors
as required whenever changes are made to the networks and software described herein. It is a supplement to the
various TIBCO software administration and user guides, and should not replace those references.
7
TIBCO Deployment and Operations Guide for <Project Name>
Use this section to describe architecture in brief and do not go into design or implementation details.
2.1 Introduction
Introduce the project briefly here
The first phase of Order Automation project focuses primarily on the Order phase of the “Quote to Cash” business
process aiming to achieve objectives - Automate, centralize and simplify quote to order process and Integrate CRM and
ERP process.
“Quote to Cash” Phase 1 implements integration between Siebel 7.5 CRM and Lawson 7.3 ERP system using TIBCO
enterprise integration product suite.
Lawson Shipment
Shipping
Sales
Order
Management
8
TIBCO Deployment and Operations Guide for <Project Name>
2. Order is synced/created in Lawson User then manually checks the customer cross-reference information
as per Siebel order in Lawson and releases the order for sync. This release order for sync
gets the order details from Siebel and new order is created in Lawson
as per the details of Siebel order. The status of Siebel order is
changed from “On Hold” to “Released for Shipment” as well as the
order number in Siebel is updated to match Lawson order number.
3. Order is shipped in Lawson When order is shipped in Lawson, the status of corresponding order in
Siebel is changed from “Released for Shipment” to “Shipped” and the
corresponding record is removed from Pending Order table in Lawson.
Business Work
HTTP/LOGAN_CGI
Lawson 7.3
DesignEngine
Process er
TRA
TIBCO Adapter for Active Database For publish and subscribe access to data records in a relational
database (Lawson Oracle Database)
TIBCO Adapter for Siebel For publish and subscribe access to BO/BC in Siebel 7.5 server.
9
TIBCO Deployment and Operations Guide for <Project Name>
TIBCO Administration Server and GUI Monitoring, users and systems management, provides configuration
info to BW process engines and adapters at runtime
TRA and TIBCO Microagent TRA = TIBCO Hawk agent, responsible for sending Hawk messages
to TIBCO Admin Server; TIBCO Micro Agent is responsible for
collecting local machine information and send to TRA.
Table 3 Databases
10
TIBCO Deployment and Operations Guide for <Project Name>
3 Deployment Architecture
Prior to deploying the “Quote To Cash” service, the following components must be in place:
The EAI machines as well as Siebel and Lawson application servers used in DEV, TEST and PROD environment are
as follows:
A complete inventory of items needed to deploy the component or service along with their source location. This
inventory must include everything required for deployment except the prerequisites listed in the previous section.
The Sales Order Service deployable artifacts include 2 TIBCO Business Works EAR files, a database script, 3 hawk
rulebases, and a JAVA jar file.
11
TIBCO Deployment and Operations Guide for <Project Name>
12
TIBCO Deployment and Operations Guide for <Project Name>
13
TIBCO Deployment and Operations Guide for <Project Name>
4 Deployment Instructions
Describe what needs to be deployed, and in what sequence. Provide additional details as needed. Explicitly indicate
dependencies on prior steps. During deployment the actual values should be updated so that the document reflects the
as-deployed application/service.
The following table outlines the deployment steps for the Sales Order Service:
3 Deploy Hawk Rulebase Host selected for BW processes. 1 and 2 Hawk Config File
Files [enter hostname] Changes as
Order_collectore.hrb, shown in section
order_notification.hrb,
SAP_ADAPTER
4 Start the Business 1, 2, 3 None
Works processes
Deployed via steps 1
and 2
5 Etc…
14
TIBCO Deployment and Operations Guide for <Project Name>
etc.
To verify proper installation, use the Administrator and verify that the Business Works processes are running normally.
15
TIBCO Deployment and Operations Guide for <Project Name>
5 Monitoring
In this section the routine monitoring of the application/service should be described. If the monitoring is automatic, the
mechanism should be described. If some form of manual monitoring is required, that should be described as well.
The “Quote To Order” Service is routinely monitored by the Hawk rulebases installed with the service. These rule bases
will report errors and warnings to the EAI administrators via emails.
16
TIBCO Deployment and Operations Guide for <Project Name>
6 Operating Procedures
In addition to what is described in this section, make sure to include in this section a description of all TIBCO Hawk
rules, along with their use, how to configure, and how to manage.
This section should cover start-up and shut down of system, as well as any other required operational procedures
(generate reports, logs, auditory, exception handling, error recovery, etc.), and build tools if necessary.
There are two kinds of operational procedures that will need to be managed by the EAI support staff. One is the TIBCO
infrastructure support tasks, and the other is the application support tasks.
In addition to start/stop during regular maintenance windows, EAI support staffs can scan the system log files generated
by different TIBCO processes for errors/warnings through the TIBCO Admin GUI, and troubleshoot problems when
TIBCO Hawk-managed TIBCO components cannot recover from errors by themselves.
For application specific operational procedures, the EAI staffs’ responsibilities are limited to the auxiliary supporting role
to the application team itself. These responsibilities are usually limited to run daily queries against the log DB to
generate reports, and facilitate and validate resending data upon request.
Make sure that the following processes are running as Windows services on the active node of the cluster. In case of
any service not running, start them in the following order.
The above components are registered as Microsoft Cluster Services and hence should be controlled by Microsoft
Cluster Server Administrator.
On the active node, bring all the TIBCO resources “offline” in the following order:
17
TIBCO Deployment and Operations Guide for <Project Name>
Important Note: Please make sure that TIBCO Administrator Server should be the LAST service to be taken
offline.
TIBCO processes can be stopped individually by executing the individual stop scripts or can be killed using
scripts ‘pskill.exe’ located in “s:\eaiphase1\utils” (as s:\eaiphase1\pskill.exe pid).
The publishing table used by TIBCO ADB agent should be monitored for the growth and should be cleaned periodically,
as appropriate.
TIBCO.P_MICTIBORDP
TIBCO.P_WHSHIPMENT
Change request after production go-live involves the following migration procedures:
Schedule a production down time for change and update. This is usually done within
the pre-scheduled normal maintenance window.
Stop all the running deployed services using the maintenance shutdown procedure.
Migrate TIBCO repository to PROD.
Restart all the services using startup procedures. Start the services in the correct
order.
Migration must performed by project administrators, not operators.
18
TIBCO Deployment and Operations Guide for <Project Name>
7 Troubleshooting
Details the troubleshooting steps and procedures for support group of the application/service.
19
TIBCO Deployment and Operations Guide for <Project Name>
20
TIBCO Deployment and Operations Guide for <Project Name>
8 Support Information
Person1
Person 2
Person 3
Etc…
21
TIBCO Deployment and Operations Guide for <Project Name>
22
TIBCO Deployment and Operations Guide for <Project Name>
Named
Contacts
Administrator
Assigned
Named TBD
Contacts
When you are logged into the system, you can use the main screen (shown below) to create a new service request or
review the status of requests already in progress.
23
TIBCO Deployment and Operations Guide for <Project Name>
The Company licensing contract provides a specific type of maintenance support, including a specified number of
contacts who may represent the company. The ‘named contacts’ are managed by a company administrator. Refer to
the TIBCO Support section for currently defined administrator and named contacts.
24
TIBCO Deployment and Operations Guide for <Project Name>
Support, Americas, Asia-Pacific, EMEA’, Rev 1.5, dated August 31, 2001, for details and guidelines for support
operations.
25