You are on page 1of 30

Banner Integration for eProcurement

Administration Guide
Release 8.1
May 2012
Banner, Colleague, PowerCAMPUS, Luminisand Datatelare trademarks of Ellucian or its affiliates and are registered in the U.S. and
other countries. Ellucian, Advance, DegreeWorks, fsaATLAS, Course Signals, SmartCall, Recruiter, MOX, ILP, and WCMS are trademarks of
Ellucian or its affiliates. Other names may be trademarks of their respective owners.
2004-2012 Ellucian. All rights reserved. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or
the information contained herein is prohibited.
Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is
subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question.
In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no
claims that an institution's use of this publication or the software for which it is provided will insure compliance with applicable federal or state
laws, rules, or regulations. Each organization should seek legal, accounting and other similar professional services from competent providers of
the organizations own choosing.
Prepared by: Ellucian
4375 Fair Lakes Court
Fairfax, Virginia 22033
United States of America
Revision History
Publication Date Summary
May 2012 New version that supports Banner Integration for eProcurement 8.1 software.
Cont ent s
Banner Integration for eProcurement 8.1
Administration Guide
May 2012 Banner Integration for eProcurement 8.1 iii
Administration Guide
Contents
Chapter 1 Administrative Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Accessing the Web console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Navigating the home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Connections home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
E-mail Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
eProcurement Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Gateway Connection/Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Service Management home page. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Display configuration details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Display log entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Add a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Update service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Delete service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Display status of services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Manage the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Administer a component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Services deployed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Log Management home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Log4j Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Show System Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
Download Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Component Log (Print/Export View) . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
JMS Service home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Error Manager home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
iv Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Contents
Search criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
Chapter 2 Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
JMS broker failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Messaging component failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Web resource failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
SDK messages and modifications . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Appendix A Adding a Self-Signed SSL Certificate to the IFEP Server . . . . . . . . A-1
May 2012 Banner Integration for eProcurement 8.1 1-1
Administration Guide
Administrative Console
1 Admi ni st r at i ve Consol e
This chapter describes the administrative console tasks that you can perform for Banner
Integration for eProcurement.
Ac c essi ng t he Web c onsol e
Use the following steps to access the Banner Integration for eProcurement administration
Web console:
1. Open a Web browser and access the following URL:
ht t ps: / / [ e- pr oc- ser ver ] : [ por t ] /
2. Click LOGIN.
3. Enter the user name and password:
User: ldiadmin
Password: Set at install time
4. Click Login. The home page is displayed.
Navi gat i ng t he home page
The home page displays the status of registered applications and services. Refer to
Service Management home page on page1-8. for details about the registered
applications and services.
1-2 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
Tabs link to the following administration pages:
Connections home page on page1-3
Service Management home page on page1-8
Log Management home page on page1-14
J MS Service home page on page1-18
Error Manager home page on page1-18
May 2012 Banner Integration for eProcurement 8.1 1-3
Administration Guide
Administrative Console
Connec t i ons home page
The Connections home page provides links for configuring the following connections:
General Configuration
E-Mail Alerts
eProcurement Connection
Gateway Connection/Configuration
Gener al Conf i gur at i on
The General Configuration section allows you to configure the document server
connection. The configuration specifies the server that is hosting the XML objects
(message sets, Enterprise Objects, and XSL transformations) that are used by
eProcurement services at runtime. All configuration values are required.
The document server is configured during the installation. The Tomcat instance designated
as the master is set up as the default document server. However, the document server
objects are configured on each Banner Integration for eProcurement server to support load
balanced configurations. When setting up a Web load balancer for Banner Integration for
eProcurement, administrators should set up the load balance base URL as the base URL of
the server. For example:
ht t p: / / [ host name] : [ por t ]
1-4 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
E-mai l Al er t s
The E-Mail Alerts section allows you to set up e-mail alerts used if any component fails.
Alerts can be set up for the following components:
System
Banner Gateway
ELS - Sync Error Logger
ELS - Sync Logger
Each alert requires an SMTP Hostname, To Address List, From Address, and Alert status
(active or inactive).
Note
Authenticated SMTP is not supported
ePr oc ur ement Connec t i on
Banner Integration for eProcurement provides data synchronization services and point-to-
point communication with SciQuest via HTTP messaging:
The HTTP URL configuration (HTTP URL (Connection >HTTP URL) on
page1-4) specifies the SciQuest server configured to accept data synchronized
messages from Banner. It is also used to configure the protocol adapter that
marshals HTTP-posted data to and from SciQuest.
The IFEP URL is used by SciQuest to connect to Banner via the IFEP server. The
IFEP URL is a point-to-point connection used by SciQuest to post messages to
Banner via IFEP. This URL is preconfigured to the following value:
ht t p: / / [ I FEPHOST] : [ PORT] / sqr el ay. hm
HTTP URL (Connec t i on > HTTP URL)
You can set up the SciQuest connection details on this page. Banner Integration for
eProcurement uses this information to send sync and purchase order/purchase requisition
data to SciQuest.
May 2012 Banner Integration for eProcurement 8.1 1-5
Administration Guide
Administrative Console
The following values are required:
Ot her Pr oper t i es (Connec t i ons > Ot her Pr oper t i es)
The protocol adapter configured for SciQuest can route the message to different end points
based on the message type. This page sets up the default end points for the different types
of synchronization messages. The page also enables higher levels of logging or tracing on
incoming and outgoing messages between Banner Integration for eProcurement and
SciQuest.
All properties that relate to message routing rules are specified with the prefix action.
Example:
property name = act i on. com. sct . Account i ng. Account i ngEl ement
property value = XMLRequest / SCT/ Account i ngEl ement Sync
Name Description
Host Name Name of the SciQuest server.
Port Port number where the server is listening (must be a positive
integer greater than zero).
Protocol Protocol: HTTP or HTTPS.
Server Path Path that specifies where the SciQuest server resides.
Protocol Adapter Default format of the protocol adapter:
com. sct . messagi ng. r el ays. pr ot ocol . ht t p.
sci quest . Sci quest Ht t pPr ot ocol Adapt er
All HTTP communications with SciQuest are predefined in a
particular format. The default protocol adapter is configured to
send messages to SciQuest and process the response to determine
if the post operation was successful. If a sent sync message fails,
the protocol adapter logs the message with the error manager for
troubleshooting.
Warning
Do not change the default.
Username Username for accessing the server.
Password Password for accessing the server.
1-6 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
This syntax translates into the routing rule that specifies that all AccountingElement
sync messages must be sent to SciQuest server at the location
ht t p: / / sci quest / XMLRequest / SCT/ Account i ngEl ement Sync.
A property can be deleted using the Delete link next to the property name and value.
Gat eway Connec t i on/Conf i gur at i on
The Gateway Connection/Configuration section provides the following connections links:
Banner Connection
Message Object Configs
Banner Gateway Processors
Banner Connec t i on (Connec t i ons >Banner Connec t i on)
This link is used to configure the location of the Banner Advanced Queuing server.
Contact a Banner DBA for these credentials if they are not readily available.
Warning
The BannerGateway service requires this information. If you do not have
it, the BannerGateway Service will not start.
1. Enter the following configuration values required by the Banner Advanced Queuing
Connection.
2. Click Save.
Name Description
J DBC Driver (Banner) Default J DBC driver:
or acl e. j dbc. dr i ver . Or acl eDr i ver
Warning
Do not change the default.
J DBC URL (Banner) J DBC URL used to connect to Banner. For example:
j dbc: or acl e: t hi n: @[ host ] : [ por t ] : [ SI D]
Username (Banner) Default Banner user account for messaging: integmgr
Password (Banner) Password for the integmgr account.
May 2012 Banner Integration for eProcurement 8.1 1-7
Administration Guide
Administrative Console
3. Register the subscriber on Banner:
3.1. Log in to Banner as baninst1.
3.2. Substitute i nst anceName with the instance name of the Master/Cluster
Instance in the following procedure:
cal l GB_ADVQ_UTI L. P_ADD_SUBSCRI BER ( ' EVENT_SYNC_TOPI C' ,
' i nst anceName' ) ;
3.3. Execute the procedure.
Message Obj ec t Conf i gs
(Connec t i ons > Message Obj ec t Conf i gs)
This link displays a list of existing Message Object Configs. The Browse button can be
used to locate the XML file that contains the definitions for new message objects on the
local system. The loadxml button can be used to add those objects.
The Details link for an existing message object displays a new window with information
about that message object. The Delete link removes the message object in that row.
1-8 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
This is an example of the generated window:
Banner Gat eway Pr oc essor s
(Connec t i ons > Banner Gat eway Pr oc essor s)
This link displays a list of existing processors. You can use the Browse button to locate the
XML file that contains new processor maps on the local system. You can use the
LoadXML button to load those processors. A single processor name and its values can be
added using the Processor Name and Processor Value fields. You can remove a
processor using the Delete link.
Warning
Make sure the correct version of Banner processors are used for
integration. Refer to the Banner Integration for eProcurement Installation
and Configuration Guide for the correct version of Banner processors.
Ser vi c e Management home page
The Service Management home page is used to add and manage components. The
Component List displays a list of components that have been added.
May 2012 Banner Integration for eProcurement 8.1 1-9
Administration Guide
Administrative Console
Di spl ay c onf i gur at i on det ai l s
Click the View link to display the deployed configuration details in XML that were used
to start a particular component.
Di spl ay l og ent r i es
Click the View Log link to display all log entries for a particular component. For more
information on setting the criteria for searching logs, refer to Log Management home
page on page1-14.
Add a ser vi c e
Click the Service/JNDI link to add a service, application, or J NDI mapping. The link
opens a page where you can enter the following values:
Name Description
Component Name Unique identification of the component that is being added. Once
set, this name cannot be changed.
1-10 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
Updat e ser vi c e
Click the Update link for a component to display the present values for that component.
and update these values. The Appconfig XML file for this component is displayed in a text
area and can be altered in the text area.
Del et e ser vi c e
Click the Delete link for a component to remove that component from the database.
Message Gateway
Name
For services and applications, the Message Gateway is specified
in the configuration file for this field. For example, if the XML
file holds <MessageGat eway i d=BGC t ype=daemon>,
then the Message Gateway name would be BGC.
Metadata Manager
Class
Value that translates resource information into the Appconfig
XML at runtime. Shipped by default, the value assigned to all
services and applications is com. sct . I FEP. met adat a.
AppConf i gMet aDat aManager .
Appconfig Runner Class used to start OpenEAI deployments. Default value is
org.openeai.config.AppConfig.
Type Type of component:
Service The OpenEAI deployment should be a startup
task when the integration server is started.
Application An IFEP deployment requires administrators to
explicitly start these. A component of this type
must be started by an administrator.
TestSuite The application tests the correct installation and
configuration of a product.
Tool A component is being used to assist the product.
Jndi Mapping OpenEAI deployment support to help centralize
J NDI information.
Configuration File File that holds the configuration details for this particular
component. You can browse for the file on your system and
submit it by clicking Save.
Name Description
May 2012 Banner Integration for eProcurement 8.1 1-11
Administration Guide
Administrative Console
Di spl ay st at us of ser vi c es
Click the Service link to display the status of services and applications. The list of added
components includes the name, type, present registered status, and component list details.
If the service or application has begun, the Registered column has a green button. If the
service or application is stopped, the column has a red button.
Component messages can be optionally displayed:
Click the Service Stats (Detailed View) link at the top of the list to include the
component messages.
Click the Service Stats (Short View) link at the top of the list to exclude the
component messages.
Manage t he ser ver
Click the Memory Usage link to display the available free memory.
Admi ni st er a c omponent
Each component in the Component List can be administered using the links given under
Administer Services. Select the component name and the management option in the drop-
down menu. Click Submit to execute the selected option.
You can Start, Stop, or Clear Log for a particular component selected in the drop-down
menu. If you select Start All in the management option, the component name is not used.
All services and applications are started. If you select Stop All, the Component Name is
not used and all services and applications are stopped. The same applies to Clear All Logs.
Ser vi c es depl oyed
The following services are deployed.
Banner P2PConsumer
This service consumes requests, such as creates and queries, from the SRP and processes
them through Banner. This service processes all BudgetAuthorization, PurchaseOrder/
Purchase Requisition create and query requests from the SRP and replies to the SRP. The
log contains information about the direct-request interaction with Banner.
If an external request fails, the log file is a good place to look for details about the failure.
Some of the FATAL messages that can occur include the following:
1-12 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
Failure to connect to a Banner database instance:
2003-11-25 17:30:19,111 FATAL [Thread-8] - Error initializing 'BannerDbPool'
DB Connection pool. Exception: BannerDbPool - Error initializing database
connection. Exception: IO exception: The Network Adapter could not establish the
connection
Failure to connect to the broker on startup:
2003-11-25 17:36:14,537 FATAL [Thread-15] - [C4003]: Error occurred on
connection creation. - caught java.net.ConnectException
javax.jms.JMSException: [C4003]: Error occurred on connection creation. -
caught java.net.ConnectException
Failure to load external documents (for example, Enterprise Object documents):
2003-11-25 17:39:11,381 FATAL [Thread-22] - Error in building: Server returned
HTTP response code: 503 for URL: http://bad.host.com/unmperf/
EnterpriseObjects/org/openeai/Resources/1.0/ControlAreaEO.xml
When the service is successfully started, the following INFO message is written to the log:
2003-11-25 17:41:33,376 INFO [main] - Initialization complete for Application
named: Banner
In addition to these types of messages, two special settings can further define log output.
The additional output occurs under the INFO logging level and relates to Banner API calls
and to metric- and timing-type information. These are controlled through the deployment
descriptor. The following are examples of these types of log entries:
2003-11-19 18:23:49,102 INFO [Thread-72] - QUERY-METRIC: Processed Query
message in 369 milliseconds with a running average time of 369 milliseconds per
message as of 1 messages.
2003-11-19 18:23:50,346 INFO [Thread-73] - SQL: call
dbms_session.modify_package_state(2)
In a production environment, these settings are typically turned off.
Banner AQGat eway
This service produces synchronization messages from Banner to the enterprise (SciQuest
Higher Markets). When Banner publishes a sync message, this service transforms the
published message from a Banner compatible format to an OpenEAI format and publishes
it to the EnterpriseTransRouter (ETR). The ETR then publishes the sync message to the
SciQuestRelayConsumer (SRC). If there is a problem creating the sync message, an error
log message is logged to the EnterpriseLoggingService (ELS). The log contains
information about the sync messages that are published.
Some of the FATAL messages that can occur include the following:
May 2012 Banner Integration for eProcurement 8.1 1-13
Administration Guide
Administrative Console
Failure to connect to a Banner database instance:
2003-11-25 17:30:19,111 FATAL [Thread-8] - Error initializing 'BannerDbPool'
DB Connection pool. Exception: BannerDbPool - Error initializing database
connection. Exception: IO exception: The Network Adapter could not establish the
connection
Failure to connect to the broker on startup:
2003-11-25 17:36:14,537 FATAL [Thread-15] - [C4003]: Error occurred on
connection creation. - caught java.net.ConnectException.
javax.jms.JMSException: [C4003]: Error occurred on connection creation. -
caught java.net.ConnectException
Failure to load external documents (for example, Enterprise Object documents):
2003-11-25 17:39:11,381 FATAL [Thread-22] - Error in building: Server returned
HTTP response code: 503 for URL: http://bad.host.com/unmperf/
EnterpriseObjects/org/openeai/Resources/1.0/ControlAreaEO.xml
When the BannerGateway is successfully started, the following INFO message is written
to the log:
2003-11-25 17:41:33,376 INFO [main] - Initialization complete for Application
named: Banner
The following are examples of these types of log entries:
2003-11-19 18:23:49,102 INFO [Thread-72] - QUERY-METRIC: Processed Query
message in 369 milliseconds with a running average time of 369 milliseconds per
message as of 1 messages.
2003-11-19 18:23:50,346 INFO [Thread-73] - SQL: call
dbms_session.modify_package_state(2)
The following elements are components of the BannerAQGateway.
*-RelayConsumer
The *-RelayConsumer (*RC) consumes synchronization messages, translates them to an
external format, and communicates them to the external system. If synchronization
messages seem to be missing from an external application, the *RC log is a good place to
look for more details.
*-RelayProducer
The *-RelayProducer (*RP) consumes point-to-point (P2P) messages, translates them to
an external format, and communicates them to the external system. If P2P messaging seem
to be unresponsive, the *RP log is a good place to look for more details.
1-14 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
EnterpriseTransRouter
The EnterpriseTransRouter (ETR) routes synchronization messages. All synchronization
message producers publish synchronizations to a single topic. The ETR monitors this
topic and routes each message to the appropriate topics that are affected by the message.
The ETR is one step in the process of producing synchronization messages. If messages
are not being routed to the enterprise applications, it is a good place to look for more
details.
When the ETR is successfully started, INFO messages similar to those for the
BannerGateway are written to the log.
When determining whether to route or not route, ETR produces information messages
such as the following:
2003-12-01 15:52:56,942 INFO [Thread-355] - Application HigherMarkets
doesn't want to be routed to based on the contents of the PurchaseRequisition-
Create message. Will continue to the next application.
2003-12-01 15:52:57,234 INFO [Thread-355] - Message Number: 21 - Routed
PurchaseRequisition message to Gateway: TestSuiteApplication
When initialization is complete, the following INFO message is produced:
2003-11-21 16:02:06,362 INFO [main] - Initialization complete for Application
named: EnterpriseTransRouter
Log Management home page
The Log Management home page provides links for modifying the following entities:
Log4j Configuration
Show System Log
Download Logs (txt)
Component Log (Print/Export View)
May 2012 Banner Integration for eProcurement 8.1 1-15
Administration Guide
Administrative Console
Log4j Conf i gur at i on
Log Management > Log4j Configuration links to a page that allows for micro-level log
management. Text can be entered in the space allocated to store the configuration. Use this
page to change the logging level of the running services and applications. All loggers are
split into four major categories:
Category Description
Sungardhe Log l og4j . l ogger . com. sct . messagi ng=WARN
l og4j . l ogger . com. sct . messagi ng. app. AppConf i gWr a
pper =ERROR
l og4j . l ogger . com. sct . messagi ng. app. j ndi =ERROR
The above are required to change the logging level of messaging
support. In most cases modify the level of l og4j . l ogger . com.
sct . messagi ng to INFO for messaging audit.
OPENEAI Log l og4j . l ogger . or g. openeai =WARN
l og4j . l ogger . openeai Obj Type=WARN
Change the above to INFO for more details.
1-16 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
Show Syst em Log
Log Management > Show System Log links to a page that shows the system log details.
You can set the search criteria using the following options:
Application Specific
Loggers
l og4j . l ogger . Banner =WARN
l og4j . l ogger . Ent er pr i seLoggi ngSer vi ce=WARN
l og4j . l ogger . Ent er pr i seTr ansRout er =WARN
l og4j . l ogger . Er r or Manager =WARN
l og4j . l ogger . Hi gher Mar ket s=WARN
l og4j . l ogger . Sci Quest Rel ayPr oducer =WARN
Message Trace
Activity Loggers
l og4j . l ogger . com. sct . messagi ng. gat eways. Messagi
ngObj ect =I NFO
The above is the message trace logger. Disable it by setting it to
WARN in production environment.
Search Criteria Description
Sort By Most Recent When this check box is selected, the most recent log entries
appear at the top of the search results.
Log Level Level of severity included in the search. Log entries are classified
in ascending order of seriousness:
Debug
Info
Warn
Error
Fatal
When a level is selected, all log entries of that level and above are
included in the search. For example, if the Warn radio button is
selected, then the log entries of type Warn, Error, and Fatal are
retrieved.
Date & Time Date range for searching logs. By default, log entries of the last
five days are included.
Category Description
May 2012 Banner Integration for eProcurement 8.1 1-17
Administration Guide
Administrative Console
After you change criteria, click Submit to search.
Dow nl oad Logs
Log Management > Download Logs (txt) allows the administrators to download the text
logs for the eProcurement middleware server. The following graphic shows the
configuration of the Log4J appender that controls this log. The log files available for
download have a maximum size of 5MB.
Component Log (Pr i nt /Ex por t Vi ew )
Log Management > Component Log (Print/Export View) allows administrators to
generate a printable component log report that can be used for internal and external audit
or troubleshooting purposes.
Max messages per
page
Maximum number of log entries displayed per page. Default is 30.
Thread Name All log entries from a particular thread can be gathered by
specifying the thread name in this field.
Search Criteria Description
Log4j . appender . t xt =or g. apache. l og4j . Fi l eAppender
l og4j . appender . t xt . Fi l e=. . / webapps/ l di messagi ng/ l di 4web. l og
l og4j . appender . t xt . Append=t r ue
l og4j . appender . t xt . l ayout =or g. apache. l og4j . Pat t er nLayout
l og4j . appender . t xt . l ayout . Conver si onPat t er n=[ %X{component name}]
%- 4d{I SO8601} %- 5p [ %t ]
%3x - %m%n
l og4j . appender . t xt . MaxFi l eSi ze=5000KB
l og4j . appender . t xt . MaxBackupI ndex=1
1-18 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
J MS Ser vi c e home page
The J MS Services home page displays the status of the Banner AQ Message server:
A green light indicates the server is up and running.
A red light indicates the messaging queue is not currently working.
JMS Console links to the ActiveMQ interface. This tool can help you troubleshoot broker
issues.
Er r or Manager home page
The Error Manager helps diagnose and resolve problems with synchronization messages.
The Enterprise Logging Service logs synchronization messages to the eProcurement
database when the ETR or the SRC application fails to publish sync messages to the
destinations as configured. The Error Manager displays the sync messages that are not
published due to network, resource, or credential issues. The Error Manager provides tools
to republish these messages after suitable adjustments are made.
Sear ch c r i t er i a
You can search for sync messages that were not published to the destination systems
because of resource or messaging errors. Search criteria are based on the error log time
and sync message status. All logged sync messages are set to an OPEN status. When a
message is marked as 'Publish,' the status of the sync message is changed to PENDING.
The Error Manager processes only those messages in a pending state. Messages in a
pending state are processed every sixty seconds. After publishing the sync message, the
message state is changed to CLOSED, and the message is no longer displayed in the
Search Results list.
May 2012 Banner Integration for eProcurement 8.1 1-19
Administration Guide
Administrative Console
Note
If the published message encounters an error during the publishing
process, the ELS service relogs the message as a new error message,
and the old message is deleted. The cause of the sync error may vary, but
the Enterprise Object contains the same information.
Sear ch r esul t s
The results obtained from the search criteria are displayed on the Results page.
The Search Results panel provides information that pertains to the application that
published the sync error message and the date when the error was logged. Each search
result has a Details link that displays more details for the error message and the Enterprise
Object associated with the error message.
1-20 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Administrative Console
For users with an administrator role, the search results include Publish All and Delete All
options capable of doing the associated action on returned search results.
May 2012 Banner Integration for eProcurement 8.1 2-1
Administration Guide
Failover
2 Fai l over
BannerIntegration for eProcurement provides high availability and guaranteed delivery
of messages.High availability includes the redundant deployment of components to
provide complete failover. Redundant deployment ensures that no component can create a
single point of failure. With high availability during planned outages (such as upgrades) or
unplanned outages (such as disk failures), the system continues to function normally.
One positive effect of this type of deployment is load balancing, the ability to distribute
the workload among the redundant components. Banner Integration for eProcurement is
installed and configured to implement failover by default. Administrators, however, must
be aware of some important information to ensure that failover is running properly.
J MS br oker f ai l over
Banner Integration for eProcurement can use any J MS-compliant provider, but comes with
the Active MQ. The Banner Integration for eProcurement installation automatically
configures MQ for failover and load balancing. During installation, the administrator
chooses one machine to be the master. This machine then becomes the master broker in
an MQ broker cluster. As a cluster, the MQ broker instances ensure that all messages
received by either broker is delivered, so that if one broker goes down, the other broker
delivers the waiting messages. With this setup, an administrator can bring down one
broker, perhaps to backup the broker store, and Banner Integration for eProcurement
continues to function normally.
Warning
The messaging components cannot be started properly unless the
configured broker is running. If the broker is down, all components
continue to function, but cannot be restarted. This design ensures that a
clean startup will not occur in an incomplete system.
Messagi ng c omponent f ai l over
Banner Integration for eProcurement messaging components are designed for failover.
Therefore, all messaging components are deployed redundantly across multiple host
machines ensuring that no component is a single point of failure. This ensures that any
component can be brought down and the solution continues to function normally. The
installation configures and deploys Banner Integration for eProcurement with these
failover features. Because multiple brokers are deployed, each component must connect to
each broker on startup to ensure that all required resources are available. All brokers in the
cluster must be started before any messaging component is started.
2-2 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Failover
In the case of Pub/Sub consumers, each redundant component subscribes to a topic for
message retrieval. Because there are multiple brokers, the message is delivered to each
broker and, subsequently, each redundant messaging component. As a result, Pub/Sub
messaging components have a built-in mechanism to ensure that only one redundant
component processes the message even though all redundant components receive the
message. This mechanism uses a database connection and table. When a message is
received, the component tries to insert the message ID into this table. If another
component is currently processing the message, an SQL exception occurs and the
component goes on to process the next message waiting on the topic. The SQL definition
for this table is as follows:
CREATE TABLE T_PROCESSED_MESSAGE (
PROCESSED_MESSAGE_I D VARCHAR2( 1000) NOT NULL,
MESSAGE_SERI ES VARCHAR2( 1000) NULL,
CREATE_USER VARCHAR2( 30) NOT NULL,
CREATE_DATE DATE NOT NULL,
CONSTRAI NT PK_PROCESSED_MESSAGE
PRI MARY KEY ( PROCESSED_MESSAGE_I D)
) ;
CREATE OR REPLACE TRI GGER BI R_PROCESSED_MESSAGE
BEFORE I NSERT
ON T_PROCESSED_MESSAGE
FOR EACH ROW
begi n
: NEW. CREATE_USER : = user ;
: NEW. CREATE_DATE : = sysdat e;
end;
/
Web r esour c e f ai l over
Banner Integration for eProcurement requires access to several different types of Web
resources. These resources are typically served by a Tomcat application server.
Because of the nature of HTTP resources, failover for these components is more
complicated. The components that connect to Web resources must be configured to
connect to a URL, and this URL must point to a single piece of hardware. Typically, an
institution uses a load balancing router for this purpose.
Load balancing hardware is designed to be fault tolerant. There are actually multiple
Tomcat instances serving the same resources, but to the components that use them, they
look like a single resource. For more information on how to set up the load balancing
hardware, consult the manufacturers product information.
May 2012 Banner Integration for eProcurement 8.1 2-3
Administration Guide
Failover
SDK messages and modi f i c at i ons
For the initial installation, refer to the AppGen for Banner Integration for eProcurement
Installation and Configuration Guide.
To deploy or update messaging, perform the following steps for every server in the Banner
Integration for eProcurement cluster:
1. Run AppGen.
2. Change to the I FEP_HOME directory.
3. Stop the Tomcat server.
4. Execute the following command in the I FEP_HOME directory:
. / depl oyMessagi ng
This command updates the jars and messaging sets required for Banner Integration for
eProcurement to function correctly.
2-4 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Failover
May 2012 Banner Integration for eProcurement 8.1 A-1
Administration Guide
Adding a Self-Signed SSL Certificate to the IFEP Server
A Addi ng a Sel f -Si gned
SSL Cer t i f i c at e t o t he
I FEP Ser ver
Use the following information to create a self-service SSL certification to the Banner
Integration for eProcurement server.
1. Enter: cd I FEP_HOME/ cer t s/ t omcat .
2. Execute the following command, substituting <ldieproc>with the full host name:
%J AVA_HOME%\ bi n\ keyt ool - genkey - al i as l di epr oc - keyal g RSA -
keyst or e l ocal host . cer
3. Enter the unknowns and any other information requested in the command output:
Enter keystore password: changeit
What is your first and last name?
[Unknown]: www.sct.com (Replace with complete hostname)
What is the name of your organizational unit?
[Unknown]:
What is the name of your organization?
[Unknown]:
What is the name of your City or Locality?
[Unknown]:
What is the name of your State or Province?
[Unknown]:
What is the two-letter country code for this unit?
[Unknown]:
Is CN=www.sct.com, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown,
C=Unknown correct?
[no]: yes
A-2 Banner Integration for eProcurement 8.1 May 2012
Administration Guide
Adding a Self-Signed SSL Certificate to the IFEP Server
Enter key password for <tomcat>
(RETURN if same as keystore password)
4. Reboot the IFEP server.

You might also like