Part III –Collaboration Manager

Part III includes chapters that cover each of the components that are available within the Collaboration Manager module.

 

Ch 7 Import Console

To centrally store and manage product information, a master catalog is created in WebSphere Product Center. The following sections describe each step that is performed to collect the data from various sources and to assemble the information into organized catalog structures.


Import overview

An import is a feed that inputs data from an external source into WebSphere Product Center. An import is first configured manually and can then be run on a scheduled or on-demand basis. WebSphere Product Center allows the import of multiple types of data (items, binary files, category trees, categorization mappings, etc.) from multiple sources to accomplish multiple purposes (update, replace, delete).

The Import Console is the tool that is used to create catalogs from various sources of data. The import console acts as the switchboard for importing all data into WebSphere Product Center. From here you can view, modify and create data that is being fed into WebSphere Product Center.

To create an import, user needs to define and perform the numerous data and file feeds into WebSphere Product Center. The import console presents a list of feeds that have been created.

To access the import console, use the menu path Collaboration Manager > Imports > Import Console.

Figure 7.1 - Import console

Customizing the console view

The console can be customized to sort or hide columns. The settings are saved to the user’s profile. To customize the view of the Catalog Console, do the following.

1. In the top right corner of the Catalog console, click the configure button . The Configure table appears in a popup window.

2. To sort a column, make a selection in the Sort Column. Only one selection can be made.

3. To hide a field, make a selection in the Hide column. Multiple selections can be made.

4. In the "Other Options" table, set the sorting order to display in ascending or descending order and set the number of rows to display per page.

5. To save the customized settings, click Save. The Catalog Console appears with the new customized settings.

Sorting a list of imports

Console Columns

The following table lists each of the columns of the Import Console.

Type

Icon indicating the type of import, refer to the previous section "Import Console Icons" for a list of import types

Name

The name of the import

Retrieved Files

A drop-down selection of source files that have been retrieved into the WebSphere Product Center document store

Retrieve

Execute the manual loading of the data source into WebSphere Product Center

Load

Uploads the data source into a specified catalog

Semantics

Indicates if the import is of type Update, Replace or Delete.

Source

The name of the source file used

File Spec/Import Script

Name of the file spec or import script used

Map

Click on the icon to view or edit the file to catalog mapping

Ctlg/Cat Tree

The catalog and catalog tree used for the import

ACG

The ACG used for the import


Import Preparation

Before an import is created in the Import Console, there are several steps to perform in preparation of an import. This section describes the following import preparation tasks before an import is created and scheduled:

Obtain data source

Before data can be imported into WebSphere Product Center, the source files must be situated in an accessible directory or FTP site. Review the data file to ensure the most accurate product information and that the format uses one of the following data sources available for import into WebSphere Product Center:

Note: The source file must conform to one of the formats mentioned in the list above before continuing with the next step.

Make data available

Check that the source data file is available for access into WebSphere Product Center. If the files are to be uploaded through FTP, make sure that the proper permissions are applied to the FTP site. Contact the appropriate team members, as needed.

Review data file

Analyze the source data file and make note on the file structure, fields, and associated attributes. This information is required to build the File Spec in the next step.

Create required objects to setup an import

There are several objects that are required to be present prior to setting up an import. Many of these objects can be created during the setup of an import, but it may be easier to have these tasks completed beforehand. The following objects are the minimum requirements to set up an import:

File spec A file spec is required in order to configure an import. Please refer to the Data Model Manager section on creating a file spec.
Primary spec A Primary Spec is required in order to configure the format of the WebSphere Product Center catalog structure. This may include specs for Hierarchies. Refer to the Data Model Manager section on creating a primary spec.
Spec mapping In order to properly route data to the correct catalogs, the file spec needs to be mapped to the right catalog/hierarchies. Please refer to the Data Model Manager section on mapping specs.
Create catalog using primary spec Once the file, catalog, and other associated objects have been created and mapped, the next step is to create the catalog. Please refer to the section on Product Manager for more information on creating a catalog.

Define Import Feed

After setting up the items for an import as described in the section "Import preparation" , define how the external file information is going to be populated into WebSphere Product Center catalogs. The definition of an import feed is done by creating a new import.

Figure 7.2 - New Import wizard

Create a new import

Use the menu path Collaboration Manager> Imports > New Import or click New in the Import Console. The New Import wizard appears. Complete each step of the Create Import wizard to create an import.

1. Import Name

Enter a name for the import and click the Next button.

An import name must be provided to distinguish from other names. Duplicates are not allowed. The feed name chosen should be comprehensive.

For example, the names "Item Attributes from Mainframe" or "Images for Catalog X" are good names.

2. Select Access Control Group

Choose Access Control Group from the Select Access Control Group drop-down menu. If Access Control Group does not exist, create one by clicking on NEWbutton.

3. Select Data Import Type

Choose a data import type from the drop-down menu and click the Select button. The following values are available for selection:

Binary Feed   Feed of binary files for each item in a catalog (i.e. images, docs and PDFs).
Hierarchy feed   Hierarchy feed includes a hierarchy that is designed to organize all of the items within the catalog for easy browsing.
Item feed   Item feed contains the essential descriptive information that describes each catalog item to be found within the product catalog.
Item to category map feed   Item to category map feed maps items that already exist in a catalog to a hierarchy that will be uploaded as part of the incoming data. This feed can also be used to upload a file that contains new items and the appropriate categorization information directly into a new catalog. The hierarchy will be updated whenever any new category is added.

4. Select Data Import Semantics

Choose an import feed semantic and click the Select button.

The import feed semantics specifies how the incoming file will affect the items already found in the destination catalog.

Update   Updates the item found in the catalog with the item that is specified in the incoming file and adds items to the catalog that only exists in the incoming file.
Replace   Replaces the content of the current catalog with the content of the incoming file.
Delete   Deletes from the catalog any items specified in the incoming file.

5. Select Data Source

Choose a data source name and click the Select button. A data source defines which data source is to be imported into WebSphere Product Center.

In this step, a user can modify or create a new data source. To create a new data source, click "New" and to edit a data source, click the Edit button.

The steps of creating a new data source include specifying a name for the data source and selecting a data source type. The data source name should be as descriptive as possible. Data source types include the following options:

6. Select Character Set

The next step is to select the encoding of the incoming file from the "Select charset" drop-down menu. Select the character set that matches the one used in the incoming file. This is particularly important when incoming files contain characters outside the 26 letters of the alphabet and the 10 digits. The system default is "Cp1252: Windows Latin-1".

Note: Failure to select the appropriate character set may result in problems during import.

7. Select File specification

The file specification defines the attributes and format of the incoming file. Either choose an existing file specification from the drop-down menu or click New to create a new file specification.

8. Select Catalog

The catalog defines where the data will be imported into WebSphere Product Center. Either select an existing catalog or click New to create a new catalog.

9. Select File to Catalog Mapping

Either select an existing mapping or click New to create a new mapping. To create a new mapping (or modify an existing mapping) use the drop-down selection field to match each field in the file specification (left column) to match a field in the catalog (right column). For advanced manipulations (field concatenation, string manipulations, etc.) click on the Expression Editor button.

10. Select a Catalog Import Script

A simple catalog import script is always generated by default. Either select the default generated script or click New to create a new import script.

11. Select Approving Authority

The final step in creating an import feed is to select an approving authority. This optional step allows the selection of a user who is given the responsibility to review the import job and approve it before it is generated. Select which user should be notified when then feed is initiated.

12. Return to Import Console

At this point, the import feed is configured and the last step is to run the import job to populate the catalog where it can be managed within WebSphere Product Center.


Run Import

Once an import has been defined, the import can be manually scheduled or set to run on demand. Before running an import, the external data source file must first be obtained.

Load file into Document store

On the Import Console, there are two GO buttons for each import feed, one in the Retrieve column and the other in the Load column.

To retrieve the external incoming file, click on the GO button in the Retrieve column of the appropriate import feed. The retrieved column will show "No files for feed." When the files are fetched, a selection of files appears in a drop-down menu.

Once the file has been fetched, it is placed into the Document Store. The Document Store is a repository for all files and data that are moved into or out of WebSphere Product Center. This provides the user with an opportunity to preview all files before they are actually uploaded into WebSphere Product Center.

Start import

The second of the two GO buttons on the Import Console will upload the fetched file from the document store into the specified catalog. From the Load column, click the GO Button.

An alert can be configured to notify, via email or through the Alert module of the Home Page that the load has completed. If an approving authority has been assigned, the feed can be approved or rejected through the user's Home Page Alert module inter. The product information can then be managed through the Product Manager Module.


Managing imports

Modifying an import

To modify an import, it is best to delete the old import and create a new one. For example, there is no method of selecting a new file spec. To use a different file spec, create a new import and select the appropriate file spec.

Deleting an import

A feed can be deleted by clicking on the delete button in the first column of every feed.

Note: Deleting a feed is not reversible. A dialog box will appear to verify the deletion of an import feed.


Binary Feeds

Binary files must be compressed before they are imported into WebSphere Product Center. For example, to import a group of images, a file of *.zip is created in a source directory. Once the compressed file is retrieved, it is stored into WebSphere Product Center's Document Store and then uncompressed into the docstore's directory /public_html/ctg_files. Binary files can include such files as jpg, gif, or pdf.

Figure 7. 4 - Uploading binary feeds

Create a binary import

The following steps create an import feed for binary files.

Use the menu path, Collaboration Manager > Imports > Import Console, the Import Console appears. Click New to access the "New Import" wizard . Complete each step of the wizard.

1. Import Name – Enter a name for the binary feed

2. Select Access Control Group – Select an access control group used for the feed.

3. Select import type – Select "Binary feed"

4. Select import semantics – Select "Update"

5. Select data source – Select a data source for the binary feed or create a new one

Keep path from zip archive Y or N

Always select No. All image files are stored in the "public_html/ctg_files", in the Document Store. If you preserve the path of the archive, the images will extract into the wrong directory.

6. Enter docstore path

Leave empty and click Next. The docstore path is assumed and there is not need to enter a path. When the application unzips the file, it will place all images into the ctg_files directory.

7. Select action on file name and path

Accept the default Neither - This option is sued the case of the images from downstream systems. In this case there is no problem with the images files being either uppercase/lowercase.

8. Select Approving Authority – Select a user to approve the import, if necessary.

This completes the creation of the Import Feed. The next step is to upload the compressed file into WebSphere Product Center.

Upload Compressed File

After the binary import feed is defined, the next step is to retrieve the compressed file into WebSphere Product Center. The feed should show "No files for feed" in the "Retrieve Files" column.

1. From the Import Console, locate the newly created feed and click Go! from the Retrieve column.

2. Click Browse, select the compressed file, and then click Upload. The path to the zip file appears in the "File" field.

3. Return to the Import Console or to view the file in the Document Store, select the Document Store from Collaboration Manager menu.

All uploaded files are stored in a sub-directory of the organization's "feed_files" directory, which is named after the name of the import feed.

Once the compressed file is uploaded to the Document Store, it is uncompressed.

Uncompress Binary Files

1. From the import console, click Go! from the "Load" column. WebSphere Product Center, unzips the images into the ctg_files directory.

2. To check the status of the process load, click the "check the status of the update" hyperlink.

When the load is completed, the Schedule Status Information shows the status "Completed Running". Click the document store hyperlink to view all of the uncompressed binary files.


Lookup table imports

An existing import table can be imported from an external data source into WebSphere Product Center. Creating an import for a lookup table is similar to creating any other import using the "New Import" wizard.

Create a lookup table import

From the Import Console, click New. The "New Import" wizard appears.

1. Select a unique feed name.

2. Select an Access Control Group.

3. Select the data type "item feed".

4. Select the relevant feed semantics, data source, and file specification

5. From the "Select Catalog" field, select the lookup table to be imported

6. Define the file to lookup table mapping

7. Select the import script. Create a new import script if necessary.

8. Select the approving authority, if necessary.

9. Save the new import feed.

10. Run the import

Ch 8 Export Console

WebSphere Product Center allows you to create catalogs customized for any internal or external destination. The catalogs can be automatically published to customers, partners, and print catalogs, or to a corporate website. The following sections describe the method used to distribute or publish product information to any destination.


Export overview

Exports are created to distribute or publish product information to the customers (internal or external). With WebSphere Product Center's flexible architecture, businesses can connect to multiple marketplaces with multiple catalogs, using a single repository of data.

Using WebSphere Product Center's Export Console, the following tasks are performed:

 Export Console Columns

Type

Icon indicating the type of syndication, refer to Export Console Icons section

Name

Name of the Export job

Catalog Items

The name of the catalog and group of items that are to by syndicated

Version

The version of the catalog that is to be syndicated

Mapping

View/edit the mapping characteristics between the catalog spec and the destination spec

Destination Spec

Name of the destination spec

File Type

The name of the Catalog Export script used and parameter values set.

Hierarchy

The name of the hierarchy used, click to view or edit.

Job Info

Detailed information on the syndication job. View the job's run time, status, warnings, and a list of generated files.

Approval

If approval is needed before syndication, the status appears in this column as accepted or rejected

Alerts

If an alert has been configured for the syndication, it appears in this column

Destination

The syndication's destination mode


Prepare catalog for export

The following sections describe the items that are needed before a catalog can be setup for an export. Although several items can be performed through the wizard for setting up an export, it is beneficial to have the items prepared beforehand to simplify the setup process.

Destination Spec

When an export job is created in WebSphere Product Center, a destination spec is needed to define the exact requirements of the destination file. Similar to a file spec or primary spec, each node of the destination spec is defined with attributes. During the data export, the destination spec will generate a file that adheres to a set of predefined requirements.

Item Selection

The Export component of the Data Model Manager allows for the basic selections of a group of items from a catalog to be pushed to a specific destination. The basic selection includes the catalog, catalog version, and the hierarchy used for the export. 

Catalog to Destination Map

The Catalog to Destination Specification map is similar to the File to Catalog Map, used for imports, in that it instructs WebSphere Product Center with how the fields in the catalog should be routed. The fields in a catalog are mapped to the fields of the destination file. This mapping must occur for a successful syndication.

Hierarchy

As per the explanation given in the Import chapter, hierarchies are stored separately from catalogs within WebSphere Product Center. This allows the user to view and eventually export a catalog using a hierarchy of their choice.

Destination Mode

A catalog, once exported, can be sent out to multiple destinations for purposes of approval and/or verification. The distribution component of syndication allows a user to select the destinations to where the catalog is to be sent. The catalog can be sent out in the form of an email (in the body of the email) or FTP.


Create Export

When creating a new export, the "Create New Export" wizard walks through each step for setting up an export, which helps to simplify the complete process.

During each step in the wizard, the following functional buttons are available for use:

 

Edit

 

Create New

 

Select

 

Continues to the next step

 

Returns to the Export console

Setting up an Export

Use the menu path Collaboration Manager > Export > New Export or from the Export Console click the New button, the Destination Upload wizard appears Complete each step of the wizard driven GUI. 

1. Export Name - Enter a new name for the export and click Next. Create a name that is unique and can be easily identified.

2. Select a Destination Specification - The specification itself dictates the format, length and necessity of each field of data that will eventually be exported. If needed, the user can click the appropriate buttons to create or edit a destination specification.

3. Select Catalog - Specify the catalog to be exported by selecting any of the previously created catalogs from the "Select Catalog" drop-down field. Typically, the catalog selected for export is targeted to a specific customer. That is, it will only include information that is specific to particular customers.

This information might include data such as pricing, contract effective dates and customer product IDs. Using the catalog to destination specification map, WebSphere Product Center can export data from either a master or child catalog.

4. Select Version - Select the Catalog Version Not only does the user have the opportunity to select the catalog to be exported, they can also select the version of a catalog. WebSphere Product Center automatically saves every version of each catalog that is uploaded and modified. It also creates a new version for a catalog when a feed or an export is run. This feature allows a user to export an older version of the same catalog in the event that, for example, some items were added to a catalog that are not supposed to be sent to a particular customer.

5. Select Group of Items - Select a basic selection of a group of items from an entire catalog to be pushed to a specific destination. The basic selection includes the catalog, catalog version, and the hierarchy used for syndication. The item selections can be viewed and created through the Item Selection console of the Product Manager module. An example of a selection maybe used to export only a particular product line.

6. Select Hierarchy - This feature allows a user to export each item's categorization within one of the selected catalog's hierarchies. Although selecting the hierarchy itself will determine which categories will be exported, it does not ensure that the categories themselves are sent with the output file. The categories themselves must be included as part of this export's catalog export script. The catalog export script requires configuration of an authorized user and the output file will not include categories unless it has been written into the catalog export script.

7. Select Syndication Type - By selecting the export type, WebSphere Product Center provides the user with the option of selecting whether to syndicate an entire catalog or simply an update to the catalog. This allows the export of catalog variances.

If a "differences" export type is selected, select a second version of the catalog to generate a delta against. Differences types include:

8. Select Catalog to Destination Mapping - Either select an existing mapping or click New to create a new mapping. To create a new mapping (or modify an existing mapping), use the drop-down fields to match each field in the catalog (left column) to match a field in the destination spec (right column).

9. Select charset - Select a Character set to choose the encoding of the outgoing file. This is particularly important when outgoing file contain characters outside the 26 letters of the alphabet and the 10 digits.

The default is Cp1252:Windows Latin-1.

10. Select Distribution - Distributions are designed to permit the notification of individuals inside and outside of the application itself. A distribution is similar to an email alias. Building these sorts of distributions lists within WebSphere Product Center makes it possible to reach people outside of WebSphere Product Center. If needed, create a new distribution mode.

11. Select a Catalog Export Script - Catalog Export scripts are used during an export. They can be used to perform advanced on-the-fly operations on the data held in the catalog before it is actually exported to an output file. The modifications made to the content through the scripting engine at the time of export and are not applied to the catalog but rather simply applied to the output file, as a one-time content modification.

Similar to an import, the export to an external target file can take two forms: either the fields in the catalog map on a one-to-one basis to the external target file, or the fields in the catalog require some modifications before they are exported into the external target file.

All exports require the use of a script. Contrary to imports, selecting a script during export is a mandatory step.

12. Select Approving Authority - Allows the selection of a user who has the responsibility of reviewing the export job and when the job is executed. Choose from a list of system users and click Select.

13. Return to Syndication Console

Once all of the above steps are completed, a message box appears notifying the addition of the export profile to the Export console. Click the back arrow button at the bottom o f the screen to return to the Export Console. The export job is now set up and ready for generation.


Run an export

After the export job is configured, it can be generated manually or automatically through the Scheduler. If the job is dependent on approval, the approving authority must accept the job before it can be generated.

Manually run an export

To manually execute an export job, do the following:

1. Use the menu path Collaboration Manager > Export > Export Console to view a list of all export jobs.

2. Find the export job to execute. Click on the checkbox located in the leftmost column.

3. Click the GO button. If an approving authority has been set, the export job starts but the file is not exported to the destination until it has been authorized. The status of the export job can be viewed through the Scheduler's Jobs Console, within the Data Model Manager module.

Verifying export progress

While an export is running, clicking on the green animated icon allows a user to review the progress of the export.  A progress bar is shown to indicate how much of the export has completed. To interrupt an export, click on the red icon on the left of the export; a confirmation dialog box is displayed.

When an export is completed, the progress bar disappears. A summary is offered to include details such as a hyperlink to all the files that were created during the export and errors/warnings that occurred during the export.


Export management

View Output

When an export is generated, it is saved to the Document Store before it is sent to the defined destination. If desired, the results of the generated files can be viewed and printed.

Viewing export results

To view the output results, do the following:

1. From the Export Console, click the status button from the Job Info column, the Schedule Status Information table appears.

2. Click the hyperlink in the Return Value column, the Task Approval Information interface appears with a list of generated files. Each file is hyperlinked and when clicked, a new window opens displaying the file details.

Review export file

Standard exports produce one file entitled 'catalog.out'. This file can be reviewed and saved to a local or network drive.

Reviewing an export file

Approve Output

If an approving authority has been assigned to an export job, it must be approved before the job can be executed. From the approver's My Task List, click the Pending Approval icon in the Approval column, the Task Approval Information interface appears. Accept or Reject the export job and provide a reason.

View and Modify Export Components

From the Export console screen, the user is permitted to view and/or modify virtually every component of an export job. The user is allowed to view the list of customers that the catalog is to be sent to, the catalog to marketplace specification mapping and the dates and times that the catalog is scheduled for syndication. The user can modify the catalog being exported by clicking on the catalog name.

Export status

To view the status of an export job, click the schedule button in the Job Info column, the Schedule Status Information appears. Then click the View Details button in the Jobs Information column. 

Once a catalog has been executed for export, a user can check the following job details:

Reviewing export status

To review the job status of an export job, do the following:

Delete exports

Export jobs can be created and deleted as needed. 

Deleting an export

 To delete an export job, do the following:

1. From the Export Console, find the syndication job to delete. Click on the checkbox located in the leftmost column.

2. Click the Delete button and the export job is deleted from the console.


Troubleshooting exports

If an import or an export runs into problems, hyperlinks to Errors or Warnings are displayed on the job summary.

Sometimes, a job will fail to complete to run and instead of a summary, an error will be displayed. Record precisely in which circumstances the problem occurred and take note of the error message for further analysis.

Ch 9 Queues and messaging

The new Queues feature was implemented to maintain multiple queue types and multiple messaging protocols. A queue serves as a gateway to handle inbound and outbound messaging with external sources/destinations, including EAI platforms and web servers.

Note: Continue to the section "Implementing Messaging Framework" for information on setting up a Messaging Framework.

For reference, the following terms are defined:

With the new queue feature, messages can be used as part of a process, in that when jobs are imported or exported, status messages can be sent to all required parties.


Queues Console

Accessing the Queue Console

Use the menu path Collaboration Manager > Queues > Queue Console, the Queue Console displays.

View Queue Details

To view the details of a queue click on the Queue Name and the "Queue Detail" screen appears. The following information is provided:

View Message in Queue

The Queue Console has a column called Messages with a hyperlink to the number of messages that have been received by a queue. Click on the number of messages to view the contents of the message.

Search for message in a Queue

1. To search for a message in a queue, use the menu path Collaboration Manager > Queues > Message Console. The Queue Messages Search screen appears.

2. Select a value for the following fields

3. Click Search and the results appear in the Queue Messages table below.

Creating a Queue

1. Use the menu path Collaboration Manager > Queues > New Queue

2. Enter the required information:

Queue Name: Enter a name for the queue

Description: Enter a description for the queue

Protocol: Select from the list of messaging protocols that will be used to tie the external source to/from the queue.

Script: Select from a list of pre-written scripts that can be run to route messages to/from the queue. A typical message for destinations/sources include:


Implementing messaging framework

The implementation of WebSphere Product Center's messaging framework allows for integration with the following target EAI platforms:

The platform of choice should provide a reliable transport mechanism and a consistent interface for programs to communicate with each other across different systems or platforms.

WebSphere Product Center's messaging framework was designed to support the following process:

WebSphere Product Center ships with the ability to parse and create XML documents, and to send messages to, and collect messages from an EAI platform queue. A message is defined as an XML document provided by an external source. All this functionality is accessible to the WebSphere Product Center scripting engine. To enable interaction between WebSphere Product Center and the EAI platform adapter, it is necessary to install scripts that take advantage of this functionality.

WebSphere Product Center supports queues, which are a construct for serving as a receiving and transmission point for messaging. The WebSphere Product Center queue serves as a gateway to handle inbound and outbound messaging with external sources/destinations and each queue is supported by WebSphere Product Center Scripting Operations.

A queue provides the following functionality:

Enables setting up a message transmission protocol to tie the external message source to/from the queue and provides the following message transmission protocols:

Runs a script to route messages to/from the queue. Typical message destinations/sources include -

The following list depicts the framework for the messaging functionality:

In order for this process to function, a messaging framework must be built.

Building a messaging framework

The following process outlines a suggested method of integrating an EAI platform framework. This process may be customized based on specific requirements.

Receiving a message

This section describes the process of receiving a message containing an item set, including providing acknowledgement messages upon receipt. The two processes, Setup and Runtime support the process of receiving a message. The process is generic and applicable to most purposes.

Setup

1. A technical business process analyst creates the following:

 2. A technical business process analyst builds an inbound Queue containing a script. The script supports three functions - message receipt, message body parsing, and routing.

Message Receipt

The message receipt section of the script supports the following functionality:

Message Body Parsing

The message body parsing section of the script supports the following functionality:

Message Routing

The routing section of the script supports the following functionality:

Adds/modifies/deletes items in the item set from the target catalog

  • A technical business process analyst sets up an Acknowledgement Workflow for sending a receipt acknowledgement message. The workflow has the following functionality:
  • Checks out new record from Message Catalog into a collaboration area in a step in the Acknowledgement Workflow.
  • A next step in the Acknowledgement Workflow sends an acknowledgement message to the message source containing the message ID, sender ID, datetime, and any required commands by the message source (e.g.: Received).
  • A next step in the Acknowledgement Workflow checks in the message catalog record.

Runtime

Once the setup has been properly configured, the following runtime events should occur.

1. Queue receives message via message receipt section of queue script

2. Message receipt section of queue script parses message body to obtain message type, message ID, and sender ID

3. Message receipt section of queue script creates record in Message Catalog containing message type, message ID, sender ID, and datetime

4. Message receipt section of queue script checks out new record from Message Catalog into a collaboration area in a step in the Acknowledgement Workflow.

5. A next step in the Acknowledgement Workflow sends an acknowledgement message to the message source containing the message ID, sender ID, datetime, and any required commands by the message source (e.g.: Received).

6. A next step in the Acknowledgement Workflow checks in the message catalog record.

7. Message body parsing section of queue script parses the message body (using a new script operation cited below) per the map name and the target catalog name to render an item set

8. Routing section of queue script adds/modifies/deletes items in the item set from the target catalog using existing script operations for catalog adds/modifies/deletes

Create WebSphere Product Center inbound/outbound queue

WebSphere Product Center inbound and outbound queues are created using the Queue Console. Before any queue is created, a Trigger script must be created from the Scripts Console. The trigger scripts appear in the drop-down Trigger Script Path field of the New Queue screen.

1. In the Queue Console, click New.

2. In the Queue Detail screen, enter a queue name, description; select a protocol and a trigger script path. The trigger script is created in the Scripts Console of type "Message Queue Processor".

3. Click Save.


Messaging Script Operations

WebSphere Product Center script operations provide a flexible way to write WebSphere Product Center script applications with defining capabilities in the arguments of each script operations. The following script operations identified in this section are used to support the messaging feature supported by WebSphere Product Center using MQ or JMS. These methods allow the import and export of messages from an external queue.

Note: The scripting operations listed in this section are subject to change. Refer to the Script Sandbox for the most up-to-date script operations.

MQ Scripting Operations

When creating a script application, the script operation mqGetQueueMgr returns a handler to MQQueueManager, with that handle, multiple MQ operations can be made before calling mqDisconnect to release the handle.

mqGetQueueMgr

mqDisconnect

mqSendTextMsg

Note: If trying to send a reply to a given message using mqSendReply, an error will return if the mqSendTextMsg is used. To avoid this, use mqSendTextMsgWithReply

mqSendTextMsgWithReply

mqGetTextFromMsg

mqGetReceivedMsg

Note: When messages are retrieved, they are removed from the queue. Unless specifying a message ID, the first message in the queue is obtained.

 mqSendReply

mqSendReplyWithStatus

Note: Only one status value can be used. 

mqGetXMLMessageContent

Note: Use this method to pares incoming messages.

 mqGetResponseToMsg

mqGetMessageDiagnostics

mqGetMessageId

mqGetReceivedMsgByMessageID

JMS Script Operations

When creating a script application, the script operation jmsGetConnectionFactory returns a handler to QueueConnectionFactory, with that handle, multiple JMS operations can be made before calling jmsDisconnect to release the handle.

jmsGetContext

jmsGetConnectionFactory

jmsGetMQConnectionFactory

jmsGetQueueByName

jmsGetQueueConnection

jmsGetQueueSession

jmsDisconnect

jmsCreateTextMsg

jmsSendMsg

jmsReceiveMsgFromQueue

jmsGetTextFromMsg

jmsGetMessageID

jmsGetMessageCorrelationID

jmsGetMessageProperties

jmsSendMsgToQueue

jmsSetMessageText


Web Services

Web Service Console

The Web Service console provides users the ability to create and manage web services by used of SOAP_HTTP. A WSDL script can be written to define the service and an implementation script is created to control how the service is executed. 

Web Service console columns

 The Web Service console contains the following columns.

Name Name of the Web Service. Click on the name to view the details of the web service.
Description Brief description used to describe the Web Service
Protocol Currently, SOAP_HTTP is the only available protocol
Transactions Number of transactions for the service. Click the number to view the transaction or click the Delete button to remove the web service from the console

Managing Web Services

Accessing the Web Service Console

To access the Web Services console, use the menu path Collaboration Manager > Web Services > Web Service Console.

Creating a new web service

Use the menu path: Collaboration Manager > Web Services > New Web Service. The "Web Service Detail" screen appears.

Enter the appropriate information into the following fields:

Web Service Name Enter the name of the web service. This name becomes part of the URL of the SOAP service. It must not contain any white space. For example,
Web Service Description Enter a description for the web service.
Protocol The protocol used for the web service. Currently, SOAP over HTTP is the only supported protocol. The default value is “SOAP_HTTP”.
URL

Provides the URL where the service may be accessed. This field is automatically populated after the web service has been saved.

 

WSDL URL The URL where the WSDL for the web service may be accessed. This field is automatically populated after the web service has been saved.
WSDL Enter WSDL for this service. A WSDL document is a description of the interface, URL and protocol of the service in XML format. You must enter this document manually, but we provide a sample WSDL document below. You must enter valid XML for the web service to save successfully.
Implementation script Enter a Trigo script that implements this service. The incoming parameters for the service are available in the array variable "soapParams". The return value for the service must be a String, and can be written to the "out" writer variable. To return a SOAP fault, write the fault code to the "soapFaultCode" writer variable and write the fault message to the "soapFaultMsg" writer variable. A sample implementation script is provided below.
Store requests? If this is checked, Trigo will store the parameters of all incoming requests in the docstore. They will be available from the Transaction Console.
Store replies? If this is checked, Trigo will store the content of all responses in the docstore. They will be available from the Transaction Console.
Deployed If this is checked, the service will be deployed. Otherwise this service will not be available.

A sample implementation script and WSDL document

The following design of the sample implementation script and WSDL document checks the number of parameters of the incoming SOAP request. If there are exactly four parameters, it returns a string listing those parameters. If there are more or less than four parameters, it throws a SOAP fault.

Implementation Script

nParams = soapParams.size();
if (nParams != 4)
  {
    soapFaultCode.writeln("WRONG_NUM_PARAMS");
    soapFaultMsg.writeln("Wrong number of parameters.  This service requires 4.  You have " + nParams + " parameters.");
  }
else
  {
    out.writeln("Success.");
    for (i = 0; i < nParams; i++)
    {
      out.writeln("Parameter " + (i + 1) + " is " + soapParams[i]);
    }
  }

WSDL

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://my.trigo-instance.com/soap/services/CheckParams"
                  xmlns="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:apachesoap="http://xml.apache.org/xml-soap"
                  xmlns:impl="http://my.trigo-instance.com/soap/services/CheckParams"
                  xmlns:intf="http://my.trigo-instance.com/soap/services/CheckParams"
                  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
                  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <wsdl:message name="invokeRequest">
    <wsdl:part name="param1" type="xsd:string"/>
    <wsdl:part name="param2" type="xsd:string"/>
    <wsdl:part name="param3" type="xsd:string"/>
    <wsdl:part name="param4" type="xsd:string"/>
  </wsdl:message>
  <wsdl:message name="invokeResponse">
    <wsdl:part name="invokeReturn" type="xsd:string"/>
  </wsdl:message>
  <wsdl:portType name="CheckParams">
    <wsdl:operation name="invoke" parameterOrder="param1 param2 param3 param4">
      <wsdl:input message="intf:invokeRequest" name="invokeRequest"/>
      <wsdl:output message="intf:invokeResponse" name="invokeResponse"/>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="CheckParamsSoapBinding" type="intf:CheckParams">
    <wsdlsoap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="invoke">
      <wsdlsoap:operation soapAction=""/>
      <wsdl:input name="invokeRequest">
        <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
                       namespace="http://DefaultNamespace"
                       use="encoded"/>
      </wsdl:input>
      <wsdl:output name="invokeResponse">
        <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
                       namespace="http://my.trigo-instance.com/soap/services/CheckParams"
                       use="encoded"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="CheckParamsService">
    <wsdl:port binding="intf:CheckParamsSoapBinding"
               name="CheckParams">
      <wsdlsoap:address location="http://my.trigo-instance.com/soap/services/CheckParams"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

Managing transactions

Accessing the Transaction Console

To search for all web services transaction, view the Transaction Console using the menu path Collaboration Manager > Web Services > Transaction Console.

Viewing a web service transaction

1. From the Transaction Console, view the list of transactions from the Web Service Transactions table.

2. Click on the View button from the Response or Request columns. The transaction details appear in a new browser window.

Searching a web service transaction

1. From the Transaction Console, select a date range from the Arrival Date From and Arrival Date to fields of the "Web Service Transaction Search" table.

2. Click the Search button. All transaction results appear in the "Web Service Transactions" table below the search table.

Ch 10 - Document Store

The Document Store is the area within WebSphere Product Center where every incoming and every outgoing file is stored. This includes import scripts, reports, and specification files. For auditing purposes, search capabilities are provided.

Every file that goes through WebSphere Product Center is copied and stored into the Document Store. Thus, the Document Store can be utilized as a backup engine.

The Document Store is structured in that the GUI provides hyperlinks to files that are stored on the Oracle database. Essentially, they are pointers to the location of the files.

Through the document store, users can manage files in the following manner:

Figure 10.1 document store

Accessing the Document Store

The document store can be accessed through the following toolbar path, Collaboration Manager > Document Store.

The document store is presented with a structure of file directories. Click on any folder/sub-folder to view the files located within the directory. The full document path is displayed.

Viewing Document Details

The Document Store provides details on each document. This includes audit log information which shows when and who has accessed the document.

View Document Contents

Control Access to Documents

The Document Store allows the control of access to a document. An Access Control Group (ACG) can be selected, or a new ACG can be created.

1. To control which user group can access a document, click the lock and key button next to the document name. The Docstore Access Details table appears.

2. If an ACG has already been created, select an ACG from the drop-down field. Otherwise, click New to create a new ACG. A user group can be controlled to create, view, or delete the document.

3. Once the ACG is selected, click Save to keep the control setting for the document.

Delete Documents

The Document Store allows the deletion of files through the document store, Click on the garbage can icon next to the name of the document to delete it from the document store.

Note! Once the file is deleted, it cannot be restored! A dialog box appears to confirm the delete. Click Cancel to cancel the delete operation.

Ch 11 - Data Sources

A data source is a WebSphere Product Center Entity that defines how data will be imported into WebSphere Product Center. External data can originate from various locations or databases and be accessed in a number of different ways. From example you might want to import data from a database, a file found on an FTP server, or data from your local file system. Each of these options requires specific configuration parameters in order to access the data. A Data Source encapsulates these parameters, and lets them be manipulated as a single named entity so that once the source details are setup it can be re-used throughout the product.

Creating a data source

To create a new data source click on the New button from the Data Source console. (existing data sources can also be modified using the edit tool button). The "Create Data Source" wizard appears. Complete each step of the wizard.

1. Data Source - Enter a name for the data source. 

2.  Select Data Source Type -  The steps of creating a new data source include specifying a name for the data source. As in the case of an import, the name should be as explanatory as possible. Ex: "Upload through Browser" or "Retrieve by FTP". After selecting a data source type, click Select.

Possible data source types include the following:

Have Websphere Product Center retrieve via FTP
By selecting this option, the user is telling WebSphere Product Center to connect to a specified FTP server to retrieve the data file to be uploaded. WebSphere Product Center requires the user to specify the following additional information so that it can connect to the FTP server and retrieve the correct file: the server address and port number, the username and password, the file name and directory in which it is located.

Take from Document Store (including FTP)
The Document Store is an area of WebSphere Product Center that stores every single document that has either been imported into WebSphere Product Center or that has been generated by WebSphere Product Center for export. It is therefore possible to fetch files from that document store into a feed.

Updated via Web Browser
This option is used to manually import a file into WebSphere Product Center using the "Browse" function to explore and select a file residing on your hard disk or on any network accessible drives.

3. Provide details about the data source - The details to provide regarding the data source depends on the selection made in Step 2.

If data source type selected is... Additional information required
Have Websphere Product Center retrieve via FTP Enter values for the following:
  • Server address
  • Server port
  • Username
  • Password
  • Filename
  • Directory
Take from Document Store (including FTP) Enter the full path to the document in the Websphere Product Center Document Store
Updated via Web Browser No additional details are required.

4. After completing each step of the "Create Data Source "wizard, return to the Data Console.

Editing a data source

Deleting a data source

Ch 12 - Routing

Distributions are designed to permit the notification of individuals inside and outside of the application itself. A distribution is similar to an email alias. Building these sorts of distributions lists within WebSphere Product Center makes it possible to reach people outside of WebSphere Product Center.

The Routing Console displays all of the previously created distributions stored within WebSphere Product Center. From here, a user can modify or delete any current distributions and create new distributions or distribution group. A distribution group is simply a named group of previously built distributions.


Distributions

A catalog, once exported, can be sent out to multiple destinations for purposes of approval and/or verification. The distribution component of exports allows a user to select the destinations to where the catalog is to be sent. The catalog can be sent out in the form of an email (in the body of the email) or ftp. Essentially, a distribution is also referred to as the destination mode.

Create New Distribution

To create a new distribution, do the following:

1. Distribution Name - Enter a name for the distribution and click Next.

2.  Select Distribution type - Choose a distribution type and click Next. Select from one of the following choices:

3. Distribution Mode - Depending on the distribution type selected, enter the required information as needed. Click Save to store the distribution settings.

Create Routing Group

2. Enter a name for the distribution in the Group Name field.

3. Select a distribution names from the available list of distributions and click add or remove to create the group.

4. Click Save to store the distribution group setting. The new distribution group appears in the Routing Console.

Delete Distribution