Chat Starter Edition Administration Guide

Transcription

1 Copyright by Grail Software Solutions 2012, 2013 Chat Starter Edition Administration Guide Explorer Version Graham Alderson & Phil Blake

2 Contents Change History... 4 Version Introduction... 5 Install... 8 Minimum Requirements... 8 Supported Environments... 8 Install GSS Chat in MQ Explorer 7.0.x... 8 Install GSS Chat in MQ Explorer 7.1.x and 7.5.x Upgrade Upgrade GSS Chat in MQ Explorer 7.0.x Upgrade GSS Chat in MQ Explorer 7.1.x and 7.5.x Uninstall Uninstall GSS Chat from MQ Explorer 7.0.x Uninstall GSS Chat from MQ Explorer 7.1.x and 7.5.x Administration of GSS Chat Enable Chat Disable Chat Creating a Chat User Changing a Chat User Deleting a Chat User Creating a Chat Group Changing a Chat Group Deleting a Chat Group Creating a Chat Notice Changing a Chat Notice Deleting a Chat Notice Hiding a Chat Notice Group Membership Export Chat Users/Groups Import Chat Users/Groups WebSphere MQ Authorities User Availability Status Information Copyright by Grail Software Solutions 2012, 2013 Page 2

3 Password Preferences Queue Manager actions Conversations using GSS Chat Chat Preferences Menus Preferences GSS trace Options GSS trace Start GSS trace Stop Contact us Trademarks Appendix A Appendix B Copyright by Grail Software Solutions 2012, 2013 Page 3

4 Change History Version Grail Software Solutions (GSS) Chat Starter Edition v1.0.1 has the following enhancements: 1. Set availability to Do Not Disturb, to prevent other Chat users from sending you messages. A logged in Chat user can set their availability to Do Not Disturb or Available. The Chat user icon in the GSS Contacts view has a new decoration for Do Not Disturb. A new conversation cannot be started with a Chat user who has enabled Do Not Disturb and similarly, new messages cannot be sent from an existing conversation. See User Availability for more information. 2. Export and import Chat Users/Groups. The logged in Chat Administrator can export Chat Users/Groups from one WMQ queue manager and import into another queue manager. See Export Chat Users/Groups and Import Chat Users/Groups for more information. 3. Added new menu option Contact us... on the Grail Software Solutions Chat node in the GSS Chat Contacts view. This will launch the system default browser and show the GSS Contact Us web page. Instructions for upgrading from v1.0.0 can be found in chapter Upgrade. Copyright by Grail Software Solutions 2012, 2013 Page 4

5 Introduction Grail Software Solutions (GSS) Chat Starter Edition is an application designed to help communication between the administrator and end-users of applications and systems using an IBM WebSphere MQ (WMQ) infrastructure. An example of an end-user could be a developer or tester of a WMQ application. Using this infrastructure, it allows: real-time conversation (chat) between the administrator and an end-user real-time conversation (chat) between two end-users posting by the administrator of electronic notices on an electronic notice board, which will be shown to all, or selected subsets of the end-users, notifying them for example of planned system maintenance As GSS Chat uses the WMQ infrastructure, it will inherit all the security associated with that infrastructure, rather than the potential exposures presented by existing internet-based chat programs. It is expected that the administrator of GSS Chat (Chat_Admin) will be the same person as the administrator of the WMQ infrastructure, as they will have the necessary WMQ authorities needed to enable GSS Chat. There are two versions of GSS Chat Starter Edition: Explorer version - for use by Chat_Admin, which is installed as an extension to the IBM WebSphere MQ Explorer. This version has all the facilities needed to enable, administer and use GSS Chat and is described in this document. Client version - for use by end-users, which is installed in its own Eclipse alongside a WMQ Client. This version is for general users of GSS Chat and is described in another document. When the Explorer version of GSS Chat Starter Edition is installed in WMQ Explorer, additional views and menu items are created for administering GSS Chat. Using these, Chat_Admin can choose to enable GSS Chat on a WMQ Queue Manager. This creates two additional queues and one additional topic on the Queue Manager. Once GSS Chat has been enabled, as a quick out-of-the-box experience, end-users can immediately log into GSS Chat using any user name, and without a password, to try out the Chat facilities. This is known as anonymous mode. However Chat_Admin will normally define a Chat User for each end-user, together with a password. Once the first Chat User has been defined, then the anonymous mode is disabled and all Chat Users must log in with a valid Chat User and password. Chat_Admin can create, edit and delete Chat Users. The following figure illustrates Chat_Admin using GSS Chat to chat with an end-user: Copyright by Grail Software Solutions 2012, 2013 Page 5

6 Chat_Admin can also define one or more Chat Groups, with which Chat Users can be associated. Chat Users can be members of more than one Chat Group. Chat Groups might contain users of a particular application, or members of a particular department. In addition, GSS Chat automatically creates a Chat Group called All which contains all Chat Users and another called Me which contains the logged in Chat User. Chat_Admin can create Chat Notices to be seen by users of GSS Chat, either immediately if they are currently logged into GSS Chat, or the next time they log in. A Chat Notice is sent to all members of a Chat Group, so if the All group is selected then all users of GSS Chat will receive the notice. Chat_Admin can create, edit and delete Chat Notices. The following figure illustrates the Chat Noticeboard showing Chat Notices that have been issued by Chat_Admin: Copyright by Grail Software Solutions 2012, 2013 Page 6

7 This document describes how Chat_Admin can: Install and uninstall the Explorer version of GSS Chat Starter edition Enable and disable GSS Chat on a WMQ Queue Manager Create, edit and delete Chat Users Create, edit, change the membership of and delete Chat Groups Create, edit and delete Chat Notices Set availability Set preferences for GSS Chat Check the authorities of system user accounts for GSS Chat View status information Use service facilities (under the direction of GSS) Copyright by Grail Software Solutions 2012, 2013 Page 7

8 Install Minimum Requirements Minimum requirements to use GSS Chat Starter Edition (Explorer version) is Windows 7 IBM WebSphere MQ Server or IBM WebSphere MQ SupportPac MS0T from Supported Environments There are many environments that the GSS Chat Starter Edition (Explorer version) could potentially be run in various 7.x versions of the IBM WebSphere MQ Server and 7.x versions of IBM WebSphere MQ SupportPac MS0T and the operating systems they both support. As a small company with limited time and resources, at present we have only tested the GSS Chat Starter Edition (Explorer version) in the following environments: Windows 7 SP1 IBM WebSphere MQ Server , and IBM WebSphere MQ SupportPac MS0T and connecting to a queue manager on IBM WebSphere MQ , and also on Windows 7 SP1 While we would expect the GSS Chat Starter Edition (Explorer version) to install and run correctly in other environments, for example on other versions of Windows or on the various Linux distributions, as they are currently untested we would not be able to guarantee this is the case. Install GSS Chat in MQ Explorer 7.0.x The file called ma99_explorer_101.zip can be downloaded as part of the MA99 SupportPac from Unzip the file into a temporary location, for example, c:\temp\ma99_explorer_1.0.1 When installing, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right-mouse button and choose the option to Run as administrator. Make sure MQ Explorer is running in workbench mode, open the Preferences dialog (select the Window Preferences... menu item) and select the WebSphere MQ Explorer tree node. The option in an Eclipse Workbench needs to be selected and then the MQ Explorer needs to be restarted. Select the Help Software Updates Find and Install... menu item. Copyright by Grail Software Solutions 2012, 2013 Page 8

9 1. Select Search for new features to install and press the Next button. Copyright by Grail Software Solutions 2012, 2013 Page 9

10 2. Press the New Local Site... button. 3. Select the directory containing the GSS Chat site.xml file (for example c:\temp\ma99_explorer_1.0.1). Copyright by Grail Software Solutions 2012, 2013 Page 10

11 4. Press the Finish button. Copyright by Grail Software Solutions 2012, 2013 Page 11

12 5. From the Updates dialog, expand the temp/ma99_explorer_1.0.1 node and select the GSS Chat Starter Edition (Explorer feature) from the list. 6. Press the Next button to see the Feature License dialog. Copyright by Grail Software Solutions 2012, 2013 Page 12

13 7. Read and accept the terms of the license agreement. 8. Press the Next button. Copyright by Grail Software Solutions 2012, 2013 Page 13

14 9. Press the Finish button (or Cancel to stop the installation). 10. Press the Install or Install All button. 11. Press the Yes button to restart the MQ Explorer. Note if the GSS Chat Contacts view is not shown when the MQ Explorer is restarted, then use the Window Reset Perspective menu item. Install GSS Chat in MQ Explorer 7.1.x and 7.5.x The file called ma99_explorer_101.zip can be downloaded as part of the MA99 SupportPac from Unzip the file into a temporary location, for example, c:\temp\ma99_explorer_1.0.1 When installing, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right mouse button and choose the option to Run as administrator. Copyright by Grail Software Solutions 2012, 2013 Page 14

15 Select the Help Install New Software... menu item. 1. Press the Add... button. 2. Press the Local... button on the Add Repository dialog. 3. Select the directory containing the GSS Chat site.xml file (for example c:\temp\ma99_explorer_1.0.1). You do not need to enter anything in the Name field. 4. Press the OK button. Copyright by Grail Software Solutions 2012, 2013 Page 15

16 5. From the Available Software dialog, expand the GSS Chat node and select the GSS Chat Starter Edition (Explorer Feature) from the drop down list. 6. Press the Next button to review the items to be installed. 7. Press the Next button again Copyright by Grail Software Solutions 2012, 2013 Page 16

17 8. Read and accept the terms of the license agreement. 9. Press the Finish button (or Cancel to stop the installation). 10. A security warning may be shown saying Warning: you are installing software that contains unsigned content... Press the OK button to continue the installation or Cancel to quit the installation. Copyright by Grail Software Solutions 2012, 2013 Page 17

18 11. Press the Restart Now button to restart the MQ Explorer. Copyright by Grail Software Solutions 2012, 2013 Page 18

19 Upgrade This section describes how to upgrade GSS Chat to Upgrade GSS Chat in MQ Explorer 7.0.x The file called ma99_explorer_101.zip can be downloaded as part of the MA99 SupportPac from Unzip the file into a temporary location, for example, c:\temp\ma99_explorer_1.0.1 When installing, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right-mouse button and choose the option to Run as administrator. Make sure MQ Explorer is running in workbench mode, open the Preferences dialog (select the Window Preferences... menu item) and select the WebSphere MQ Explorer tree node. The option in an Eclipse Workbench needs to be selected and then the MQ Explorer needs to be restarted. Select the Help Software Updates Find and Install... menu item. 1. Select Search for new features to install and press the Next button. Copyright by Grail Software Solutions 2012, 2013 Page 19

20 2. Press the New Local Site... button. 3. Select the directory containing the GSS Chat site.xml file (for example c:\temp\ma99_explorer_1.0.1). Copyright by Grail Software Solutions 2012, 2013 Page 20

21 4. Press the Finish button. Copyright by Grail Software Solutions 2012, 2013 Page 21

22 5. From the Updates dialog, expand the temp/ma99_explorer_1.0.1 node and select the GSS Chat Starter Edition (Explorer feature) from the list. 6. Press the Next button to see the Feature License dialog. Copyright by Grail Software Solutions 2012, 2013 Page 22

23 7. Read and accept the terms of the license agreement. 8. Press the Next button. Copyright by Grail Software Solutions 2012, 2013 Page 23

24 9. Press the Finish button (or Cancel to stop the installation). 10. Press the Install or Install All button. 11. Press the Yes button to restart the MQ Explorer. Note if the GSS Chat Contacts view is not shown when the MQ Explorer is restarted, then use the Window Reset Perspective menu item. Upgrade GSS Chat in MQ Explorer 7.1.x and 7.5.x The file called ma99_explorer_101.zip can be downloaded as part of the MA99 SupportPac from Unzip the file into a temporary location, for example, c:\temp\ma99_explorer_1.0.1 When installing, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right mouse button and choose the option to Run as administrator. Copyright by Grail Software Solutions 2012, 2013 Page 24

25 Select the Help Install New Software... menu item. 1. Press the Add... button. 2. Press the Local... button on the Add Repository dialog. 3. Select the directory containing the GSS Chat site.xml file (for example c:\temp\ma99_explorer_1.0.1). You do not need to enter anything in the Name field. 4. Press the OK button. Copyright by Grail Software Solutions 2012, 2013 Page 25

26 5. From the Available Software dialog, expand the GSS Chat node and select the GSS Chat Starter Edition (Explorer Feature) from the drop down list. Press the Next button to review the items to be installed. Note if the next dialog contains an error message like The operation cannot be completed. See the details then you will need to scroll down in the Details section to see the relevant error message. If there is more than one GSS application installed in the same MQ Explorer, then all GSS applications will need to be updated to the same version at the same time. This can be achieved by repeating from step 1 and adding another Available Software Site, to point to the other GSS application local update site. This will allow -- All Available Sites -- to be selected from the Work with: drop down list and from that, all GSS applications can be upgraded at the same time. Copyright by Grail Software Solutions 2012, 2013 Page 26

27 6. Note the message about an update will be performed. Press the Next button. 7. Read and accept the terms of the license agreement. Copyright by Grail Software Solutions 2012, 2013 Page 27

28 8. Press the Finish button (or Cancel to stop the installation). 9. A security warning may be shown saying Warning: you are installing software that contains unsigned content... Press the OK button to continue the installation or Cancel to quit the installation. 10. Press the Restart Now button to restart the MQ Explorer. Copyright by Grail Software Solutions 2012, 2013 Page 28

29 Uninstall Uninstall GSS Chat from MQ Explorer 7.0.x When uninstalling, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right mouse button and choose the option to Run as administrator. Make sure MQ Explorer is running in workbench mode, open the Preferences dialog (select the Window Preferences... menu item) and check the WebSphere MQ Explorer tree node. The option in an Eclipse Workbench needs to be selected and then the MQ Explorer needs to be restarted. Select the Help Software Updates Manage Configuration... menu item and expand the Eclipse SDK node to show all features. 1. Select Chat Starter Edition (Explorer feature), press right mouse button and select the Uninstall menu item. 2. Press the OK button to uninstall or Cancel to stop uninstall. Copyright by Grail Software Solutions 2012, 2013 Page 29

30 3. Press the Yes to restart the MQ Explorer. Note uninstalling a feature from Eclipse does not remove the jar files from the plugin sub-directory that make up the feature and it is recommended these files are not deleted. Uninstall GSS Chat from MQ Explorer 7.1.x and 7.5.x When uninstalling, the MQ Explorer needs to run with Windows administrator privileges. Select WebSphere MQ Explorer from the IBM WebSphere MQ folder in the Windows start menu. Press right mouse button and choose the option to Run as administrator. Select the Help Install New Software... menu item. 1. Press the link in What is already installed? Copyright by Grail Software Solutions 2012, 2013 Page 30

31 2. Select the Chat Starter Edition (Explorer feature). 3. Press the Uninstall... button. 4. Press the Finish button to uninstall or Cancel to stop uninstall. Copyright by Grail Software Solutions 2012, 2013 Page 31

32 5. Press the Restart Now button to restart the MQ Explorer. Note uninstalling a feature from Eclipse does not remove the jar files from the plugin sub-directory that make up the feature and it is recommended these files are not deleted. Copyright by Grail Software Solutions 2012, 2013 Page 32

33 Administration of GSS Chat When the MQ Explorer is restarted after installing GSS Chat an additional view called GSS Chat Contacts, should be visible. Its default location is below the MQ Explorer - Navigator view. If the GSS Chat Contacts view is not visible, then use the Windows Reset Perspective menu item or the Grail Chat Show contacts view menu item on the IBM WebSphere MQ tree node. To enable GSS Chat on a queue manager, see Enable Chat for more information. Anonymous users can now log in to Chat and have conversations with other anonymous Chat Users. An anonymous Chat User does not need a password to log in and can choose any name they like. The Chat Administrator (with a name of Chat_Admin) has the ability to register Chat Users and by default they will need a password to log in. Once the first Chat User has been registered, then only registered Chat Users can log in. Copyright by Grail Software Solutions 2012, 2013 Page 33

34 Using the Log in... context menu item on the queue manager in the GSS Chat Contacts view, log in to Chat as the Chat Administrator. The default password is ChatAdmin (case sensitive). This should be changed as soon as possible. See Changing a Chat User for more information. Copyright by Grail Software Solutions 2012, 2013 Page 34

35 When Chat_Admin (or any Chat User) logs in to GSS Chat, by default the GSS Chat Noticeboard view is shown. When GSS Chat is first enabled on a queue manager, the GSS Chat Noticeboard view contains a default notice. The contents of this notice can be changed to meet your requirements, see Changing a Chat Notice for more information. Two Chat Groups are created by default, which cannot be deleted. These are the Me group which shows the logged in Chat User and the All group which shows all registered Chat Users, unless there are no registered Chat Users yet and then it shows all active Chat Users. The icon decoration shows the status of a Chat User. A complete list of Chat icons can be found in Appendix B. Copyright by Grail Software Solutions 2012, 2013 Page 35

36 Enable Chat To enable GSS Chat on a queue manager, select the queue manager tree node in the MQ Explorer - Navigator view, press the right mouse and select the Grail Chat Enable Chat... menu item and press the Yes button. The queue manager will then appear in the GSS Chat Contacts view. Enabling GSS Chat will create two queues and a topic object, if they do not already exist 1. GSS.SYSTEM.ADMIN.QUEUE 2. GSS.SYSTEM.CHAT.ADMIN.QUEUE 3. GSS.SYSTEM.CHAT.TOPIC Copyright by Grail Software Solutions 2012, 2013 Page 36

37 Disable Chat To disable GSS Chat on a queue manager, select the queue manager tree node in the MQ Explorer - Navigator view, press the right mouse and select the Grail Chat Disable Chat... menu item to display the following prompt. Select option Delete the Chat objects, including all Chat users and Chat groups to remove the two queues and topic created when Chat was enabled. If the Chat objects are not deleted, then re-enabling Chat on the queue manager will allow Chat to re-use any Chat Users, Chat Groups and Chat Notices previously created. Chat can also be disabled from a Chat queue manager in the GSS Contacts view. Select the Chat queue manager tree node, press the right mouse button and select the Disable Chat... menu item to display the above prompt. Note Chat cannot be disabled while Chat_Admin is logged in to Chat. Copyright by Grail Software Solutions 2012, 2013 Page 37

38 Creating a Chat User Log in as the Chat Administrator and use the New User... context menu item on the All group in the GSS Chat Contacts view. If this is the first Chat User to be registered (created) on this queue manager, there must be no anonymous Chat Users logged in. A dialog is displayed warning that once the first Chat User is created, then all users of GSS Chat must use a registered Chat User. Press Proceed to continue. A new dialog is shown, prompting for a name and password. All other fields are optional. The name can consist of one or more uppercase and lowercase alphanumeric characters, including. and _. The name Chat_Admin is reserved for the Chat Administrator. The Description and Department fields can be used to help identify a Chat User. These details are shown in status information. Note the minimum length of the password can be changed by using the Password preferences... context menu item on a queue manager in the GSS Chat Contacts view. The New User... context menu item is available on all Chat Groups, except the Me group. New Chat Users will be added to the All group and information about the new Chat User will be published to any active Chat Users. Copyright by Grail Software Solutions 2012, 2013 Page 38

39 Changing a Chat User Log in as the Chat Administrator. Select the Chat User and press right mouse button then select the Edit... context menu item. Note a Chat User cannot be changed while they are logged in to GSS Chat. The Description and Department fields can be used to help identify a Chat User. These details are shown in status information. Press the OK button after making the necessary changes. Note the Name field cannot be changed. To change the password of the Chat User, press the Change... button. Note the minimum length of the password can be changed by using the Password preferences... context menu item on a queue manager in the GSS Chat Contacts view. After entering the new password (twice), the OK button will be enabled, press the OK button to change the password. This will go back to the Edit Chat User dialog. Press the OK button on this dialog to apply the change. Pressing the Cancel button will not change the password. Information about the changed Chat User will be published to any active Chat Users. Copyright by Grail Software Solutions 2012, 2013 Page 39

40 Deleting a Chat User Log in as the Chat Administrator. Select the Chat User and press right mouse button then select the Delete... context menu item. Note a Chat User cannot be deleted while they are logged in to GSS Chat. Press the Yes button to delete the Chat User. This will remove the Chat User from all Chat Groups. Information about the deleted Chat User will be published to any active Chat Users. Copyright by Grail Software Solutions 2012, 2013 Page 40

41 Creating a Chat Group Log in as the Chat Administrator and use the New Group... context menu item on the queue manager tree node in the GSS Chat Contacts view. Chat Groups can be used to send Chat Notices to selected groups of Chat Users. The name can consist of one or more uppercase and lowercase alphanumeric characters, including. and _. The group names All and Me are reserved for GSS use. The Description field can be used to help identify the group and will be displayed in status information. Note it is not possible to have sub-groups in this version of GSS Chat. Information about the new Chat Group will be published to any active Chat Users. Copyright by Grail Software Solutions 2012, 2013 Page 41

42 Changing a Chat Group Log in as the Chat Administrator and select the Chat Group and press right mouse button then use the Edit... context menu item. The Description field can be used to help identify the group and will be displayed in status information. Note the Name field cannot be changed. Information about the changed Chat Group will be published to any active Chat Users. Copyright by Grail Software Solutions 2012, 2013 Page 42

43 Deleting a Chat Group Log in as the Chat Administrator and select the Chat Group and press right mouse button then use the Delete... context menu item. Note deleting a Chat Group will not delete any Chat Users, but it will delete any notices seen by the group. Information about the deleted Chat Group will be published to any active Chat Users. If a logged in Chat User is a member of the deleted Chat group, then they will be prompted about the group membership change and their Noticeboard will be refreshed. Copyright by Grail Software Solutions 2012, 2013 Page 43

44 Creating a Chat Notice Log in as the Chat Administrator. A Chat Notice can be pinned on the Chat Notice board for everyone to see by selecting the All Chat Group in the GSS Chat Contacts view, then pressing right mouse button and selecting Send a notice... context menu item. Enter some text in the Subject field and then some information in the Notice field. The OK button is not enabled until some text has been entered into both fields. A timestamp is added to the notice when it is pinned on the Chat Notice board and the subject text is made bold. To restrict which Chat Users can see a Chat Notice, select the Chat Group instead of the All group, then only those members of the group will see the notice. Copyright by Grail Software Solutions 2012, 2013 Page 44

45 Changing a Chat Notice Log in as the Chat Administrator and open the GSS Chat Noticeboard view if it is not already open. Use the menu in the top right of the notice and select the Edit... context menu item. Change the Subject or Notice fields and press the OK button. The changed notice will update the Last updated field and make the text of the Subject field bold. Copyright by Grail Software Solutions 2012, 2013 Page 45

46 Deleting a Chat Notice Log in as the Chat Administrator and open the GSS Chat Noticeboard view if it is not already open. Use the menu in the top right-hand corner of the Chat Notice and select the Delete... context menu item. Press the Yes button and the notice will be removed from all Chat Noticeboards this notice was sent to. To delete all Chat Notices sent to a Chat Group, select the Chat Group in the GSS Chat Contacts view then press right mouse button and select Delete notices... context menu item. To delete all Chat Notices in all Chat Groups, use the toolbar menu on the Chat Noticeboard view and select the Delete all notices... context menu item. Note deleting a Chat Notice will also delete it if the Chat User has chosen to hide the notice. Copyright by Grail Software Solutions 2012, 2013 Page 46

47 Hiding a Chat Notice If the Chat Noticeboard becomes too busy will lots of notices, then it is possible to hide individual notices to make the notice board look less cluttered. Use the menu in the top right corner of the notice and select the Hide context menu item. This will only hide the notice from your notice board and the notice will remain hidden the next time the Chat Noticeboard view is opened. A hidden notice will be re-shown (by default) if it is changed by the Chat Administrator. This default action can be changed by using the Chat preferences. To show a hidden notice, use the toolbar menu on the GSS Chat Noticeboard and select the Show all notices context menu item. Note it is not possible to reshow a single notice. Copyright by Grail Software Solutions 2012, 2013 Page 47

48 Group Membership Log in as the Chat Administrator. Both Chat Users and Chat Groups have a context menu item called Group membership... to see group related information. Selecting a Chat User will show their current group membership and a list of groups they can become a member of. This shows phil is already a member of group1 and can also join group2. He can also be removed from group1. Selecting a Chat Group will show the current group membership and a list of Chat Users who can join the group. This shows phil is already a member of group1 and Chat_Admin, dave and jeff can also become members of group1. phil can also be removed from group1. Copyright by Grail Software Solutions 2012, 2013 Page 48

49 Note the Me and All Chat Groups do not have this context menu item. It is also possible to drag and drop Chat Users in the GSS Chat Contacts view, to extend their group membership. The following actions are supported using drag and drop dragging a Chat User from the 'All' group and dropping on a user defined group adds the Chat User to that group dragging a Chat User from a user defined group and dropping on a second user defined group moves the Chat User from the first group to the second group dragging a Chat User from a user defined group and dropping on a second user defined group while holding down the Ctrl key leaves the Chat User in the first group and adds it to the second group dragging a Chat User from a user defined group and dropping on the 'All' group removes the Chat User from the user defined group dragging a Chat Group onto a user defined group will add the members of first group to the second group Note in the above actions, a user defined group is a new group created by the Chat Administrator. Changes to group membership are published to any active Chat Users. If a logged in Chat User s group membership has changed, then they will be prompted about the change and their Noticeboard will be refreshed. Copyright by Grail Software Solutions 2012, 2013 Page 49

50 Export Chat Users/Groups Exporting Chat Users and Groups can be used to backup the current Chat configuration or to import into another queue manager which has been enabled for Chat. Log in as the Chat Administrator. Select the Chat queue manager in the GSS Chat Contacts view and press the right mouse button. Select the Export... context menu. Use the the Browse... button to enter a new file name or select an existing file. If the file already exists then a warning dialog is shown. The default file type is xml. Copyright by Grail Software Solutions 2012, 2013 Page 50

51 Import Chat Users/Groups Log in as the Chat Administrator. Select the Chat queue manager in the GSS Chat Contacts view and press the right mouse button. Select the Import... context menu. Press the Browse... button to select the import file. This must be a file that was generated from Export Chat Users/Groups. The contents of the file are validated and if there are any Chat Users or Groups already defined on the Chat queue manager, a warning message is shown, for example If there are no Chat Users (or Groups) defined, an information message is shown, for example Copyright by Grail Software Solutions 2012, 2013 Page 51

52 Copyright by Grail Software Solutions 2012, 2013 Page 52

53 WebSphere MQ Authorities The Chat Administrator connects to a queue manager as a WMQ client using the same type of connection as the WMQ queue manager in the MQ Explorer Navigator view. The Chat Administrator will PUT/GET messages on the queues and PUB/SUB to the topic created by GSS Chat when it was enabled on the queue manager. The WMQ authorities needed by the Chat Administrator can be seen by using the Authorities... context menu item on the queue manager in the GSS Chat Contacts view. They are also listed in Appendix A Enter the name of a system userid and select the option This userid will be used by the Chat Administrator. Press the OK button for GSS Chat to check if the given userid has sufficient WMQ authorities to act as the Chat Administrator. Press the Details... button to see which WMQ authorities are needed for the Chat Administrator. Copyright by Grail Software Solutions 2012, 2013 Page 53

54 If the system userid phil was not being used by the Chat Administrator, but instead by a Chat User, then the following list of WMQ authorities would be shown If system userid phil did not have sufficient WMQ authorities, then the following dialog will be shown Copyright by Grail Software Solutions 2012, 2013 Page 54

55 Press the Details... button to show a list of all WMQ authorities needed to use GSS Chat or press the Authorise... button to show a different dialog enabling the missing WMQ authorities to be applied. Copyright by Grail Software Solutions 2012, 2013 Page 55

56 User Availability A Chat user can set their availability to Do Not Disturb or Available. Select your Chat User icon in the GSS Chat Contacts view and press the right mouse button and select the Set Availability' context menu. Setting availability to Do Not Disturb will notify all active Chat Users and stop any further messages being received. The icon decoration of the Chat User will be updated to show the new availability. Any open Chat views will also be locked, to stop any further messages being sent until the availability is changed to Available. Note, as this is a new feature in Chat Version 1.0.1, a Chat User still on Version will not be aware of the availability of a target Chat User using Chat Version Any message sent by a Version Chat User to a Chat User with Do Not Disturb enabled, will see the message returned as undelivered, with an appropriate message. Copyright by Grail Software Solutions 2012, 2013 Page 56

57 Status Information There are two different sorts of status information available. The first can be seen in the GSS Chat Status view by selecting a queue manager in the GSS Chat Contacts view then pressing the right mouse button and selecting the Show status view context menu item. The view shows status information about the Chat system. The status information can be copied to the clipboard using the toolbar menu item Copy to clipboard. Note that GSS status information should only be used under the guidance of Grail Software Solutions to help diagnose any problems. The second sort of status information is with regard to a Chat User. Select a Chat User in the GSS Chat Contacts view, press right mouse button and select the Status... context menu item. This shows details about the Chat User and the time of log in. Copyright by Grail Software Solutions 2012, 2013 Page 57

58 If the Chat User is not logged in then the following information is displayed. Copyright by Grail Software Solutions 2012, 2013 Page 58

59 Password Preferences By default all registered Chat Users need a password of a minimum length of 8 characters. The minimum length can be changed but the maximum length allowed is always 55 characters This is achieved by selecting the Password preferences... context menu item on a queue manager tree node in the GSS Chat Contacts view. Copyright by Grail Software Solutions 2012, 2013 Page 59

60 Queue Manager actions Some actions performed on queue managers in the MQ Explorer Navigator view will trigger GSS Chat prompts to be shown, allowing some actions to be vetoed, for example, Copyright by Grail Software Solutions 2012, 2013 Page 60

61 Conversations using GSS Chat The Chat Administrator can have a conversation with any active Chat User. This can be achieved in two ways, either by double-clicking on the active Chat User in the GSS Chat Contacts view or by pressing the right mouse button on the Chat User and selecting the Chat... context menu item. This will open a new GSS Chat view with details about the target Chat User. In this example the Chat Administrator starts a conversation with dave. Some text is entered in the input field in the Chat view and this will enable the Say it button. The message can be sent either by pressing the Say it button or by pressing the Enter key. Note the icon for dave in the GSS Chat Contacts view has changed to show the conversation status. The conversation will appear in dave s Chat as a new view and with an animated tab, highlighting the new conversation. Notifications of conversations can be controlled by changing the default Chat preferences. Responses from dave will appear in the same Chat view that started the conversation. In this example the Chat Administrator is called phil. If dave logs out from GSS Chat then status information will appear in the GSS Chat view and the Say it button will remain disabled until dave logs in again. There is no history of a conversion retained in this version of GSS Chat, so when a GSS Chat view is closed, the conversation text is no longer available. Copyright by Grail Software Solutions 2012, 2013 Page 61

62 Chat Preferences Chat preferences can be used to control notifications of new conversations and notifications for the Chat Noticeboard. The colour schemes for these views can also be changed using the preferences. To manage Chat preferences, select the Preferences... context menu item on the Grail Software Solutions tree node in the GSS Chat Contacts view. These preferences affect all GSS Chat enabled queue managers. Copyright by Grail Software Solutions 2012, 2013 Page 62

63 Copyright by Grail Software Solutions 2012, 2013 Page 63

64 Menus The Grail Software Solutions Chat tree node in the GSS Chat Contacts view has the following menus Preferences... This menu item will open the GSS Chat preferences window. GSS trace Options... This menu item will be enabled if there is no location defined for the GSS trace file or GSS trace has not been started. A dialog is shown to define the location for the GSS trace file and to choose whether to start GSS trace the next time GSS Chat is started. Note that GSS trace should only be used under the guidance of Grail Software Solutions to help diagnose any problems. GSS trace Start This menu item will be enabled if a location has been defined for the GSS trace file and GSS trace has not been started. Note that GSS trace should only be used under the guidance of Grail Software Solutions to help diagnose any problems. GSS trace Stop This menu item will be enabled if GSS trace has been started. Note that GSS trace should only be used under the guidance of Grail Software Solutions to help diagnose any problems. Contact us This menu item will open the system default browser and show the GSS Contact Us web page. Copyright by Grail Software Solutions 2012, 2013 Page 64

65 Trademarks The following are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. IBM WebSphere The following is a trademark of Microsoft Corporation, registered in many jurisdictions worldwide. Windows 7 The following are trademarks of Eclipse Foundation, Inc. Eclipse Built on Eclipse The following is a registered trademark of Linus Torvalds in the U.S. and other countries. Linux Copyright by Grail Software Solutions 2012, 2013 Page 65

66 Appendix A The system userid used by the Chat Administrator to connect to the queue manager needs the following WMQ authorities, where <id> is the system userid setmqaut -m QM1 t qmgr p <id> +inq +connect setmqaut -m QM1 t queue n GRAIL.SOFTWARE.SOLUTIONS.ADMIN.QUEUE p <id> +put +get +browse +inq +crt setmqaut -m QM1 t queue n GRAIL.SOFTWARE.SOLUTIONS.CHAT.ADMIN.QUEUE p <id> +put +get +browse +inq +crt setmqaut -m QM1 t topic n GRAIL.SOFTWARE.SOLUTIONS.CHAT.TOPIC p <id> +pub +sub +crt The system userid used by a Chat User to connect to the queue manager needs the following WMQ authorities, where <id> is the system userid setmqaut -m QM1 t qmgr p <id> +connect +inq setmqaut -m QM1 t queue n GRAIL.SOFTWARE.SOLUTIONS.ADMIN.QUEUE p <id> +browse setmqaut -m QM1 t queue n GRAIL.SOFTWARE.SOLUTIONS.CHAT.ADMIN.QUEUE p <id> +browse setmqaut -m QM1 t topic n GRAIL.SOFTWARE.SOLUTIONS.CHAT.TOPIC p <id> +pub +sub Copyright by Grail Software Solutions 2012, 2013 Page 66

67 Appendix B This is a complete list of GSS Chat icons. The Chat Administrator logged out The Chat Administrator logged in The Chat Administrator chatting The Chat Administrator logged in with Do Not Disturb The Chat Administrator chatting with Do Not Disturb An unregistered Chat User logged out An unregistered Chat User logged in An unregistered Chat User chatting An unregistered Chat User logged in with Do Not Disturb An unregistered Chat User chatting with Do Not Disturb A registered Chat User logged out A registered Chat User logged in A registered Chat User chatting A registered Chat User logged in with Do Not Disturb A registered Chat User chatting with Do Not Disturb A Chat Group The All or Me Chat Group The GSS Chat Contacts view A pin used on the Chat Noticeboard Show all Chat Notices on the Chat Noticeboard Delete all Chat Notices on the Chat Noticeboard Copy contents to the system clipboard The GSS Chat status view Refresh contents of the GSS Chat Contacts view New conversation in a Chat view New Chat Notice on the Chat Noticeboard Expand all tree nodes in the GSS Chat Contacts view Collapse all tree nodes in the GSS Chat Contacts view Copyright by Grail Software Solutions 2012, 2013 Page 67