x

Located at the top pane for each category, the buttons in the following table enable the user to quickly access the reference object and perform certain actions.

Button	Description
	Adds another entry of the particular object (on this page, it adds a new partner).
	Deletes a selected object and all its references (on this page, it deletes a partner).
	Allows you to view and edit the properties of the selected object (most objects are open in the View & Edit mode by default upon selection).
	Adds any metadata value for the particular business object. This enables TPM extension into an application specific domain.
	Creates a copy of the selected object (on this page, it creates a copy of the selected partner with all its information)

x

Located at the bottom of the left pane for each category, the pagination tool allows you to quickly navigate through the pages of all defined components (for example, partners, routes, systems, and so on). You can click the Refresh button to refresh the current page you are viewing.

If a large number of components are defined, you can go to next page by clicking the right arrow button. To navigate to the last page of the set, click the End button. By default, the first 25 objects of the set are displayed based on the latest edited information.

x

A Trading Partner definition requires a definition of partner information, system, and Partner Systems which ties in the given system to a given partner. The Partner System is critical, since a single system can be shared by multiple partners for message processing.

The following list represents general components which have to be created for a full Partner profile.

• Partner. This component contains general partner information as defined on the Partner Information screen.
• Partner System. This component establishes a defined Partner System and Messages which can be processed by a given partner on a given system. This is defined on the Partner screen under Partner Systems.
• System. System definition available for multiple partners to share. This is defined on the Systems screen. For more information, see Systems.

To add a trading partner using the iWay TPM web console:

1. Select the Partners tab in the iWay TPM web console, and click Create to add a new partner.

   The Create New Partner pane opens, as shown in the following image.

   

2. Enter the information for the trading partner you are creating.

   The following table lists and describes the fields in the Create New Partner screen.

   Field	Description
   Partner Name	This is the unique name given for the partner.
   Site Code	This is the site code of the partner.
   BU Name	Name of the Business Unit.
   Organization Address 1	First line of the address.
   Organization Address 2	Second line of the address.
   City	Name of the city.
   Postal Code	Postal code of the city.
   State	State (if applicable).
   Country	Country of the partner.
   Province	Province (if applicable).
   Description	Partner function description.
   Last Updated By	This field is used to show when the partner was last updated.
   Parent Partner	Select the parent partner if applicable. Parent partners can carry the main information, and child partners can have specific information. For example, the Sunkis parent partner has main contacts while the Sunkis Canada child partner has regional contacts.

3. Click Save Partner Details when you are finished

   The new trading partner is added, as shown in the following image.

   

   To edit an existing trading partner, select the trading partner on the left, which opens the information on the right. After editing the information, click Save Partner Information.

   To delete an existing trading partner, select the trading partner and click Delete.

4. To associate a trading partner system with the trading partner you just created, select the trading partner in the left pane and click the Partner Systems menu on the right.
5. Click Create to create a new partner system.

   

   Note: You must already have created systems in the Systems tab.

   The Create New Partner System pane opens, as shown in the following image.

   

   Partner system creation enables the linkage of partner and specific system(s) which can process corresponding messages. This is a logical link which is later used by an application at runtime.

6. Enter the information for the trading partner system you are creating and select existing system from the System drop-down list.

   The system drop-down list is populated with available systems that have been created using the Systems facility. As a result, you must define a system before it can be associated with a trading partner.

7. Click Save Partner System Information when you are finished.

   The new trading partner system is added, as shown in the following image.

   

   To edit an existing trading partner system, select the trading partner system and click View & Edit.

   To delete an existing trading partner system, select the trading partner system and click Delete.

8. To associate a set of messages with the trading partner system, select the partner system and click Create in the Partner System Messages pane, as shown in the following image

   

   The Create New Partner System Message pane opens, as shown in the following image. This pane enables the selection of input and output message types, which can be processed by this partner system.

   

9. From the Message Types list on the left, select an available system message to be added and use the provided button navigations to add them to the right side. This associates the specific messages which can be processed by specific partner systems for a specific partner, such creating a Business Channel.
10. Click Save Partner System Message when you are finished.

    You are returned to the Partner Systems pane, as shown in the following image.

    

    Note: The same message can be associated with multiple systems and partners, but based on its unique metadata attributes, it can be processed differently at runtime.

x

This section provides an example of the Partner Information pane that is displayed when a Partner is selected.

The following table lists and describes the fields of the Partner Information pane.

Field	Description
Partner Name	This is the required unique partner name to identify a specific partner.
Site Code	This is the optional site code to be assigned as a partner attribute.
Organization Address 1	Required first line of the partner address.
Organization Address 2	Optional second line of the partner address.
City	Required name of the city or town for the partner address.
Postal Code	Required ZIP or Postal code for the partner address.
State	Optional state (if applicable).
Country	Required country for the partner address.
Province	Optional Province (if applicable).
Description	This is an optional but recommended description of the function of the partner.
Last Updated By	This field indicates the user who last updated the information.
Parent Partner	This is a selection of existing partners which can be assigned as a parent partner. This enables the child partner to store local unique attributes, while the parent partner stores shared attributes for multiple child partners.

x

The Partner Contacts tab is designed to store contact information for a partner. Some uses might include contact information to whom notifications for unprocessed or erroneous transactions are sent. The following image shows a sample partner contact.

The following table lists and describes the fields for the Partner Contact tab.

Field	Description
Contact Name	This is a required, unique contact name.
Primary Contact	You must select either true or false to indicate if this is the main contact.
Auto Notify	Used in message processing logic, select either true or false to identify if the failed messages should or should not always be sent to this contact (recommended setting is false).
Phone	This is the phone number of the contact.
Mobile	This is the mobile phone number of the contact.
Email	This is the email address of the contact, which must be of proper email format.
Address 1	First line of the address of the contact.
Address 2	Second line of the address of the contact.
City	City or town for the address.
Postal Code	ZIP or Postal code for the address.
State	State for the address (if applicable).
Country	Country for the address.
Province	Province for the address (if applicable).
Last Updated By	This field indicates the user who last updated the information.

x

The Partner System tab is designed to store systems and system messages which correspond to a given partner. Note that the system can be either a logical or real resource (such as channel, target, and so on). This view enables the management of systems, which can process assigned messages for a given partner. For example, if a partner has two systems associated with it, where the first system can process messages of type A and the second system can process messages of type B, then at runtime it can be routed to a proper system for processing (for example, sending to a proper internal queue, channel, or adapter target) simply by examining a message and determining its type.

The following image shows a single partner system with three types of messages which can be processed on this system.

The Partner System properties are accessible using the View & Edit button.

The following table lists and describes the fields of the Partner System.

Field	Description
Partner System Name	This is a required and unique partner system name that identifies the partner and system relationship.
Domain	Optional Domain (if applicable).
Code	Optional System Code (if applicable).
System	This is a required selection of existing system as defined under the System pane. The system must be predefined before a partner system relationship can be established.

x

The Partner System Message pane defines a set of messages which can be processed by a given partner system. It also establishes the direction for message processing such as the in and out direction. The values in the Message Type column must be defined prior to the Partner System Message configuration and are selectable from the available messages.

The following image shows two messages which can be processed as input and one message which can be processed as output for a given partner system. A complete relationship between Partner, System, and Message is known as a Business Channel.

x

The Partner Certificate pane is available for backward compatibility with prior versions of iWay TPM. This pane will be deprecated in the next major release. As a result, you are advised to follow iWay Service Manager (iSM) security standards and implement secure communication through Security Providers and an array of secure protocols. Location and pointers to the client specific certificates can be managed through Partner Metadata options. For example, the client may want to manage the certificates in an LDAP or external system, which can be accessed at runtime.

x

To create a trading partner route using the iWay TPM web console:

1. Select the Routes tab at the top of the iWay TPM web console, as shown in the following image.

   

2. Click Create to add a new route.

   The Create New Route pane opens, as shown in the following image.

   

3. Enter the information for the trading partner route you are creating as required.

   The following table lists and describes the fields of the Create New Route pane. An asterisk (*) denotes a required input for the field.

   Field	Description
   Route Name*	This is the unique name for the route.
   From Partner*	This is the initializing partner from which the message is being received.
   Message Format From*	This is the message format to be processed from the initializing partner.
   Channel From*	This is the channel for the initializing partner.
   To Partner*	This is the destination partner to whom the message is sent.
   Message Format To*	This is the message format for the destination partner.
   Channel To*	This is the channel for the destination partner.
   Environment*	This is the environment in which this route exists.
   Route Description	This is an optional description for the route.

4. Click Save Route Information when you are finished.

   The new route is added, as shown in the following image.

   

   To edit an existing trading partner route, select the trading partner route on the left that you wish to edit, and edit its information on the right. Then click Save Route Information.

   To delete an existing trading partner route, select the trading partner route and click Delete.

x

The Route Details tab for the Route enables the user to define a business route relationship between two partners, as shown in the following image.

Top of page

Top of page

x

When sending a message from one system to another, it is likely that the two systems may use different message standards or formats. The application processing the message (the message engine), takes into account the format and converts the message from an inbound format to an outbound format. However, the content of the message might need to be adjusted for specific values. This is where the standard code substitution is used, through the TPT runtime function.

For example, the Product_Code field should be converted from B_001 to BUN before the message can be processed by a receiving system.

The Standards Code Substitution screen is accessible by selecting a specific standard on the left pane, and then clicking on the Code Substitution tab on the right pane. The user can create a new code substitution by clicking Create and providing the necessary fields.

x

A message format is a specific version or a sub-type of a message standard. Message format is used to group specific message types. For example, if message standard is CIDX, then the message format can be CIDX202 (version 2.02). The following diagram illustrates a message format component.

The following image shows the Message Information tab which lists all defined message formats. To add a new message format, click Create and provide a name, description, and an associated standard for the message type.

x

The message type is a specific type of message within the format. For example, Shipnotice is a message type within CIDX202 format associated with CIDX standard. The message type can also be associated with a specific schema to define the structure and validation for the message. The message type values can be used by a processing system to identify which transforms can be used to convert the message before sending it to the destination system. It is also used in conjunction with unique identifiers for partner systems to determine the routing of the message. For more information, see Partner System Message Page.

The following image shows the Message Information tab which lists all the defined message formats.

To add a new message type, click Create under the Message Type pane and provide a message type name, schema name with an optional location, and description. When you are finished, click Save Message Type Information.

x

To create a system using the iWay TPM web console:

1. Select the Systems tab from the iWay TPM web console.

   The System pane is displayed, as shown in the following image.

   

2. Click Create in the upper-left hand corner of the System pane.

   The Create New System pane opens, as shown in the following image.

   

   The Listener Target drop-down menu lists all the available listeners in the iSM environment. The Channel Target drop-down menu lists all the channels in the iSM environment. The Adapter Target drop-down menu lists all the available adapters in the iSM environment.

   Note: All the targets are optional such as enabling a flexible configuration of the application and support for logical systems.

3. Enter the information for the system you are creating.

   The following table lists and describes the fields for the system.

   Field	Description
   System Name	This is the unique name for the system.
   Listener Target	This is the drop-down list of all available listeners.
   Channel Target	This is the drop-down list of all available channels.
   Adapter Target	This is the drop-down list of all available adapters.
   Description	This is a description for the system being created.
   Environment	This is the environment to which this system applies.

4. Click Save System Information

   The new system is added to the list of systems, as shown in the following image.

   

x

The User tab allows administrators to add, delete, and edit other users.

Top of page

x

The Role tab allows administrators to add, delete, and edit roles which can be assigned to the users.

Top of page

x

The Audit tab allows administrators to monitor the user activity. This activity includes the user name, the login status, date/time and IP address. The image below shows the Audit tab.

x

The MetaData tab allows those users with designated rights to manage MetaData nodes for all objects within TPM. This area enables the creation or deletion of Metadata nodes for a given object such as partner. The created metadata is available for all instances of an object, such as centralizing the management. For example, the ReceiverID metadata node created for the partner object will be available for all partners created, but will store different values specific to a given partner.

The following image shows the MetaData management screen.

x

Metadata management is performed in the Administrative tab of the iWay TPM web console. Once the Administrative tab is accessed, the user (with proper permissions) can access the MetaData tab which displays a set of sub-tabs where each tab represents an object (for example, partners, systems, and so on) as shown in the following image.

Each tab contains a proper root node corresponding to the object being defined. For example, in the image above, there is a PARNTER node defined for the Partners tab. The management of metadata is the same for all objects.

There are additional options available for managing extensive lists of metadata. These options include the following buttons:

• Expand All
• Collapse All
• Sorting (Ascending/Descending)

Top of page

Top of page

Top of page

Top of page

x

Metadata nodes are managed by the administrator who has access to the Administration and MetaData tabs. The actual assignment of values to the metadata nodes is done by someone who has access to the specific object and proper edit rights. The user accessing and managing partner information does not require full administration rights.

The examples below uses the PARTNER group folder to demonstrate the process of metadata assignment. The same approach can be followed and used for any other object, such as System, PartnerSystem, an so on.

To assign a value to a specific object, such as partners, navigate to the corresponding tab (for example, Partners). Select a partner and click Metadata.

A metadata data management screen opens, providing access to all metadata nodes available for the selected object. The metadata nodes which contain a value will have the value displayed in blue within the braces ({ }).

To edit the metadata value, right-click on the metadata node and select Edit TPA Node Value as shown in the following image.

The Edit Value window appears, and shows where you can enter or modify the value. The Name and Description fields are non-editable as they require administrative privileges and are managed under the Administration tab.

Once you are done, click Save to save the changes.

After the value has been saved, it will be displayed in blue within the braces ({ }) for the edited node.

After the metadata values have been added to all required nodes, click the Close button (X) to exit the screen. The metadata updates are now available to the application runtime.