Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/4817244/breadcrumb.png

HTML
<h2>Introduction</h2>

<p>This report identifies any devices that are currently unused i.e. not making or receiving calls. Devices can include both
users and channels.</p>

<p>The report is ideal for identifying extensions that can be reallocated or lines that could possibly be cut.</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/unused_devices_1.png" alt="Unused devices" />

<h2>Running the report</h2>

<p>On the <span class="reference">Reports</span> screen, click on <span class="reference">Unused devices</span> in the reports list and then press the <span class="button">Select this report</span> button.</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/unused_devices_2.png" alt="Unused devices" />

<p>The following report selection criteria window appears:</p>

<h4>Reporting period</h4>

<p>Every report requires a period to run over. This is generally defined as the "Reporting period".</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/period_screen.png" alt="Unused devices" />

<p>There are several pre-defined periods that can be selected from a simple drop-down list as shown above.</p>

<p>The built-in periods are based on a standard Gregorian calendar and are defined as follows:</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 date and end date is set to the current date. The default 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>Yesterday</b></td>
			<td class="confluenceTd">The start date and end date is 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 Monday of the current week, whilst the end date is set to the current day. The default 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 last Monday, whilst 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 1<span class="exponent">st</span> day of the current month and the end date to today. The default 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. 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 date is set to the date of the first call in the database, whilst the end date is set to the date of the most recent call in the database. Times are also set to the times of the first and last calls in the database.</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>

<p>If you want to be more specific, you can choose the <span class="keyword">Custom period</span> from the bottom of the drop-down list. This option
will allow you to define the start date and end date yourself, as shown below. When you need to be even more specific,
you can also choose a start time and end time.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/custom_period_screen.png" alt="Unused devices" />

<p>When the report is executed, if the user has selected an in-built period, the reporting engine simply substitutes the start
and end dates based on the current date and the period the user selected.</p>

<p>Once you have set the report's period, click on the <span class="button">Next</span> button to set more of the report's features or select the <span class="button">Finish</span> button to run the report.</p>

<h4>What do you want to report on?</h4>

<p>In addition to the reporting period, each report offers you the opportunity to define exactly what you want to report on. This is
generally a site, group or user.</p>

<h5>Site</h5>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/entity_screen_1.png" alt="Unused devices" />

<p>TIM Plus will allow you to log information from up to five sites. If you want to report on a specific site, select that site from
the drop-down list or to select all sites' data, leave it at the default <span class="keyword">All sites</span> as shown above.</p>
Note
NOTE: The username and password you have been allocated may mean you are restricted to specific sites or groups. If you have any difficulty accessing other sites or group, please contact your system administrator and check that access has been enabled.
HTML
<h5>Group</h5>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/entity_screen_2.png" alt="Unused devices" />

<p>There is no limit to the number of groups available on each site. Groups, like sites are available as a drop-down list. You
can choose to select a specific group or leave at the default <span class="keyword">All groups</span>. Please note that the drop-down list for each
group can only appear if a site has already been selected.</p>

<h5>User</h5>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/entity_screen_3.png" alt="Unused devices" />

<p>Once a site and group has been selected, you can decide whether you would like to report on all users or select a
particular user from the drop-down list as shown above.</p>

<p>Once you have set the report's entities, click on the <span class="button">Next</span> button to set more of the report's features or select the <span class="button">Finish</span> button to run the report.</p>

<h4>Specific Options</h4>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/options_screen_unused_devices.png" alt="Unused devices" />

<p>This section allows you to add more specific filters to your report. The filters are fairly self-explanatory.</p>

<h5>Show "Do not log" devices</h5>

<p>Tick this box if you would like to display devices whose status has been set to "Do not log".</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/do_not_log_devices.png" alt="Unused devices" />

<h5>Sort order</h5>

<p>Choose whether you would like the results of the report to appear in ascending or descending order, by selecting from the
drop-down box.</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/sort_order.png" alt="Unused devices" />

<h5>Sort results by</h5>

<p>You may choose the order in which results are sorted by selecting the appropriate option from the list shown below:</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/sort_results_unused_devices.png" alt="Unused devices" />

<h2>Creating the report</h2>

<p>When you have chosen a reporting period, and are happy with your selections, you have two options:</p>

<ul>
	<li>Run the report now</li>
	<li>Schedule for future delivery</li>
</ul>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/run_report_screen.png" alt="Unused devices" />

<p>To choose your preferred option, select the appropriate button.</p>

<p>If you choose to run the report now, click the <span class="button">Run now</span> button. The results will appear immediately in your
chosen format.</p>

<p>To schedule the report for delivery at a later date, follow the instruction given on the <a href="Schedule a report">Schedule a report</a> section.</p>

<h2>Unused devices - The results</h2>

<p>When selecting <span class="reference">Web</span> as the output format, this report will appear as below.</p>

<p>The Web format allows for complete flexibility when viewing any report. To view details of any filters or selection parameters used in creating this report, simply click on <span class="link">About this report</span> at the top right of the page.</p> 

<p>As with all reports, the header of the report includes the report title, any name you may have given to it, and the date and
time it was run.</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/unused_devices_1.png" alt="Unused devices" />

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/unused_devices_3.png" alt="Unused devices" />

<p>All headers are clickable allowing you re-arrange the report layout in seconds, to sort the calls in ascending or decending order based on the header clicked.</p>

<p>The headers of this report are as follows:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh" width=110>Header</th>
			<th class="confluenceTh">Description</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Name</b></td>
			<td class="confluenceTd">The Name of any unused user or channel will appear. e.g. Joe Bloggs or Main ISDN.
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>ID</b></td>
			<td class="confluenceTd">The ID of any unused user or channel will appear. e.g. Ext 278 or 13578.
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Email</b></td>
			<td class="confluenceTd">If the user has an associated e-mail address in the directory, it will appear here.
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>DDI</b></td>
			<td class="confluenceTd">If the user has an associated DDI (Direct Dial No) in the directory, it will appear here.
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Mobile</b></td>
			<td class="confluenceTd">If the user has a mobile number associated with it in the directory, it will appear here.
			</td>
		</tr>
	</tbody>
</table>

<p>The Name and any associated ID for any unused user or channel will appear. If additional properties have been added
e.g. E-mail, DDI, Mobile etc. these properties will be displayed also.</p>

<p>If you would like to go back and view any report for a larger section of the organisation, simply click on the appropriate link in the breadcrumb as shown below:</p>

<img class="screenshot naked" src="http://www.tri-line.com/common/img/documentation/tim_plus/breadcrumb.png" alt="Breadcrumbs" />