Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML
<h2>Select a reporting period</h2>

<p>To set the report period, simply choose the report you'd like to run
 by clicking its name from the report list at the left-hand side of the 
screen. Then, click on the large <span class="button">Select this report</span> 
button to start the report wizard, as shown below:</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/run_report.png" alt="Run now button" />

<p>The pop-up window that appears allows you to choose the reporting period which is the 
first screen of the report wizard. You may choose from the preset reporting periods 
or enter your own specific date and time that the system should execute the report for you.</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/report_period.png" alt="Reporting period" />

<h4>Preset period</h4>

<p>To select from the preset periods, simply click on the down-arrow 
displayed alongside the periods and select from following preset 
options:</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/report_period_1.png" alt="Reporting period" />

<p>The period options are defined more fully below:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh" width=98>Period</th>
			<th class="confluenceTh">Description</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Today</b></td>
			<td class="confluenceTd">The start and end dates are set to the current date. The start time is set to <span class="keyword">00:00:00</span> and the end time to <span class="keyword">23:59:59</span>.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Yesterday</b></td>
			<td class="confluenceTd">The start and end dates are set to the current date minus one day. The start time is set to <span class="keyword">00:00:00</span> and the end time to <span class="keyword">23:59:59</span>.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>This week</b></td>
			<td class="confluenceTd">The start date is set to the first day (normally Monday) of the current week. The end date is set to the current day. The start time is set to <span class="keyword">00:00:00</span> 
			and the end time to the current time.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Last week</b></td>
			<td class="confluenceTd">The start date is set to the date of the last Monday, and the end date is set to the start date plus seven days. The start time is set to <span class="keyword">00:00:00</span> 
			and the end time to <span class="keyword">23:59:59</span>.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>This month</b></td>
			<td class="confluenceTd">The start date is set to the first day (normally Monday) of the current month. The end date is set to the current day. The start time is set to <span class="keyword">00:00:00</span> 
			and the end time to the current time.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Last month</b></td>
			<td class="confluenceTd">The start date for this period is set in three stages. The day is set to <span class="keyword">01</span>, the month is set to the current month minus one, or in the case of January, 
			it is set to <span class="keyword">12</span>. The year is set to the current year, unless it is a new year, in which case the year is reduced by one. The start and end times are set to 
			<span class="keyword">00:00:00</span> and <span class="keyword">23:59:59</span> respectively.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>This year</b></td>
			<td class="confluenceTd">The start date is set to the first day of the first month of the current year, whilst the end date is set to today's date. The start and end times are set to 
			<span class="keyword">00:00:00</span> and <span class="keyword">23:59:59</span> respectively.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>All calls</b></td>
			<td class="confluenceTd">The start and end dates and times are set to the date and time of the first and last call in the entire call database, respectively.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Custom period</b></td>
			<td class="confluenceTd">Enter the start and end dates and times into the boxes below. The start and end times are linked to their respective dates.</td>
		</tr>
	</tbody>
</table>

<h4>Custom period</h4>

<p>To define your own report period, simply select <span class="keyword">Custom period</span> from the drop-down list and enter in 
the <span class="reference">From date</span> and <span class="reference">To date</span> as well as the <span class="reference">From time</span> 
and <span class="reference">To time</span> fields as shown below:</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/report_period_2.png" alt="Reporting period" />

<h2>Run the report</h2>

<p>To run the report without setting any further parameters, simply click on the <span class="button">Finish</span> button. To continue adding parameters, click on the <span class="button">Next</span> button, which 
will lead you to the <a href="Entity">Entity</a> parameters.</p>
HTML
<p>To schedule a report to run in the future, and to set it to recur at 
frequent intervals, simply choose the report you'd like to run
 by clicking its name from the report list at the left-hand side of the 
screen. Then, click on the large <span class="button">Select this report</span>, 
as shown below:</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/schedule_report.png" alt="Schedule button" />

<p>As with running a report on demand, you will need to select the report period, 
entity and filters and options before scheduling.</p>

<p>Please refer to the pages below, to set the report parameters:</p>

<ul>
	<li><a href="Period">Setting the report Period</a></li>
	<li><a href="Entity">Setting the report Entity</a></li>
	<li><a href="Filters">Setting the report Filters</a></li>
	<li><a href="Options">Setting the report Options</a></li>
	<li><a href="Formats">Setting the report Formats</a></li>
</ul>

<p>The example below shows a <span class="reference">Busy channels</span> report. As no entity has been
 selected, it will run for the entire organisation. The report period 
has been set to <span class="reference">Last month</span> so ideally this report would be scheduled 
to recur monthly.</p> 

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/last_month_report.png" alt="Example of report scheduling" />

<p>When you've entered your period and criteria, press the <span class="button">Schedule</span> 
button. The report does not run, but instead a window appears which 
allows you determine the following:</p>

<ul>
    <li>When you would like the report to start running</li>
    <li>How frequently the report runs</li>
    <li>How the report is delivered</li>
    <li>Who receives the report</li>
</ul>

<p>The example below shows how the fields in this window may be filled in.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/schedule_panel_1.png" alt="Schedule panel" />

<h4>When do you want the first report to run?</h4>

<p>Enter the exact date and time that you want the report to run in the <span class="reference">Start running the report on</span>
 fields. Enter the day, select the month from the drop-down list, enter 
the year. Then enter the time in the form 'hh:mm:ss' (hours, minutes 
and seconds).</p>

<h4>How often do you want the report to recur?</h4>

<p>If you want the report to recur, you can set the frequency by 
selecting from the drop-down list and entering a preceeding digit e.g. 2
 days, 1 week, 1 month etc.</p>

<h4>How do you want the report delivered?</h4>

<p>Choose the delivery method from the list and then choose the destination.</p>

<table class="confluenceTable">
    <tbody>
        <tr>
            <th class="confluenceTh" width=120>Delivery method</th>
            <th class="confluenceTh">Description</th>
        </tr>
        <tr>
            <td class="confluenceTd"><b>E-mail</b></td>
            <td class="confluenceTd">Enter the e-mail address in the <span class="reference">Recipient e-mail address</span> box. E-mail 
                addresses that you have stored against users are available by clicking 
                the <span class="button no_margin">Find</span> button. You can also type an e-mail address that is not 
                alreay stored. If you want to schedule delivery to more than one person,
                 simply use a ';' or ',' to separate the e-mail addresses listed.</td>
        </tr>
        <tr>
            <td class="confluenceTd"><b>File</b></td>
            <td class="confluenceTd">Type the location and filename where you want the file to be saved. For example, enter <span class="keyword">C:\My Reports\My Call Analysis.html</span></td>
        </tr>
        <tr>
            <td class="confluenceTd"><b>FTP</b></td>
            <td class="confluenceTd">Fill in the FTP options in the boxes displayed and select <span class="button no_margin">Schedule</span>.</td>
        </tr>
        <tr>
            <td class="confluenceTd"><b>HTTP POST</b></td>
            <td class="confluenceTd">Select HTTP POST as the Method of delivery and fill in the boxes.</td>
        </tr>
    </tbody>
</table>

<p>After entering the scheduling details, click on the <span class="button">Schedule</span> button to 
return to the main Reports screen. Notice that your newly scheduled 
reports are now listed in the <span class="reference">Scheduled Reports</span> list. To access this 
list, simply click on the <span class="button">Scheduled reports</span> tab at the top left hand 
side of the screen as shown below:</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/schedule_panel_2.png" alt="Schedule panel" />

Summary_list
Task1Preparing the report
Task2Setting the scheduling parameters
Task3Editing a scheduled report
Task4Deleting a scheduled report

HTML
<a id="Preparing the report"></a>

Preparing the report

To schedule a report, choose the one you want to run from the list in the left-hand panel, then click on the Select this report button to start the report wizard, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/select_report.png

In the same way as with running a report on demand, you can modify the report period, entity, filters, options and format before scheduling, by referring to the relevant pages below:

If you do not want to change any of the default settings, click on the Finish button, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_1.png

Once you have selected your report's parameters, click on the Schedule for later button.

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_2.png

In the new window that opens you can set the scheduling parameters of the report:

  • when you want the report to first run
  • how frequently you want the report to run
  • how you want the report delivered
  • who should receive the report
HTML
<a id="Setting the scheduling parameters"></a>

Setting the scheduling parameters

When do you want the first report to run?

Enter the future date and time that you want the report to run at, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_4.png

How often do you want the report to recur?

If you want the report to recur, tick the

Referencemacro
LabelRepeat the report
box and select the frequency for re-runs from the drop-down list, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_5.png

How do you want the report delivered?

The report can be delivered by e-mail or saved as a file to a specific location, by choosing a delivery method from the drop-down list:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_6.png

Who receives the report?

Delivery methodDescription

E-mail

  • Enter the e-mail address that you want the report to be delivered to
  • If you want the report to be e-mailed to more than one person, separate each address using the ; symbol.

File
  • Type the full filename, including folder, of the location that you want the report to be saved as, e.g. C:\My Reports\My Call Analysis.html
  • The filename can include the following variables:
VariableDescription
Keywordmacro
Label{year}
The current year
Keywordmacro
Label{month}
The current month
Keywordmacro
Label{week}
The current week number
Keywordmacro
Label{day}
The current day of the month
Keywordmacro
Label{hhmmss}
The time that the report ran, in a compact hours, minutes and seconds format
Keywordmacro
Label{name}
The name given to the report
Keywordmacro
Label{uiv}
A unique numeric report identifier
  • To save the report to a network share, specify the filename using a UNC path. You must ensure that the user account running the TIM Plus service has access privileges to write to the file you have specified.

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_7.png

Schedule now

When you have configured the scheduling parameters, click on the Schedule now button to save the report's definition.

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_8.png

Notice that your newly-scheduled reports are now listed in the Scheduled reports panel at the bottom of the screen, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_9.png

Info

The properties of a scheduled reports are web user specific, and can be seen or edited only by the web user that initially added the report in the system.

HTML
<a id="Editing a scheduled report"></a>

Editing a scheduled report

To edit a scheduled report, select it from the Scheduled reports panel, and click on the Properties button, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_10.png

A new window with the properties of the report will open, where you can edit the period, entity, filters, options and format of the report.

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_11.png

Click on the links below for details of how to configure these parameters:

HTML
<a id="Deleting a scheduled report"></a>

Deleting a scheduled report

To delete a scheduled report, select it from the Scheduled reports panel and click the Delete button, as shown below:

Screenshotmacro
Borderfalse
URL/download/attachments/4817134/schedule_report_12.png