Navigation: Sterling B2B Integrator
Navigation: Sterling B2B Integrator
Navigation
Version 5.2
Sterling B2B Integrator
Navigation
Version 5.2
Note
Before using this information and the product it supports, read the information in “Notices” on page 35.
Copyright
This edition applies to Version 5 Release 2 of Sterling B2B Integrator and to all subsequent releases and
modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2000, 2012.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. User Interface . . . . . . . 1 Advanced Search . . . . . . . . . . . . 23
Data Flows Search . . . . . . . . . . . . 24
Chapter 2. Accessing the User Interface 3 Communication Session Records Search . . . . . 25
Correlation Search . . . . . . . . . . . . 26
Log In and Out . . . . . . . . . . . . . 3
Portlet-Specific Search . . . . . . . . . . . 28
Troubleshoot a Failed User Login . . . . . . . 3
Lock Out Parameter . . . . . . . . . . . . 4
Edit the Lock Out Parameter . . . . . . . . 4 Chapter 9. Associated External
Applications . . . . . . . . . . . . 29
Chapter 3. Admin Console . . . . . . . 5 Access the Map Editor. . . . . . . . . . . 30
Portlet View Pane. . . . . . . . . . . . . 5 Access the Graphical Process Modeler . . . . . 30
Procedure Page . . . . . . . . . . . . . 6 Access the AS2 Edition . . . . . . . . . . 31
Menus . . . . . . . . . . . . . . . . 7 Access the MESA Developer Studio . . . . . . 31
Wizard Pages and Navigation Buttons . . . . . 11
Chapter 10. Help Links and Tools . . . 33
Chapter 4. Icons. . . . . . . . . . . 13 Online Documentation Library . . . . . . . . 33
Chapter 8. Searches . . . . . . . . . 21
Basic Search and List Search . . . . . . . . . 21
The IBM Sterling B2B Integrator UI enables you to create, configure, and manage
your operations by steering you toward the activities that you must undertake.
The system provides access to files, business processes, Web templates, services,
and product features according to permissions assigned to your user account by
the system administrator. Thus, the activities that you can perform and the sections
of the UI you have access to depend on the permissions assigned. In general,
however, the UI enables the creation and management of:
v User accounts and permissions
v Trading partner profiles
v B2B packaging and communications definitions
v Translation maps (using the Map Editor)
v Process definitions (business process models)
v Reports
v Trading partners
v Online forms (Web templates).
After IBM Sterling B2B Integrator is installed, your system administrator creates
your user account and assigns user permissions related to using the various system
components. Before accessing IBM Sterling B2B Integrator for the first time, contact
your system administrator to obtain:
v IBM Sterling B2B Integrator UI URL for the log in page
v Your User ID
v Your Password
Procedure
1. Navigate to theIBM Sterling B2B Integrator Login page.
2. Enter your User ID.
3. Enter your Password.
4. Click Sign In. If the Login page is displayed again, this indicates that your
system administrator requires you to create a new password the first time you
log in, for security reasons. Enter a new password in the corresponding fields,
and click Sign In again. The Admin Console pane is displayed.
Note: If your User ID or password or both do not work, contact your system
administrator.
What to do next
To log out click Logout in the top right-hand corner of the page. This ends your
session and displays the Login Page.
Note: Close additional windows, for example, SQL Manager, before you click
Logout.
CAUTION:
Make changes to the ui.properties.in file and not the ui.properties file. If you
make changes to the ui.properties file, and restart the system, the changes you
made to the ui.properties file are overwritten by the ui.properties.in file.
The ConsecFailedAttempts parameter controls the user lock out behavior for:
v IBM Sterling B2B Integrator Administration Menu
v FTP Server Adapter
v SSH/SFTP Server Adapter (for SFTP and SCP protocols)
v MBI (Mailbox Browser Interface)
Procedure
1. Stop IBM Sterling B2B Integrator.
2. Navigate to the installation directory.
3. Navigate to the bin directory.
4. Navigate to the properties directory.
5. Locate the ui.properties.in.
6. Using a text editor, open ui.properties.in.
7. Locate the ConsecFailedAttempts= 0 entry.
8. Highlight and change 0 to the new number of login attempts.
9. Save the ui.properties.in file under the same name in the same location.
10. Run the setupfiles script.
11. Restart IBM Sterling B2B Integrator. The changes you made in the
ui.properties.in file are applied to the ui.properties file and are applied to
all user accounts.
The Admin Console pane is your access point to all the standard IBM Sterling B2B
Integrator features. The UI uses a dashboard design that enables the display of
additional optional panes that are available with other IBM Sterling B2B Integrator
applications. The Operations option provides access to system administration
information, including system troubleshooting, performance tuning, system logs,
and license information.
For purposes of exploring the interface, this documentation assumes that your
interface contains all the standard menu options and that the Admin Console pane
is your entry point to the system.
Procedure Page
Procedure pages are the typical pages used in the Admin Console pane, as well as
the home page pane for the AS2 edition, to enable you to complete necessary
activities, such as configuring services and adapters, creating trading partner
profiles, creating reports, and searching for specific information.
The following figure shows the standard parts of the interface pages:
Related concepts:
“Menus”
Menus
The menus in the IBM Sterling B2B Integrator Dashboard interface work in the
same manner to provide access to the different components of IBM Sterling B2B
Integrator.
The following figure displays a typical menu with the parts labeled:
Some primary headings have secondary headings under them, providing access to
another tier of menu options. The following menu shows a primary heading,
Trading Partner and a secondary heading, Document Envelopes. Both these
headings can be expanded by clicking the corresponding arrow:
The following table describes the primary heading menu options of the
Administration Menu because they relate to specific tasks. Remember that some of
the menu options illustrated and described in this document may not be displayed
in your interface, depending on the permissions assigned in your user account by
the administrator who created it.
For information about the specific activities you can perform from a given page,
see the page information (Side Help) on the corresponding page in the interface.
Wizards present fields in sets on a progressive series of interface pages. The fields
are used to collect information on configuration, such as a trading profile. Each of
the wizard pages, which progress in a logical order, comprises a set of fields and
navigation buttons. After you enter the data for the first set of fields in a page, you
click a navigation button, such as Next, to progress to the next page. This process
continues until you complete the steps involved in a given task. For example,
when you select Business Processes > Manager from the Administration Menu,
the Business Process Manager page is displayed. By clicking Go! adjacent to the
words Create Process Definition you start the related wizard page flow, in this
case, the Business Process flow.
The first page in the Business Process wizard requires you to enter the relevant
information and therefore presents a set of navigation and task buttons that you
must use to navigate within the wizard and eventually save the required data.
All the wizard pages in IBM Sterling B2B Integrator use navigation and task
buttons in the same manner, as shown in the following figure:
In this example, the Back button is inactive because this is the first page of a
wizard. The Save button is inactive because you have not yet reached a point in
the configuration at which you can save the data. Similarly, on the last page of a
wizard, the Next button is inactive. To complete a configuration, click Finish. The
system displays Finish and not Save in the last page of a wizard.
As you progress through the various procedures in the IBM Sterling B2B Integrator
wizards, you may find that you have to confirm or change the settings you entered
in a previous page. The Back and Next buttons enable you to navigate freely
among the pages in the flow, while saving the data you entered. At any time, you
can click Cancel to exit the wizard without saving new or modified data.
When you click Finish to complete a configuration, IBM Sterling B2B Integrator
displays a message indicating that the system is updated with the information, and
a Return button. Clicking Return displays the page from which you initiated the
wizard.
The system also displays the Return button on pages that enable you to view a list
or table of information, such as user account names or trading partner profiles, or
detailed information accessed through a link or table. Clicking Return always exits
the current page and displays the page from which you navigated to the
information.
Icon Description
Customize pane or customize portlet displays the Customize pane
for the appropriate tab or the Customize portlet pane for the
portlet.
Home displays the Admin Console Home page (from the
Administration menu).
Site Map displays a site map of the component you are working
in.
Support displays information about how to get technical
support.
Help opens a separate window to display the Online
Documentation Library, where you can access all of the product
documentation.
News indicates a message posted by an administrator.
Copy, click to copy the selected item in the table or list, such as
a trading partner profile.
Clear removes a corresponding selection from a list or table
display.
No security indicates that the item or service is not configured
with security settings.
Add, adds a configuration (such as a trading partner) or value
(such as a schedule exclusion value).
Tree view displays a hierarchical view in a separate window of
the indicated item, such as service types.
List view displays a list view in a separate window of the
indicated item, such as service types.
Filter limits search or selection criteria to the data you enter.
Related concepts:
Chapter 7, “Filter and Group Selection Fields,” on page 19
In the Admin Console pane, these fields are indicated by colored text for field
names.
The following figure shows the required fields in the Admin Console pane:
Note: Within some applications the asterisks (*) indicates required fields.
In some pages, the format for the date fields is not provided. If you are not sure,
enter the date in the MM/DD/YYYY format. If the format you have used is
incorrect, when you try to progress to the next step in the procedure or attempt to
save the information, IBM Sterling B2B Integrator displays a system message with
instructions about the required format.
Note: Your system administrator may have set up a custom format for Date and
Time. If so, they can provide you with the necessary instructions.
Enter time values in the following HH:MM format. In search fields that contain
boxes for entering both a calendar date and a time, if you enter a date, you must
also enter the time and if you enter the time, you must also enter a date.
To use a filter field, type the complete word, partial word, or phrase in the field
and click the filter icon . IBM Sterling B2B Integrator displays only options
that match your filter criteria in the available options list. You can enter new filter
criteria and repeat the process as many times as required. Each time you filter the
display, the list displays only the entries that match your most recent filter request.
To restore the entire contents of the list, clear the filter field and click the filter
icon.
Group selection fields enable you to select or remove options, either individually
or in groups. The left pane contains the available options. The right pane contains
The IBM Sterling B2B Integrator interface enables you to search for nearly all the
entities related to your use of the system, from system processes to sets of data
used to regulate or enable processes. For example, you can search for:
v Active, archived, and restored business processes
v Trading partner profiles and related data such as identities, transport, and
packaging information, contracts, and code lists
v Documents processed
v Service activity information and service configurations
v Transaction information
v Interchange information
v Standards information
v Schedules
v Maps
v Resources
v User accounts.
For information about the procedure for searching a specific entity, see the
appropriate topic in the online documentation library.
Generally, any page in the Admin Console that enables you to enter and save
information, such as a trading profile, service configuration, or user account, also
enables you to perform basic standard searches and list item searches for the items
you save. Use these searches to find previously saved information that you want to
view or modify.
The following figure shows a page in the Admin Console that enables both a
standard basic search and a list search:
Throughout the interface, many list searches provide search options that help
narrow down the data to be displayed in the list. Both basic searches and list
searches display results in a list. You can select the corresponding item in the list to
view or modify the related data.
Some basic searches enable you to enter more information to narrow down the
search. The following figure shows a basic search feature that enables you to
provide a variety of search parameters to locate a specific service activity record:
The following figure shows the Advanced search options in the expanded menu:
Advanced searches enable you to enter multiple parameters to refine your searches
for information related to your processes. For example, depending on the object of
your search, you can:
v Indicate whether you want IBM Sterling B2B Integrator to search live tables or
restore tables for the desired data you are searching for
v Select date and time ranges
v Specify parameters such as IDs, control numbers, status, related data, and
transport method.
Chapter 8. Searches 23
The following figure shows an example advanced search page, the EDIINT
Transaction Search page, that enables you to select the associated contract, status,
and transport type, and enter a start and end date and time:
To track data flows, from the Administration Menu, select Business Processes >
Advanced Search > Data Flows. The following figure shows the fields you use in
a typical Data Flows search, populated with sample values:
Chapter 8. Searches 25
Correlation Search
IBM Sterling B2B Integrator enables you to enter correlated search criteria to
perform advanced correlation searching.
Correlation searches rely on name-value pairs to define the specific data items the
system searches for. The defined data items are tracking points for business
processes and documents. For example, instead of searching all of IBM Sterling
B2B Integrator for a particular invoice, you can search for that invoice number,
which saves you time.
IBM Sterling B2B Integrator includes a correlation service that you can use to
define a correlation that enables you to search for a specific data item. Correlations
are either reconfigured and come with IBM Sterling B2B Integrator, or are created
when a process runs.
The data for correlations is stored as name-value pair records in the correlation
table in IBM Sterling B2B Integrator. You can search the data using the Correlation
Search option.
The following figure shows the fields you use in a typical correlation search:
The Advanced Search options in the Administration Menu provide specific pages
for performing correlation searches pertaining to EDI interchanges, groups and
transactions, business process specification schemas, and ebXML message flows.
Chapter 8. Searches 27
Portlet-Specific Search
Several of the available Dashboard portlets offer capabilities for performing specific
searches, such as searches for business processes, documents, and Internet searches.
The associated applications enable you to perform a variety of activities that are
crucial to managing your processes using IBM Sterling B2B Integrator, such as
creating data transformation maps and developing custom services. The
applications contain features that integrate with IBM Sterling B2B Integrator,
eliminating complex custom development requirements. For example, the
Graphical Process Modeler (GPM) is an external application associated with IBM
Sterling B2B Integrator. Although you install it separately (through the IBM
Sterling B2B Integrator interface) and use it to create business process models in a
graphical palette, the GPM is designed to work with IBM Sterling B2B Integrator; it
enables you to check your processes into IBM Sterling B2B Integrator from the
GPM interface.
The following table describes the external applications that work together with
IBM Sterling B2B Integrator:
Application Description
Map Editor Offline, Windows-based user interface
application for mapping data translation and
transformation included with IBM Sterling
B2B Integrator. Use it to translate documents
to various data formats, including EDI,
XML, SQL, CII, and others. You include the
appropriate translation map and related
services in your business process models to
perform run-time translation.
Graphical Process Modeler (GPM) Offline, Windows-based graphical interface
tool included with IBM Sterling B2B
Integrator to create and modify business
processes. Converts the graphical
representation of business processes to
well-formed BPML (source code), and saves
you the effort of writing code.
AS2 Edition Optional, self-contained, Web-based
application based on IBM Sterling B2B
Integrator, which can work with or without
the core IBM Sterling B2B Integrator
product. A message management system
enabling the exchange of a variety of
documents between trading partners using
secure AS2 EDIINT technology. The interface
uses familiar IBM Sterling B2B Integrator
conventions for ease of use.
External applications are installed in different ways. All the associated external
applications are displayed in windows that are separate from the IBM Sterling B2B
Integrator interface.
Open the Map Editor using the appropriate installation folder on your client
computer.
Open the GPM by clicking Go! adjacent to Run Graphical Process Modeler in the
Administration Menu. IBM Sterling B2B Integrator installs the GPM on your client
computer.
™
IBM Sterling B2B Integrator uses Java Runtime Environment (JRE) 6.0 to launch
the GPM. For more information about system requirements specific to the GPM,
see System Requirements.
Note: When you launch the GPM, the system will verify if you have the Java 6.0
version installed. If you do not have the correct version of Java Runtime
IBM Sterling B2B Integrator enables users to access the application based on the
permissions associated with the user account, and displays the appropriate
interface.
The AS2 Edition is designed using the IBM Sterling B2B Integrator conventions to
make navigation and conventions familiar. Menus, Help options, and procedure
flows work the same way they do in the IBM Sterling B2B Integrator core product
interface.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Corporation
Armonk, NY 10504-1785
U.S.A.
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
J46A/G4
U.S.A.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
© IBM 2013. Portions of this code are derived from IBM Corp. Sample Programs. ©
Copyright IBM Corp. 2013.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “Copyright and
trademark information” at http://www.ibm.com/legal/copytrade.shtml.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
and/or other countries.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,
Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or
registered trademarks of Intel Corporation or its subsidiaries in the United States
and other countries.
Notices 37
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Java™ and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
Linear Tape-Open, LTO, the LTO Logo, Ultrium and the Ultrium Logo are
trademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.
Other company, product, and service names may be trademarks or service marks
of others.
Product Number:
Printed in USA