Versions Compared

Key

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

...

The Unused Devices report identifies any users and channels that haven't been utilised over in a given period of time. This report It is ideal useful for identifying phone telephone handsets that can be safely reallocated to other users or to see which channels are no longer used.

...

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

Running the report

On the the Reports screen screen, click on select the Unused devices in the reports list and then press the  report from the left-hand pane and click the Select this report button button.

Screenshotmacro
Borderfalse
URL/download/attachments/4817261/unused_devices_2.png

A new window will appear, where you can select set the criteria for parameters of your report.

Selecting the reporting period

Every report requires a period to run overFor each report, you must specify a time span that covers the calls you want the report to include. This is generally defined known as the "Reporting reporting period".

Screenshotmacro
Borderfalse
URL/download/attachments/4817244/period_general.png

There are several preset periods that can be selected from a drop-down list. The predefined periods are based on a standard Gregorian calendar and are defined as followsreporting periods available for selection, based on the standard Gregorian calendar. The following table describes how the start and end times are defined for each preset period:

PeriodDescription
TodayThe start and end dates are set to the current date. The start time is set to 00:00:00 and the end time to 23:59:59.
YesterdayThe start and end dates are set to the current date minus one day. The start time is set to 00:00:00 and the end time to 23:59:59.
This weekThe start date is set to the first day of the current week (normally Monday) of the current week. The end date is set to the current day. The start time is set to 00:00:00 and the end time to the current time.
Last weekThe 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 00:00:00 and the end time to 23:59:59.
This monthThe start date is set to the first day of the current month. The end date is set to the current day. The start time is set to 00:00:00 and the end time to the current time.
Last monthThe start date for this period is set in three stages. : The day is set to 01, the first day of the month. The month is set to the current month minus one, or in the case of January, it is set to 12previous month. The year is set to the current year, unless it is a new yearcurrently January, in which case, the previous year is reduced by oneused. The start and end times are set to 00:00:00 and 23:59:59 respectively.
This yearThe 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 00:00:00 and 23:59:59 respectively.
All callsThe start and end dates and times are set to the date dates and time times of the first and last call in the entire call database, respectively.

In addition to the presets described above, it is possible to specify a custom reporting period by choosing Custom period

...

If you want to be more specific, you can choose the Custom period from the drop-down list. This option will allow you to define the Start date and End date yourself, as well as the Start time and End time of the calls  from the 

Referencemacro
LabelPeriod
 drop-down list and specifying your own  
Referencemacro
LabelStart date
Referencemacro
LabelStart time
Referencemacro
LabelEnd date
 and 
Referencemacro
LabelEnd time
 of the period you want to report on.

Screenshotmacro
Borderfalse
URL/download/attachments/4817245/account_summary_3.png

When the report is executed, the reporting engine will substitute the start and end dates based on the current date or the relevant selection made by the user.

Once you have set the report's reporting period, click on thethe Nextbutton  button to set more of the additional report 's parameters and options, or select thethe Finishbutton  button to run the report immediately.

Selecting the reporting entity

The reporting Reporting entity paramater  parameter allows you to select which the part of your organisation you want to run the report for (site, extension group, channels or individual extensions)whose calls the report should include, e.g. a site, a group or an individual user.

Screenshotmacro
Borderfalse
URL/download/attachments/4817244/entity_general.png

Site

TIM Plus will allow you to log information from up to five sites. If you want to To report on a particular site, select your preferred site it from the drop-down list , alternatively leave the default settings as or select All sites .

Reporting_filter
FilterSitesSite
ValueAll sites

Tip

The username and password you have been allocated might be restricted to a specific site or group. If you need additional permissions, please contact your system administrator.

Group

...

Group

If a site has been selected, you are able to further limit the report's results by selecting a group from the drop-down list.

Reporting_filter
FilterGroupsGroup
ValueAll groups

Please note that the drop-down list for each group will appear only if a site has already been selected.

User

...

User

If both a site and group has have been selected, you can also choose to report on further limit the report's results to include only calls involving a particular user, by selecting that user from the drop-down list, or you can leave the default setting as All users.

Reporting_filter
FilterUser
ValueAll users

Tip

If your web account is restricted to a specific site or group, only those entities to which you have access will be available in the drop-down lists.

Once you have set selected the scope of your report's entities, click  click on thethe Nextbutton  button to set more of the report's features or select theFinishbutton additional report parameters and options, or to run the report immediately, click the Finish button.

Selecting the report options

This section allows you to further narrow down You can limit the results of your report results, by excluding certain types of calls or sorting the results in a particular manner. The filters are fairly self-explanatory.by choosing one or more of the following filters:

Screenshotmacro
Borderfalse
URL/download/attachments/4817261/unused_devices_options.png

...

Tick this box if you would like to display include devices whose status has been is set to "Do not log "calls.

Reporting_option
OptionShow "Do not log" devices

Sort order

Expanding the drop-down list available, you can choose whether you would like Choose from the 

Referencemacro
LabelSort order
 drop-down list whether you want the results of the your report to appear in ascending or descending order.

Reporting_filter
FilterSort order
ValueAscendingOption

Sort

...

Sort results by

...

results by

To sort your report's results by a particular column, select it from the 

Referencemacro
LabelSort results by
 drop-down list.

Reporting_filter
FilterSort results by
ValueDayDate & time

Selecting the report format

 This section allows you to choose the output media format of your completed report. To select the desired format, click on the drop-down list and choose from the available options: Web, PDF, Excel, CSV and XML. The formats available are 

Referencemacro
LabelWeb
Referencemacro
LabelPDF
Referencemacro
LabelExcel
Referencemacro
LabelCSV
 and 
Referencemacro
LabelXML
.

More details about each report format are available in the the Setting the report format section  section above.

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

Creating the report

When you have chosen selected a reporting period , and are happy with your selections, you have two options:

...

and have chosen any filters and options, you can either run the report immediately by clicking on the 

Buttonmacro
LabelRun now
 button, or schedule it for future delivery.

Screenshotmacro
Borderfalse
URL/download/attachments/4817244/creating_the_report.png

If you click on the Run now button, the report will run instantly in your chosen format.

If you want to schedule the report to run at a later time, follow the instruction given in the Schedule a report section.

HTML
<a id="The report's results"></a>

The report's results

When selecting WEB as the output format, this report will appear as below. To view details of any filters or selection parameters used in creating this report, simply click on About this report on the top-right corner of the page.Below is an example of this report's output in Web format, showing both unused users and unused channels:

Screenshotmacro
Borderfalse
URL/download/attachments/4817261/unused_devices_1.png

Screenshotmacro
Borderfalse
URL/download/attachments/4817261/unused_devices_3.png

The Web format is the most interactive of all formats: all column headers are click-sortable and most graphical and tabular elements can be drilled down into, allowing deeper analysis of your results. By clicking on the About this report link at the top-right corner of the page, you can review any filters and options that have been applied to the report.

As with all reports , the header produced by TIM Plus, each page of the report includes the following information:

  • the report's title
  • the date and time of that the report was generated
  • the name of the report, if applicable

The WEB format allows for complete flexibility when viewing any report. All headers are clickable, allowing you to re-arrange the report layout in seconds, to sort the calls in ascending or decending order based on the header clicked.The headers of this report are as followsresults will display as a paginated list of unused devices with each type of device being grouped in its own tab:

The 

Tabmacro
LabelUsers
 tab shows the following information:

HeaderDescription
NameThe Name name of any unused user or channel will appear. e.g. Joe Bloggs or Main ISDN.the user
IDThe ID of any unused user or channel will appear. e.g. Ext 278 or 13578.EmailIf the user has an associated extension number associated with the user
EmailThe e-mail address in the directory, it will appear here.associated with the user
DDIIf The DDI associated with the user has an associated DDI (Direct Dial No) in the directory, it will appear here., if available
MobileIf the user has a The mobile number associated with it in the directory, it will appear here.

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.

...

user, if available

The 

Tabmacro
LabelChannels
 tab shows the following information:

HeaderDescription
NameThe name of the channel
IDThe ID associated with the channel

To modify your report to cover a larger organisational scope, click on an element of the breadcrumb as shown below:

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" />