User Tools

Site Tools


extensions:itop-communications

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

extensions:itop-communications [2019/10/08 10:34]
extensions:itop-communications [2020/04/15 14:16] (current)
Line 1: Line 1:
 +====== Communications to the Customers ======
 +---- dataentry summary ----
 +name             : Communications to the Customers
 +description_wiki : Communications to the Customers via the portal
 +index_hidden ​    : yes
 +version ​         : 1.1.0
 +release_dt ​      : 2020-02-03
 +itop-version-min : 2.4.0
 +download_hidden ​ : http://​www.combodo.com/​itop-extensions/​itop-communications-1.1.0-543.zip
 +code             : itop-communications
 +state            : stable
 +product_hidden ​  : included
 +module-lists_hidden : itop-communications/​1.1.0
 +diffusion ​       : iTop Hub
 +----
 +
 +
 +
 +Create and publish customer oriented communications to be displayed on the user portal.
 +
 +<note important>​For iTop 2.3.2 to 2.3.4, use v1.0.10 as support for iTop 2.3.x was dropped in v1.1.0.</​note>​
 +
 +
 +===== Features =====
 +  * Create text based or image based communications (formatting including hyperlinks is supported)
 +  * Quick formatting: title  / description / predefined icon
 +  * Communications are active for a predefined time-frame (i.e. they have a predefined start and end date)
 +  * Communications can be delivered to users from selected organizations only
 +
 +
 +
 +
 +===== Revision history =====
 +
 +^  Date  ^  Version ​ ^  Description ​ ^
 +|  2020-02-03 ​ |  1.1.0  | * Add compatibility with iTop 2.7+ \\ * Add MySQL8 compatibility \\ * Minimum iTop version set to 2.4.0 |
 +|  2019-09-11 ​ |  1.0.10 ​ | * Update extension description \\ * Correctly display and hide communications to user with silos |
 +|  2018-12-19 ​ |  1.0.9  | Update translations |
 +|  2018-06-27 ​ |  1.0.7  | Add DE translations |
 +|  2018-06-26 ​ |  1.0.6  | Fix portal tile UI |
 +|  2016-08-23 ​ |  1.0.5  | Bug fix: the option "​cascade to child organizations"​ was not working ​ |
 +|  2016-08-08 ​ |  1.0.3  | First released version |
 +
 +
 +===== Limitations =====
 +
 +The Wiki syntax (in the text of the communication) creates hyperlinks which point to the console!
 +
 +===== Requirements =====
 +
 +iTop 2.3.2 and the new portal.
 +
 +===== Installation =====
 +
 +As any other extension:
 +  - Expand the content of the zip file in the ''​extensions''​ folder
 +  - Make sure that the web server has enough rights to read unzipped files
 +  - Remove the read-only flag on the iTop configuration file
 +  - Run the setup by pointing your web browser to ''<​nowiki>​http://<​itop>/​setup</​nowiki>''​
 +  - When prompted, make sure that you select **Communications to the Customers** from the list of extensions to install
 +  - Complete the installation by clicking "​Install!"​.
 +
 +===== Configuration =====
 +
 +This extensions has no configuration parameter.
 +
 +===== Usage =====
 +
 +To create a new //​Communication//​ or to view the list of Communications,​ click on the menu "​Communications"​ under "​Service Management"​.
 +
 +{{ :​extensions:​communications-menu.png?​nolink | "​Communications"​ menu }}
 +
 +<note tip>The menu lists all the "​on-going"​ communications. To see the "​closed"​ communications,​ open the search form at the top of the page, adjust the search criteria and press the "​Search"​ button.</​note>​
 +
 +==== Creating a new communication ====
 +
 +The form to create a new communication is the following:
 +
 +{{ :​extensions:​communications-new.png?​nolink | New Communication form }}
 +
 +^ Field ^ Meaning ^
 +| Announcer | The organization owning this communication. |
 +| Status | Automatically computed based on the start and end dates |
 +| Start date | The date (and time) at which to start showing this communication in the portal |
 +| End date | The date (and time) at which to stop showing this communication in the portal |
 +| Target organizations... | How to interpret the list of "​Target organizations"​. If the value is ''​Only the selected ones''​ the list is an explicit list of all organizations for which to show the communication. ​ If the value is ''​Cascade to child organizations'',​ the child organizations of the "​Target organizations"​ will also see the message.|
 +| Icon | An optional icon to display next to the communication in the portal. Choose "​None"​ for displaying no icon. |
 +| Title | An optional plain text title for the communication. |
 +| Message | The actual body of the communication. Use the formatting toolbar to style the text, to insert images or add hyperlinks. |
 +
 +<​note>​The end users do not need to have access to the announcer organization in order to view the communications in the portal. The system automatically displays the appropriate communications independently of the usual access rights.</​note>​
 +
 +<note tip>
 +To create a "​graphic only" communication (for example a graphic banner), use the "​description"​ field to insert a large version of the banner as either a JPEG or PNG image, leave the title blank and select Icon: "​None"​. The banner image will be displayed using the complete width for the browser, automatically adjusting to browser resizes.
 +</​note>​
 +
 +<note warning>​If no "​Target Organizations"​ is selected, everybody will see the communication</​note>​
 +
 +==== Display of the communications in the Portal ====
 +
 +{{ :​extensions:​communications-portal.png?​nolink | Communications in the portal }}
 +
 +When a communication is "on going",​ it is displayed in the portal, at the top of the home page. The text of the communications are truncated in order to preserve a constant height for the communications area in the home page.
 +
 +The user can click on a communication to display it in a popup dialog. This is especially useful on small screens (mobile phones) where the communication may be truncated.
 +
 +{{ :​extensions:​communications-popup.png?​nolink | Popup showing a communication }}
 +
 +If there are several on-going communications at the same time, they are displayed one after the other, using a carousel, automatically sliding to the next communication after 5 seconds. Small bullets are displayed at the bottom of the carousel to allow direct access to the Nth communication. The carousel automatically stops sliding when the user positions the mouse hover it.
 +
 +When there is no on-going communication,​ nothing is shown in the home page of the portal.
 +
 +
  

";