About WebApps Administration Help Desk History Export

Administrators can export Help Desk History details to a CSV file for analysis and reporting purposes by using WebApps Administration. The Help Desk application is used to manage and troubleshoot user jobs that appear in the In Process and History folders. An Export action and columns can be added to the History folder. Columns are created with the use of system or user-defined job properties.

Note: Use Configuration > Job Properties to look up system or user-defined job properties that you can add as Export columns.

Before you begin

Administrators must complete the following tasks.

Note: WebApps Administration is set up by default during the WebApps installation and appears in the default Admin profile.

Adding the Export action

Use the default Admin profile or select the appropriate profile to add the Export action.

Note: WebApps Administration must be set up in any custom Administrator profiles created before adding the Export action.

The following instructions show how to add the Export action using the default Admin profile. These instructions are for illustrative purposes and may not reflect your unique workflow requirements.

To add the Export action

  1. In the Server Administrator, go to Configuration > WebApps.

  2. Select Admin in the Profile details pane. The Admin Profile Properties dialog box appears.

  3. Select the Applications tab.

  4. Select the Administration application. The Administration Application Properties dialog box appears.

  5. Select the Applications tab.

  6. Select Help Desk. The Help Desk Application Properties dialog box appears.

  7. Select the Applications tab.

  1. Select History.

  2. Select the Actions tab.

  3. Select the Add button

  4. Select Export. The Export Action Properties dialog box appears.

  5. Continue with Adding the Export columns.

Adding the Export columns

The columns you want to export need to be added and defined after adding the Export action.

In the following example, an Administrator wants a group of Help Desk power users to export the following History details to a CSV file for monthly review.

  • Job ID

  • Sender

  • Destination

  • Sent

You can add any columns you want to use for exporting by using system or user-defined job properties. Determine which job properties you want for your export. You will need to know the correct syntax when adding the Export columns, for example, %{propertyname}%.

Note: Use Configuration > Job Properties to look up system or user-defined job properties that you can add as Export columns.

To add Export columns

  1. In Export Action Properties, select the Columns tab.

  2. Select the Add header row check box to add the column headings to the CSV file if necessary.

  3. Select the Add button. The Export Column Properties dialog box appears.

  4. Select the Header > Text drop down list arrow for a list of the columns.

  5. Scroll down to @Column and select @ColumnJobID.

Note: You can use the @Column options or type the column header text.

  1. Type the %{JobID}% in the Content > Text box.

  1. Select OK. The Job ID column appears in the Text/Value table.

  2. Select the Add button.

  3. Select @ColumnSender from the Header > Text drop down list.

  4. Type %{Originator}% in the Content > Text box.

  5. Select OK.

  6. Select @ColumnDestination from the Header > Text drop down list.

  7. Type %{Destination}% in the Content > Text box.

  8. Select OK.

  9. Select the Add button.

  10. Select @ColumnDateSent from the Header > Text drop down list.

  11. Type %{DateSubmitted}% in the Content > Text box.

See the Export Action Properties dialog box example below.

  1. Select OK.

  2. Ensure all columns and values appear in the Text/Value table.

  3. Select OK on the Export Action Properties dialog box.

  4. Select OK on the History Application Properties dialog box.

  5. Select OK on the Help Desk Application Properties dialog box.

  6. Select OK on the Administration Application Properties dialog box.

  7. Select OK on the Admin Profile Properties dialog box.

Using WebApps Administration Help Desk History Export

Use the Export button on the Help Desk > History toolbar to export data details to a CSV file.

To export to a CSV file

  1. Open WebApps from your browser.

  2. Select Administration.

  3. Select Help Desk.

  4. Select History.

  5. Search and filter the History details for the export if necessary.

Note: All details are exported if you do not filter the History folder. You can also select specific rows/details in the table you want to export. Both methods are acceptable, search or by mouse selection.

See the Search by Sender example below.

  1. Select the Export button on the toolbar. The Export button automatically generates the CSV file.

  2. Download the CSV file.

See the CSV Notepad example below.

Note: The CSV file shows the Job ID, Sender, Destination Email Address and Date/Time Sent column headings and details. Some of the data in this example has been intentionally obscured.

See also

Using WebApps Administration

Adding Route to Destination Column