User ManualCG Messaging Tracker

Version 1.18.1.1

2018-01-03

Table of Contents1. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2

2. Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2

3. Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2

3.1. Messenger Connections Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2

3.1.1. Create new messaging canal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  4

3.1.2. Editing messaging canal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  7

3.1.3. Connected messengers connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  7

3.1.4. Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  8

3.2. Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  9

Table 1. History

Date Author Detail

2017-09-06 bcouetil New documentation + minor changes

2017-09-05 mperret Ajout d’une fonctionnalité d’appel HTTP et suppression de la librairiejcabi.

2017-08-08 mperret Ajout d’un bouton pour play/pause l’affichage des documents sur le MT +ajout d’icones pour le bouton.

2017-08-07 bcouetil CgElastic init

2017-08-04 kbaouz Redo screen shots on Windows 10

2017-08-02 mperret Affichage d’un field parametré mais vide devient 'Ø' + Si un des 3 fieldsconfigurables existe déja, modifié le champ associé ne redimensionne pasla colonne du field Lors de l’initialisation du MT, le calcul deisVersionValid se fait dans un thread parallèle.

2017-07-25 bcouetil Anomaly Handling improvements

2017-07-21 rabaline Commit the new java code of the anomaly handler

2017-06-30 bcouetil Docs updated to latest design

2017-06-29 helkaiss Masquer la colonne quand aucun champ n’est configuré pour un fielddonné. Ajouter les boutons Dlete et Add dans "documents ConfigurableFields". Mise à jour de la doc "user-manual.adoc" en asciidoc

2017-06-28 bcouetil pom : repository purged on clean + javadoc auto check

2017-05-17 bcouetil Javadoc fixed and javadoc + reporting stages added

1

1. IntroductionThis document describes the functional specification of CG Messaging Tracker functionalities. Itgives in detail the use of this application.

2. PrerequisiteIn order to launch CG Messaging Tracker application, you need to install JRE 1.8 fromhttp://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

3. DescriptionCG Messaging Tracker application helps the user of webMethods to manage the interactionbetween Integration Server’s (IS’s). As we known, the communication between IS’s happen throughBroker Server or Universal Messaging, this application has for purpose to display, publish andsubscribe documents that IS’s received from external application.

The CG Messaging Tracker application provides multiple functionalities:

• Connect to messenger (Broker Server or Universal Messaging)

• Display published and subscribed documents

• Edit content of documents

• Republish or subscribed a document

Each of these functionalities is described in this document.

When the user launches the application, two windows are displayed:

• Messenger Connections Configuration

• CG WebMethods Messaging Tracker (the main window)

3.1. Messenger Connections ConfigurationThe user has access to a list of available messenger’s connections; he can create, edit and connect tomessenger’s connection.

Messenger connections configuration is displayed:

2

• “Available Messengers Connections” area: contains the list of disconnected messengerconnections.

• "Connected Messengers Connections” area: contains the list of connected messengerconnections.

• [ Add ] : to add a new messenger connection.

• [ Edit ] : allows user to change value of selected messenger connection. The [ Edit ] button isenable when at least one messenger connection is selected or exist only one messenger.

• [ Remove ] : delete selected messenger connection. If there is no selected messenger, a popup will display to confirm delete all messenger connection.

• [ Connect ] : connect the selected connection from the list of available messenger. If there isno selected messenger, clicking on the button will connect them all. The messengers are movedto the “Connected Messengers connections” area.

• [ Subscription ] : allows user to choose which documents can be subscribed for the selectedconnected messenger. The [ Subscription ] button is enable when at least one connectedmessenger is selected or exist only one connected messenger.

• [ Disconnect ] : disconnect the selected messenger connection from the list of connectedmessenger’s connections. If there is no selection, it will disconnect all messengers. Theconnection is moved to the “Available Messengers connections” area.

• [ Proxy ] button: //TODO

• [ Ok ] button: closes the “Messenger Connections Configuration” window.

• “Information” zone: displays randomly tips from this list of tips:

3

"Tip n°1 : You can connect/disconnect by double-clicking a messenger","Tip n°2 : You can republish to another messenger by first attaching the document to the target messenger","Tip n°3 : You can modify a document by chosing Display Xml (modifiable) with a right-click in right panel","Tip n°4 : While modifying a Xml document, usual editing shortcuts are available (Ctrl+c,v,x,s,z)","Tip n°5 : In every lists, you can select all lines with Ctrl+a","Tip n°6 : When no messenger is selected, buttons act on all messengers","Tip n°7 : You can see error details by clicking in the info zone","Tip n°8 : You can subscribe/unsubscribe by double-clicking on a document type in Subscriptions","Tip n°9 : You can choose, move and resize columns in document list","Tip n°10 : You can click on this label to see next tip"

• Also displays success info and error.

3.1.1. Create new messaging canal

The user is able to create a new messenger connection by clicking on [ Add ] button on “Messengerconnections Configuration” window.

Messaging Canal Creation is displayed:

On [ Connection configuration ] tab the user can choose different types to create a messenger; itcan be Universal Messaging, broker Server or he can load a CG file.

To create a universal messaging, the user needs to provide URL and alias for this UniversalMessaging like following:

4

To create a Broker, the user needs to provide an alias for this broker and all information needed toconnect to the messenger (Name, Host, port and the client group):

To create a new messenger, the user can also load a CG file by providing an alias for this canal andURL of the file:

5

On [ Display color ] tab the user can choose specific color for the new messaging canal:

This color selection is not mandatory ; a random color is chosen automatically, from a range ofpredefined colors.

Note that the user can’t create multiple messenger connections with the same alias.

Once the new messenger is created, it’s displayed on “Available Messengers Connections” area as“Alias/Name@Host:Port[ClientGroup]” for a broker, “Alias Url” for an universal messaging and file.

6

3.1.2. Editing messaging canal

The user is able to change a selected messenger value by clicking on [ Edit ] button on “Messengerconnections Configuration” window. If there is no messenger selected, but only one messenger inthe list, it is considered as selected and the user can click on [ Edit ] button.

Messaging Canal Editor is displayed with values of selected messenger:

Note that when editing a messenger the user cannot change the type of selected messenger neitherthe alias.

3.1.3. Connected messengers connections

7

On “Messenger connections Configuration” window, the user can connect to messengerconnection by selecting a connection from the list of “Available messenger’s connections” andclicking on [ Connect ] button, or by clicking twice the selected messenger. If there is no messengerselected, the [ Connect ] button will connect them all. Once connected the messenger’s connectionis directly moved to “Connected Messengers connections” zone, like below:

Once the messenger connection is connected, all published documents that are configured to it aredisplayed in “CG WebMethods Messaging Tracker” window (see Main Window chapter).

3.1.4. Subscription

The user can enable or disable a document for being subscribed by clicking on [ Subscription ]button on “Messenger connections Configuration” window after selecting one connectedmessenger.

The list of all documents type concerning the selected connected messenger is displayed:

8

• [ Enable ] button: allows the user to subscribe selected documents from the white documentlist.

• [ Disable ] button: allows the user to stop listening to selected documents from coloreddocument list.

The user can disable/enable a document by double-clicking on selected document.

Note that when the user chooses to subscribe a document, this last is automatically listened to.

3.2. Main Window“CG WebMethods Messaging Tracker” window is divided in two areas, the left area displays thedocument table containing document name, the alias of relevant messenger and three ofconfigured fields, and the right area displays the contents of selected document on tree mode bydefault.

Only published documents that are configured to the connected messengers from “MessengerConnections Configuration” are displayed.

“CG WebMethods Messaging Tracker” window:

9

“CG WebMethods Messaging Tracker” window contains:

• [ Pause ] : allow the user to stop the fetching of documents. Press this button again toresume the fetching.

• [ Clear ] : deletes a selected document from the table of documents. Moreover, if nodocument is selected, the "clear" button empties the left area displaying published documents.

• [ Filter ] : allows the user to restrict the listening of documents to the ones containing theasked attribute for the next connection. Note that already received documents are not clearedby this action.

• [ Export ] : allows exporting selected documents from the list.

• [ Import ] : allows importing a new document. The document is displayed in the list withoutbeing attached to any connection.

• [ Connection ] : open “Messenger Connections Configuration” window. image::tree-expanded.png[tree-expanded]

• [ Expand all ] : when it’s checked all tree is expanded, on the other hand, when it’s notchecked all tree is retracted.

• [ Configuration ] : allows the user to change the configuration of the application. Everyinformation in this window is save in a configuration file, in order to keep the preferences infuture usage:

10

◦ Proxy port

◦ [ Expand Restrictions ] button: shortcut to the Expand Restrictions window, display the listof collapsed elements from the tree:

◦ [ Configurable Fields ] button: open "Documents Configurable Fields" window, displaythe list of documents with configured fields

[ Add ] button allows to add a new empty line, [ delete ] button allows to delete selecteddocument from the list.

◦ Save last position on tree: this option will save the last position of the scroll bar, selectedfields and collapsed node in the tree from a document to another document only with thesame name.

11

◦ Search with case sensitivity: Make the search functionality case sensitive.

◦ Delete empty doc fields in incoming documents: allows to not display empty fields ofdocuments.

◦ Look And Feel: You can change the Look And Feel of the "CG Messaging Tracker" by choosingyour favorite one or by trying them with the “Try Next” button.

• Search area:

Allows the user to display only documents with the current word written in the search area.

It search for the word in the name of the documents and the documents data.

The “Next” button will select the next occurrence of the searched word. At the end of a document,the next document is automatically selected.

If the “Name only” check box is checked, it will search in the documents name only, and the nextaction will only select a document and another.

Note that it does not delete any documents from the database, or restrict the incoming, this is plaindisplay restriction.

You can get the focus on the text area by using the usual shortcut Ctrl+F. The shortcut for the Nextbutton is F3.

• Right click on the documents table:

• Scroll Bar: Note that the scroll Bar stays on the bottom if the user put it in the bottom. Thisallows to see incoming messages in real time.

• Republish: allows republishing document, it is helpful when the user edit the documentcontent and wants to replay the process from this edited document.

12

• Attach to: allows attaching a selected documents to already connected messengers. This actionis used as a first step when we want to republish on another messenger.

• Mark type: this action is active only for unmarked documents; it allows marking documentswith the same type of selected documents. Shortcut is Ctrl+t.

• Unmark type: this action is active only for marked documents; it allows unmarking documentswith the same type of selected documents. Shortcut is Ctrl+t.

• Mark Document: this action is active only for unmarked documents; it allows marking selecteddocuments. Shortcut is Ctrl+m.

• Unmark Document: this action is active only for marked documents; it allows unmarkingselected documents. Shortcut is Ctrl+m.

• Set HTTP url: Allow the user to set an URL in order to send a REST call. It displays "Type theURL". [ Cancel ] button allows to close the window and cancel the action, [ OK ] button allows toclose the window and keep the modifications,[ Set URL ] button allows to set an URL for theselected document,[ Call URL ] button allows to call the URL set for the selected document.

13

• Call HTTP url: Allow the user to call the set URL for the selected document.Display the responsein the "URL response". If the URL is not valid or the host refuses the connection, the error isdisplayed in the info bar.

• Right area: displays the content of selected document on tree mode by default. However, theuser is able to choose to display the content on XML or Json mode by right-clicking on the areaand selecting from the list, also he can choose to display it in Xml (Editable) mode to update thecontent of document:

14

• On tree mode the user can update data by selecting, clicking three times an element andchanging the value.

• Add to Expand Restriction: allows the user to collapse a selected node from the tree and add itto “Expand exception” list, enable only when the user select a node.

• Remove from Expand exception: allows the user to expand a selected node from the tree andremove it from “Expand exception” list, enable only when the user select a collapsed node. <<<

• Set Field: allows to set selected value as configured field for the current displayed document.An empty value will be displayed as "Ø".

• Expand Restriction…: shortcut to the Expand Restrictions window, display the list of collapsedelements from the tree.

If the user chooses "Display Xml (editable)"", in the contrary of others mode (Tree, xml or Json), hecan copy/paste, undo/redo and save the content of the document by right-clicking on the area or bythe shortcuts:

15

• Ctrl+C : Copy

• Ctrl+V : Paste

• Ctrl+Z : Undo

• Ctrl+Y : Redo

• Ctrl+S : Save

Example of XML mode:

• Save: saves the displayed content after editing.

As of the XML file changes, once we modify an element, the text color will be set to "blue", aftersaving, the initial text color will be set again.

16