User Tools

Site Tools

:: Version 2.6.0 ::

2_6_0:user:lists

Differences

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

Link to this comparison view

2_6_0:user:lists [2019/01/09 16:40] (current)
Line 1: Line 1:
 +====== Managing Lists ======
  
 +
 +In iTop, lists are quite common. They can be found in menu items which point to lists, or the search results, as well as the global search.
 +Once a list of objects is displayed, the operations that can be performed on the list are always the same.
 +
 +For example, below is a list of Contacts:
 +
 +{{ :​2_6_0:​user:​managing-lists-1.png?​600 |A Non-Paginated List}}
 +
 +If a list contains more than a (configurable) number of elements, it is displayed as a //​paginated//​ list:
 +
 +{{ :​2_6_0:​user:​managing-lists.png?​650 |A paginated list}}
 +
 +<note important>​
 +Starting with iTop 2.2.0, the **Export** actions are only available to the end-users which profile(s) include the ''​BULK_READ''​ privilege.
 +For backwards compatibility with iTop 2.1.0, all standard profiles include this privilege, but this may not be the case if the profiles have been customized in your installation of iTop.
 +</​note>​
 +
 +====== Toolkit menu ======
 +
 +When a list of objects is displayed in iTop, a certain number of operations can be performed on the list itself (without modifying the objects in iTop). These operations are executed through the toolkit popup menu at the top-right of the list.
 +
 +==== Configure This List =====
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-configure.png |Toolkit operation: Configure This list}}
 +
 +The first possible operation consists of configuring the appearance of the list. You can choose:
 +  * Which columns are displayed and in which order
 +  * How the list is sorted
 +  * How many items will be displayed at the same time (see paginated lists above)
 +  * Which list this configuration will apply to: (Only to this specific list, or to all lists which do not already have a specific configuration).
 +
 +All this configuration is done via the popup dialog:
 +
 +{{ :​2_6_0:​user:​list-configuration-dialog.png?​600 |List Configuration Dialog}}
 +
 +==== eMail ====
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-email.png |Toolkit operation: eMail}}
 +
 +This action is similar to the **eMail** action on the details of an object, except that the hyperlink inserted into the message points to the specified list of objects.
 +
 +
 +==== CSV Export ====
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-export.png |Toolkit operation: CSV Export}}
 +
 +The CSV export action displays a configuration dialog which allows to:
 +  * Select the format options: separator character for the CSV (comma, semicolon, tab or any other character)
 +  * Specify a **text qualifier** character (to be placed around text strings inside the CSV)
 +  * Pick a character encoding
 +  * Choose, for enumerated fields (like statuses) whether the values must be localized (i.e. use the values as they appear on-screen) or use the internal (language independent) codes.
 +  * Pick the fields to be included in the export
 +  * Arrange the order of the columns ​
 +
 +{{ :​2_6_0:​user:​csv-export.png?​600 |Interactive CSV export}}
 +<note tip>
 +To arrange the order of the columns, drag and drop the columns in the table displayed in the **Column order** section at the bottom of the dialog. To drag a column click in the **header** of the column.
 +</​note>​
 +
 +When your export is properly configured, click **//​Export//​** to build it.
 +If the export contains a large amount of data, (more than 1000 lines) a progress bar is displayed.
 +
 +When the export is complete, you can either click on the link **//Click here to download//​** at the top of the dialog box to download the result as a .csv file, or copy and paste the export as plain text from the text area:
 +
 +{{ :​2_6_0:​user:​csv-export-2.png?​nolink&​800 | CSV Export results }}
 +
 +=== How to paste CSV data in Excel 2007/2010 ===
 +
 +If you use copy/paste to import CSV data into Excel, all the data is put in one column only. Fortunately,​ this is easy to change.
 +
 +In the **Data** tab of Excel, click on the **//Text To Columns//** icon:
 +
 +{{ :​2_6_0:​user:​excel-csv-import-1.png?​600 |Data Tab in Excel}}
 +
 +The following dialog wizard appears:
 +
 +{{ :​2_6_0:​user:​excel-csv-import-2.png |Excel Text to Columns Wizard}}
 +
 +Select **Delimited** and click **//Next >//**.
 +
 +{{ :​2_6_0:​user:​excel-csv-import-3.png?​600 |Excel Text to Columns Wizard}}
 +
 +Select **Comma** and click **//​Finish//​**.
 +
 +<note tip>
 +The next time you copy/paste CSV data in the same session (without closing and restarting Excel), Excel will automatically perform the text-to-columns conversion with the same settings.
 +</​note>​
 +
 +==== Excel Export ====
 +
 +Starting with version 2.1.0 of iTop, a direct export to Excel (XLSX format) is available from the menu:
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-exportexcel.png |Excel Export}}
 +
 +The following dialog box is displayed:
 +
 +{{ :​2_6_0:​user:​itop-xlsx-export-options.png?​800 |Excel Export options}}
 +
 +The Excel export action displays a configuration dialog which allows to:
 +  * Pick the columns to be included in the export
 +  * Arrange the order of the columns ​
 +
 +<note tip>
 +To arrange the order of the columns, drag and drop the columns in the table displayed in the **Column order** section at the bottom of the dialog. To drag a column click in the **header** of the column.
 +</​note>​
 +
 +When you click on **Export**, the Excel file is built. If the list of objects to export is large (>1000), a progress bar is displayed. Once the export is complete, you can download the Excel file by clicking on the link **//Click here to download//​** at the top of the dialog box:
 +
 +{{ :​2_6_0:​user:​itop-xlsx-exporter-progress.png?​450 |Excel Export progress}}
 +
 +<note tip>
 +To export large amounts of data (e.g. several thousands of objects), the CSV export can be significantly faster than the Excel export.
 +</​note>​
 +
 +==== PDF Export ====
 +
 +Available in iTop 2.2.0 and later, a new menu item **Export as PDF** is available:
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-exporpdf.png?​nolink |"​Export as PDF..."​ menu }}
 +
 +This menu generates a PDF document with one big table containing one row per object in the list and one column for each selected field.
 +
 +The PDF export action displays a configuration dialog which allows to:
 +  * Select the page size for rendering the PDF: either A3, A4 or Letter
 +  * Select the orientation of the page: Portrait or Landscape
 +  * Pick the columns to be included in the export
 +  * Arrange the order of the columns
 +
 +{{ :​2_6_0:​user:​pdf-export-1.png?​nolink&​800 | "​Export as PDF..."​ configuration dialog }}
 +
 +<note tip>
 +To arrange the order of the columns, drag and drop the columns in the table displayed in the **Column order** section at the bottom of the dialog. To drag a column click in the **header** of the column.
 +</​note>​
 +
 +<note warning>
 +The PDF output is rendered with columns of equal widths (i.e. if there are 10 columns selected, each column will use 1/10th of the page width). It looks better when a relatively small (<10) number of columns is selected. Use the **Landscape** orientation if you need to generate a PDF with many columns.
 +</​note>​
 +
 +When you click on **Export**, the PDF document is created. If the list of objects to be exported is large (>1000), a progress bar is displayed. Once the export is complete, you can download the PDF file by clicking on the link **//Click here to download//​** at the top of the dialog box:
 +
 +{{ :​2_6_0:​user:​pdf-export-2.png?​nolink&​450 |PDF Export complete}}
 +
 +
 +
 +==== Add To Dashboard ====
 +
 +Every result displayed as a list can be added to one of the editable dashboards. Click on the menu **//Add to Dashboard//​**:​
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-dashboard.png |Toolkit operation: Add To Dashboard}}
 +
 +Then select the dashboard to which the list will be added and the type of "​Dashlet"​ to use:
 +
 +{{ :​2_6_0:​user:​add-to-dashboard.png |Add To Dashboard Dialog}}
 +
 +A list can be added to a dashboard either as:
 +  * A plain list of objects
 +  * A pie chart (By grouping the objects on a given field)
 +  * A bar chart (By grouping the objects on a given field)
 +  * A table with the count of objects, grouped on a given field
 +
 +When the user presses **Ok**, the new dashlet is added at the end of the selected dashboard (by adding a new cell after the last used cell). If **Edit the dashboard** is checked, then the modified dashboard is immediately opened in the dashboard editor.
 +
 +Refer to [[2_6_0:​user:​dashboards|Editing Dashboards]] for information about how to customize the resulting dashboard.
 +==== Create a Shortcut ====
 +
 +{{ :​2_6_0:​user:​list-toolkit-menu-shortcut.png |Toolkit operation: Create a Shortcut}}
 +
 +When prompted, enter the name for your new shortcut (this is the name that will appear under **My Shortcuts** in the menu), and click **//Ok//**.
 +
 +
 +{{ :​2_6_0:​user:​create-shortcut-3.png |New Shortcut Dialog}}
 +
 +The new shortcut is then added to the menu.
 +<note tip>
 +The minimum value for the **Refresh interval** is 5 seconds.
 +</​note>​
 +
 +<- search|Managing lists ^ start|User Manual ^ shortcuts|Shortcuts->​
2_6_0/user/lists.txt ยท Last modified: 2019/01/09 16:40 (external edit)

";