Creating Reports for Users

Download this manual as a PDF file

This section describes how an administrative user can create a report job for a specific customer and schedule that report job.

Use the following menu options to navigate the SL1 user interface:

  • To view a pop-out list of menu options, click the menu icon ().
  • To view a page containing all of the menu options, click the Advanced menu icon ().

Creating a Report Job

You can define a report job in the Report Jobs page (Reports > Create Report > Report Jobs). From this page, you can create a report job, run the report job, edit the report job, or delete the report job.

To create a report job for a customer:

  1. On the Reports page (), expand the entry for Create Report and select Report Jobs. The Report Jobs page appears.

  1. Click the Create button. The Report Job Editor page appears:

  1. The Report Job Editor page contains fields where you can select the parameters of the report job. The fields are:
  • Job Title. Specify a title of up to 220 characters for the report job.
  • Run as User. Specify the type of user to run the report as. When a scheduled report uses this report job, the report generates as if the Run As User was running the report. This field is useful when a system administrator, who can access all entities in all organizations, is configuring a report job for a regular user, who is allowed to access only entities aligned with the regular user's organizations. Two access hooks affect the behavior of the Run As User field:
  • Run As Org User. If this Access Hook is included in an Access Key that is aligned with your account, the Run As User field will contain a list of users with the same primary organization as your own. You can select one of these users to align with the generated report.
  • Run As Any User. If this Access Hook is included in an Access Key that is aligned with your account, you will be able to schedule report jobs as any user. The Run As User field will contain a list of all users. You can select one of these users to align with the generated report.

    If your user account does not include either of these Access Hooks, you can schedule report jobs only as yourself. The Run As User field will not appear in the Report Job Editor page. For more information on organization restrictions, see the section on Access Permissions.

  • Report Definition. Select a report from the list of all reports defined in the Report Management page. Only report definitions to which you are allowed access will appear in this field. When you select the report, the Report Options section for that specific report appears at the bottom of the Report Job Editor page.
  • Report definitions are listed by category. If a report definition is not associated with a category, that report definition appears under the "Other" category. To assign or change a category for a report definition, edit the Category field in the Report Template Editor page (Reports > Management > Report Manager > create/edit).

  • Report Appliance. Select the appliance on which to run the report, if more than one appliance is available. By default the current appliance is selected. If you select "Active Database", SL1 locates the active database server at run time and will execute the report on that database server.
  • Job Recipients. Specifies the recipients for the report. Clicking in this field displays the Add Recipients modal page, where you can select users, external contacts, and vendor contacts to include in the Job Recipients field. To learn how to add job recipients to the report job, see Step 4, below.
  • Job Type. Specifies how the generated report will be delivered. Choices are:
  • Email & Archive. Report is emailed to the specified email address (in the Email To field) and also archived on the server.
  • Archive. Report is stored on the server.

  • Delivery Method. Specifies the method of delivery and the output format (if applicable) for the report. Choices are:
  • Inline (HTML). The generated report will be sent to the selected users in the body of an Email.
  • Attachment. The generated report will be sent to the selected users as an attachment to an Email. To select this option, select one of the output formats in the Attachment section of the drop-down list.
  • Link to EM7. The generated report will be made available via a direct URL. The link will be sent to the selected users in an email. To select this option, select one of the output formats in the Link to EM7 section of the drop-down list.

For the Attachment and Link to EM7 options, the following output formats are available:

  • Adobe Acrobat Document (.pdf)
  • Web page (.html)
  • Microsoft Excel 2007+ Spreadsheet (.xlsx)
  • Open Document Format (ODF) Spreadsheet (.ods)

    The options that can be selected in the Delivery Method field are defined in the Delivery Method field in the Report Template Editor page for the selected report.

  • Report Options. The interface for the selected report appears in this pane. Select the options you want included in the automatically generated report. These options are limited by the Access Keys aligned with your account and the organization memberships aligned with your account.
  1. You can add recipients to a report in the Add Recipients modal page. The Add Recipients modal page allows you to select users, external contacts, and vendor contacts to include in the "To" field of the Job recipients field:

  2. The options in the Add Recipients modal page are:
  • Recipient Types. Displays checkboxes for EM7 User, External Contact, and Vendor. If a checkbox is selected, the users in the selected contact group will appear in the Matched Recipients field.
  • Search For. Select All recipients, Organization, Product, or Ticket Queue. The Matched Recipients field will display only users in the specified group.
  • Search. Enter the name of the user, external contact, or vendor you are searching for.
  • Matched Recipients. Displays the possible recipients based on the criteria you specified in the Recipient Types and/or Search For and/or Search fields.
  1. To add a user, external contact, or vendor as a job recipient, select its checkbox. To select all users displayed in the Matched Recipients field, select the checkbox next to the Action heading.
  2. Click the Add/Remove button to add the selected users. To remove users as job recipients, de-select users by removing the check mark and then clicking the Add/Remove button.
  3. On the Report Jobs page, click the Save button. The new report job will appear in the list of report jobs in the Report Jobs page.

Scheduling a Report Job

After you create a report job, you can schedule that report to run once, at a specified time, or at specified regular intervals.

To add a scheduled or recurring report to the calendar:

  1. On the Reports page (), expand the entry for Create Report and select Scheduler. The Schedule Manager page appears.
  2. Click Create. The Schedule Editor page appears:

  1. On the Schedule Editor modal page, enter values in the following fields:

Basic Settings

  • Schedule Name. Type a name for the scheduled process.

  • Schedule Type. Indicates the scheduled process type (such as Tickets, Reports, or Devices).

  • Visibility. Select the visibility for the scheduled process. You can select one of the following:
  • Private. The scheduled process is visible only to the owner selected in the Owner field.

  • Organization. The scheduled process is visible only to the organization selected in the Organization field.
  • World. The scheduled process is visible to all users.
  • Organization. Select the organization to which you want to assign the scheduled process.
  • Owner. Select the owner of the scheduled process. The default value is the username of the user who created the scheduled process.
  • Preserve Schedule. Select this checkbox to exclude this schedule from being pruned after expiration.
  • Description. Type a description of the scheduled process.

Time Settings

  • Start Time. Click in the field and select the date and time you want the scheduled process to start.

  • Time Zone. Select the region or time zone for the scheduled start time.

If you want SL1 to automatically adjust for daylight savings time (if applicable), then you must select a named region (such as America/New York) in the Time Zone field. If you select a specific time zone (such as EST) or a specific time offset (such as GMT-5), then SL1 will not automatically adjust for daylight savings time.

  • Recurrence. Select whether you want the scheduled process to occur once or on a recurring basis. You can select one of the following:
  • None. The scheduled process occurs only once.
  • By Interval. The scheduled process recurs at a specific interval.
  • Every Xth day of the Week. The scheduled process occurs at a monthly interval based on a day of the week. The day of the week displayed in this option matched the day selected in the Start Time field. For example, if you set the Start Time to Thursday, August 5th and that day is the first Thursday of the month, then the recurrence option will be Every 1st Thursday, and the scheduled process will occur monthly on the first Thursday of the month.

If you select By Interval, the following additional fields appear:

  • Interval. In the first field, enter a number representing the frequency of the scheduled process, then select the time interval in the second field. Choices are Minutes, Hours, Days, Weeks, or Months. For example:
  • If you specify "6 Hours", then the scheduled process recurs every six hours from the time listed in the Start Date field.

  • If you specify "10 Days", then the scheduled process recurs every 10 days from the date listed in the Start Date field.
  • If you specify "2 Weeks", then the scheduled process recurs every two weeks, on the same day of the week as the Start Date.
  • If you specify "3 Months" the ticket recurs every three months, on the same day of the month as the Start Date.

  • Recur Until. Specifies when the scheduled process stops recurring. You can select one of the following:
  • No Limit. The scheduled process recurs indefinitely until it is disabled.
  • Specified Date. The scheduled process recurs until a specific date and time. If you select Specified Date, you must enter a date and time in the Last Recurrence field.

  • Last Recurrence. Click in the field and select the date and time you want the scheduled process to stop recurring.

Action Settings

  • Report Job. Select the report job to generate the report. This drop-down includes all created report jobs in the system.

  1. Click Save.