TimeCardView 7.0 Command Reference
First released: January 2009
Last updated: January 21, 2009
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-17596-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome
to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS,
Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS,
Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step,
Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone,
MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase,
SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of
Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0812R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.
TimeCardView 7.0 Command Reference
© 2009 Cisco Systems, Inc. All rights reserved.
CONTENTS
Using TimeCardView Software
1
Understanding Command Modes
1
Entering the Command Environment
Prerequisites 2
Getting Help
2
3
Using the no and default Forms of Commands
Saving Configuration Changes
4
Identifying Supported Platforms
TimeCardView Commands
5
7
copy timecardview timesheets url
daily
4
9
11
database purge schedule days
13
disable (TimeCardView user configuration mode)
enable (TimeCardView configuration mode)
17
enable (TimeCardView user configuration mode)
groupname tcv-payroll-specialists
15
18
19
groupname tcv-payroll-specialists privilege tcv-payroll
maxsessions
22
notification email address
24
payroll server quickbooks address
26
payroll server synchronization schedule
service timecardview
31
service timecardview session terminate
service timecardview synchronize now
session-expiry-time
28
30
service timecardview purge now
shift limit
21
33
34
35
36
show supervisor
show supervisors
38
40
show timecardview configuration
42
TimeCardView 7.0 Command Reference
OL-17596-01
iii
Contents
show timecardview sessions
show timecardview status
show timecardview users
44
45
47
show user detail username
49
show user supervisor username
timecardview username
user-interface phone-call
53
55
user-interface phone-service
username
51
56
57
username (epage)
week-start day
59
61
TimeCardView 7.0 Command Reference
iv
OL-17596-01
Using TimeCardView Software
First Published: January 2009
Revised: January 21, 2009
This guide contains TimeCardView configuration mode commands, and also Cisco Unity Express
commands that are relevant to TimeCardView.
This chapter provides helpful tips for understanding and configuring TimeCardView software using the
command-line interface (CLI). It contains the following sections:
•
Understanding Command Modes, page 1
•
Entering the Command Environment, page 2
•
Getting Help, page 3
•
Using the no and default Forms of Commands, page 4
•
Saving Configuration Changes, page 4
•
Identifying Supported Platforms, page 5
Understanding Command Modes
The TimeCardView CLI commands have a structure very similar to that of Cisco IOS CLI commands.
However, the TimeCardView CLI commands do not affect Cisco IOS configurations.
Because TimeCardView is available as an add-on package to Cisco Unity Express, with which it
co-resides on a service module, you log into the Cisco Unity Express module to access TimeCardView.
After you have logged in to the Cisco Unity Express module, the command environment is no longer the
Cisco IOS environment.
The Cisco Unity Express command environment is divided into two modes:
•
Cisco Unity Express EXEC—This is the mode that you are in after you log in to the
Cisco Unity Express command environment. Cisco Unity Express EXEC commands affect the
system’s parameters in different ways. Some commands only display or clear parameter values, stop
or start the entire system, or start troubleshooting procedures. However, unlike Cisco IOS EXEC
mode, Cisco Unity Express EXEC mode has a few commands that change parameter values. These
changes are stored in the module’s flash memory, instead of in the startup configuration, so that the
system has some minimum information available if a catastrophic event such as a power or disk
failure occurs.
TimeCardView 7.0 CLI Administrator Guide
OL-17596-01
1
Using TimeCardView Software
Entering the Command Environment
•
Cisco Unity Express Configuration—This mode permits you to make system configuration changes,
which are stored in the running configuration. If you later save the running configuration to the
startup configuration, the changes made with the configuration commands are restored when the
software is rebooted.
Cisco Unity Express configuration mode has several subconfiguration levels. The global
configuration mode changes the command environment from EXEC to configuration. You can
modify many software parameters at this level. However, certain configuration commands change
the environment to more specific configuration modes where modifications to the system are
entered. For example, the service timecardview command changes the environment from config to
config-timecardview. At this point, you can enter or modify application parameter values.
The commands available to you at any given time depend on the mode that you are currently in. Entering
a question mark (?) at the CLI prompt displays a list of commands available for each command mode.
The descriptions in this command reference indicate each command’s environment mode.
Table 1 describes how to access and exit various common command modes of the Cisco Unity Express
software. It also shows examples of the prompts displayed for each mode.
Table 1
Accessing and Exiting Command Modes
Command Mode
Access Method
Prompt
Exit Method
Cisco Unity Express
EXEC
When the Cisco Unity Express se-10-0-0-0#
software prompt appears, enter
the enable command.
Use the exit command or press
CTRL-SHIFT-6, and then enter
x.
Cisco Unity Express
configuration
se-10-0-0-0(config)#
From EXEC mode, use the
configure terminal command.
To return to EXEC mode from
configuration mode, use the end or
exit command.
TimeCardView
configuration
From Cisco Unity Express
configuration mode, use the
service timecardview
command.
se-10-0-0-0(config-timecardview)#
To return to Cisco Unity Express
configuration mode, use the end or
exit command.
TimeCardView user
configuration
From Cisco Unity Express
configuration mode, use the
timecardview username
command.
se-10-0-0-0(config-tvuser)#
To return to Cisco Unity Express
configuration mode, use the end or
exit command.
Entering the Command Environment
Use this procedure to enter the command environment.
Prerequisites
The following information is required to enter the command environment:
•
IP address of the router that contains the Cisco Unity Express module
•
Username and password to log in to the router
•
Slot number of the module
TimeCardView 7.0 CLI Administrator Guide
2
OL-17596-01
Using TimeCardView Software
Getting Help
SUMMARY STEPS
1.
Open a Telnet session.
2.
telnet ip-address
3.
Enter the user ID and password of the router.
4.
service-module service-engine slot/port session
5.
enable
DETAILED STEPS
Command or Action
Purpose
Step 1
Open a Telnet session.
Use a DOS window, a secure shell, or a software
emulation tool such as Reflection.
Step 2
telnet ip-address
Specifies the IP address of the router containing the
Cisco Unity Express module.
Example:
C:\> telnet 172.16.231.195
Step 3
Username:
Password:
Enter your user ID and password for the router.
Step 4
service-module service-engine slot/port session
Enters the Cisco Unity Express command environment
using the module located in the specified slot and port.
The prompt changes to “se” with the IP address of the
Cisco Unity Express module.
Example:
Router# service-module service-engine 1/0
session
Note
If the message “Trying ip-address
slot/port ... Connection refused by
remote host” appears, enter the command
service-module service-engine slot/port
session clear
Step 5
and retry this step.
Enters Cisco Unity Express EXEC mode. You are ready
to begin the configuration tasks.
enable
Example:
se-10-0-0-0# enable
Getting Help
Entering a question mark (?) at the CLI prompt displays a list of commands available for each command
mode. You can also get a list of keywords and arguments associated with any command by using the
context-sensitive help feature.
TimeCardView 7.0 CLI Administrator Guide
OL-17596-01
3
Using TimeCardView Software
Using the no and default Forms of Commands
To get help specific to a command mode, a command, a keyword, or an argument, use one of the
following commands in Table 2:
Table 2
Help Commands
Command
Purpose
help
Provides a brief description of the help system in any command
mode.
abbreviated-command-entry?
Provides a list of commands that begin with a particular character
string. Do not enter a space between command and question mark.
abbreviated-command-entry<T
ab>
Completes a partial command name.
?
Lists all commands available for a particular command mode.
command ?
Lists the keywords or arguments that you must enter next on the
command line. Include a space between command and question
mark.
Using the no and default Forms of Commands
Where available, use the no form of a command to disable a function. Use the command without the no
keyword to reenable a disabled function or to enable a function that is disabled by default. The command
reference entry for each command provides the complete syntax for the configuration commands and
describes what the no form of a command does.
Configuration commands can also have a default form, which returns the command settings to the
default values. In those cases where a command is disabled by default, using the default form has the
same result as using the no form of the command. However, some commands are enabled by default and
have variables set to specific default values. In these cases, the default form of the command enables the
command and sets the variables to their default values. Where available, the command reference entry
describes the effect of the default form of a command if the command functions differently than the no
form.
Saving Configuration Changes
Starting in Cisco Unity Express EXEC mode, use the following command to copy the running
configuration in flash memory to another location:
copy running-config {ftp:user-id:password@ftp-server-address[/directory] |
startup-config | tftp:tftp-server-address} filename
Keyword or Argument
Description
ftp:user-id:password@
Username and password for the FTP server. Include the colon (:) and the
at sign (@) in your entry.
ftp-server-address
IP address of the FTP server.
/directory
(Optional) Directory on the FTP server where the copied file will reside.
If you use it, precede the name with the forward slash (/).
startup-config
Startup configuration in flash memory.
TimeCardView 7.0 CLI Administrator Guide
4
OL-17596-01
Using TimeCardView Software
Identifying Supported Platforms
tftp:tftp-server-address
IP address of the TFTP server.
filename
Name of the destination file that will contain the copied running
configuration.
When you copy the running configuration to the startup configuration, enter the command on one line.
In the following example, the running configuration is copied to the startup configuration as file start. In
this instance, enter the command on a single line.
se-10-0-0-0# copy running-config startup-config start
When you copy to the FTP or TFTP server, this command becomes interactive and prompts you for the
information. You cannot enter the parameters on one line. The following example illustrates this process.
In the following example, the running configuration is copied to the FTP server, which requires a
username and password. The IP address of the FTP server is 172.16.231.193. The running configuration
is copied to the configs directory as file saved_start.
se-10-0-0-0# copy running-config ftp:
Address or name of remote host? admin:[email protected]/configs
Source filename? saved_start
Identifying Supported Platforms
Cisco IOS software is packaged in feature sets consisting of software images that support specific
platforms. Specific software images are required to support the Cisco Unity Express network module.
The feature sets available for a specific platform depend on which Cisco IOS software images are
included in a release. To identify the set of software images available in a specific release or to find out
if a feature is available in a given Cisco IOS software image, use Cisco Feature Navigator at the
following URL: http://tools.cisco.com/ITDIT/CFN/jsp/index.jsp.
TimeCardView 7.0 CLI Administrator Guide
OL-17596-01
5
Using TimeCardView Software
Identifying Supported Platforms
TimeCardView 7.0 CLI Administrator Guide
6
OL-17596-01
TimeCardView Commands
First published: January 2009
Revised: January 21, 2009
This guide contains TimeCardView configuration mode commands, and also Cisco Unity Express
commands that are relevant to TimeCardView.
copy timecardview timesheets url, page 9
daily, page 11
database purge schedule days, page 13
disable (TimeCardView user configuration mode), page 15
enable (TimeCardView configuration mode), page 17
enable (TimeCardView user configuration mode), page 18
groupname tcv-payroll-specialists, page 19
groupname tcv-payroll-specialists privilege tcv-payroll, page 21
maxsessions, page 22
notification email address, page 24
payroll server quickbooks address, page 26
payroll server synchronization schedule, page 28
service timecardview, page 30
service timecardview purge now, page 31
service timecardview session terminate, page 33
service timecardview synchronize now, page 34
session-expiry-time, page 35
shift limit, page 36
show supervisor, page 38
show supervisors, page 40
show timecardview configuration, page 42
show timecardview sessions, page 44
show timecardview status, page 45
show timecardview users, page 47
TimeCardView 7.0 Command Reference
OL-17596-01
7
TimeCardView Commands
show user detail username, page 49
show user supervisor username, page 51
timecardview username, page 53
user-interface phone-call, page 55
user-interface phone-service, page 56
username, page 57
username (epage), page 59
week-start day, page 61
TimeCardView 7.0 Command Reference
8
OL-17596-01
TimeCardView Commands
copy timecardview timesheets url
copy timecardview timesheets url
To create a comma-separated values (CSV) file and copy it to an FTP server for later processing, use the
copy timecardview timesheets url command in Cisco Unity Express EXEC mode.
copy timecardview timesheets url url
Syntax Description
url url
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Quoted Universal Resource Location, for example,
"ftp://ftp.nowhere.com/dir/filename”.
After you enter this command, unless your FTP server accepts anonymous login, it prompts you first for
username and then for password.
You can customize this CSV file to create new types of timesheet reports. It contains the following fields:
Examples
•
Employee user-id
•
Work date
•
Work duration (hh:mm:ss)
•
Lunch duration (hh:mm:ss)
•
Break duration (hh:mm:ss)
•
Overtime duration (hh:mm:ss)
•
Approved
•
Approved time
•
Approver user-id
•
Modification time
•
Remarks
•
Synced
The following example illustrates copying timesheets to an FTP server:
se-10-0-0-0# copy timecardview timesheets url ftp://ftp.nowhere.com/dir/
username: user
password: pword
TimeCardView 7.0 Command Reference
OL-17596-01
9
TimeCardView Commands
copy timecardview timesheets url
% Total
% Received % Xferd
0
24
0
se-10-0-0-0#
Related Commands
0
0
24
Average Speed
Time
Time
Time Current
Dload Upload
Total
Spent
Left Speed
0
64 --:--:-- --:--:-- --:--:-0
Command
Description
daily
Limits the number of regular and overtime hours
TimeCardView users can work.
shift limit
Limits the amount of time TimeCardView users can spend in
the work, lunch, and break states.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview users
Displays the TimeCardView users.
TimeCardView 7.0 Command Reference
10
OL-17596-01
TimeCardView Commands
daily
daily
To limit the number of regular and overtime hours per day employees can work, use the daily command
in TimeCardView configuration mode. Use the no form of this command to remove any limitations on
employees’ regular and overtime hours.
daily { working-duration minutes 1-1440 | overtime-duration minutes 0-1440 }
Syntax Description
overtime-duration minutes 0-1440
Maximum number of overtime minutes employees are
allowed to work.
working-duration minutes 1-1440
Maximum number of regular minutes employees are allowed
to work.
Command Default
Employees can work up to 24 regular and 0 overtime hours per day.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
If you do not set either of these parameters, employees can work up to 24 hours per day; however, the
system logs all their hours as regular hours.
If an employee does not log out before reaching the limit, the system locks that person’s status so that
he or she cannot log in again to change their status. Only the employee’s supervisor can unlock the
person’s account.
If you limit the number of regular hours employees can work and set a limit of zero on their overtime
hours (range: 0-24 hours), they cannot accrue overtime.
If you limit the number of regular hours employees can work and do not set a limit on their overtime,
they will automatically start to accrue overtime when they exceed their regular working hours.
Examples
The following example illustrates setting working and overtime hours:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# daily working-duration minutes 1300
se-10-0-0-0(config-timecardview)# daily overtime-duration minutes 90
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
[...]Maximum Daily Working Duration (mins): 1300
Maximum Daily Overtime Duration (mins): 90
[...]
se-10-0-0-0#
TimeCardView 7.0 Command Reference
OL-17596-01
11
TimeCardView Commands
daily
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
service timecardview
Enters TimeCardView configuration mode.
shift limit
Limits the amount of time TimeCardView users can spend in
the work, lunch, and break states.
show timecardview configuration
Displays TimeCardView configuration,
TimeCardView 7.0 Command Reference
12
OL-17596-01
TimeCardView Commands
database purge schedule days
database purge schedule days
To configure the TimeCardView database purge schedule and the minimum number of days to keep data,
use the database purge schedule days command in TimeCardView configuration mode.
database purge schedule days 1-365 days-to-keep 0-364
Syntax Description
Command Default
days 1-365
Number of days between purges.
days-to-keep 0-364
Minimum number of days to keep data. This number is always less than
the number of days between purges.
TimeCardView purges its database every 90 days.
TimeCardView keeps its data for 30 days.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
•
TimeCardView purges itself when it overruns its maximum capacity or when it is scheduled to
purge, whichever comes first.
•
The system checks its database every day at 11:30 p.m. When its database reaches 70% of its
capacity, it sends notification e-mails if configured to do so, and does so again when it reaches 80%,
and again when it reaches 85% capacity. If the database reaches 90% capacity, the system deletes
the oldest 70% of the records, keeping the most recent 20%.
•
Because purging is likely to be time-consuming, the system performs this task in the background.
To view the progress of a purge, use the show timecardview status command.
Usage Guidelines
Note
Examples
You can also purge TimeCardView data manually using the service timecardview purge now
command.
The following example illustrates setting the number of days between purges and the minimum number
of days data is to be kept.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# database schedule days 90 days-to-keep 30
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
[...]
TimeCardView 7.0 Command Reference
OL-17596-01
13
TimeCardView Commands
database purge schedule days
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
[...]
Notification Email(s):
se-10-0-0-0#
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
notification email address
Configures TimeCardView to automatically notify specified
e-mail recipients when certain database usage threshholds
are reached and when database purges occur.
service timecardview
Enters TimeCardView configuration mode.
service timecardview purge now
Executes an immediate purge of the TimeCardView
database.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
14
OL-17596-01
TimeCardView Commands
disable (TimeCardView user configuration mode)
disable (TimeCardView user configuration mode)
To disable the TimeCardView service for an individual user, use the disable command in TimeCardView
user configuration mode.
disable
Syntax Description
This command has no arguments or keywords.
Command Default
TimeCardView service to individual Cisco Unity Express subscribers is disabled by default.
TimeCardView service to employees imported from Intuit’s QuickBooks is enabled by default.
Command Modes
TimeCardView user configuration (config-tvuser)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Although TimeCardView is globally enabled by default, to add a Cisco Unity Express subscriber to the
TimeCardView users, you must enable him or her individually.
You do not need to individually enable TimeCardView users imported from QuickBooks. You can,
however, disable them (and then re-enable them).
Examples
The following example illustrates disabling the TimeCardView service for an individual user specified
by his or her Cisco Unity Express user ID:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# timecardview username theirname1
se-10-0-0-0(config-tvuser)# disable
se-10-0-0-0(config-tvuser)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview users
theirname1
[Disabled]
1 total timecardview user(s)
se-10-0-0-0#
Related Commands
Command
Description
enable (TimeCardView user
configuration mode)
Enables the TimeCardView service for individuals.
TimeCardView 7.0 Command Reference
OL-17596-01
15
TimeCardView Commands
disable (TimeCardView user configuration mode)
Command
Description
show timecardview users
Displays the list of TimeCardView users.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
TimeCardView 7.0 Command Reference
16
OL-17596-01
TimeCardView Commands
enable (TimeCardView configuration mode)
enable (TimeCardView configuration mode)
To globally enable the TimeCardView service for all users, use the enable command in TimeCardView
configuration mode. To globally disable the TimeCardView service for all users, use the no form of this
command in TimeCardView configuration mode.
enable
no enable
Syntax Description
This command has no arguments or keywords.
Command Default
After installation and activation on the Cisco NME-CUE, TimeCardView is globally globally enabled by
default.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
After executing an immediate purge of the TimeCardView database, you must enable the service
globally.
Examples
The following example illustrates globally enabling the TimeCardView service:
se-10-0-0-0# config t
Enter configuration commands, one per line.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# enable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview status
Service: Enabled
Related Commands
End with CNTL/Z.
Command
Description
service timecardview
Enters TimeCardView configuration mode.
service timecardview purge now
Executes an immediate purge of the TimeCardView
database.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
OL-17596-01
17
TimeCardView Commands
enable (TimeCardView user configuration mode)
enable (TimeCardView user configuration mode)
To enable the TimeCardView service for an individual user, use the enable command in TimeCardView
user configuration mode.
enable
Syntax Description
This command has no arguments or keywords.
Command Default
TimeCardView service to individual Cisco Unity Express subscribers is disabled by default.
TimeCardView service to employees imported from Intuit’s QuickBooks is enabled by default.
Command Modes
TimeCardView user configuration mode (config-tvuser)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Although TimeCardView is globally enabled by default, to add a Cisco Unity Express subscriber to the
TimeCardView users, you must enable him or her individually.
You do not need to individually enable TimeCardView users imported from QuickBooks. You can,
however, disable them (and then re-enable them).
Examples
The following example illustrates enabling the TimeCardView service for an individual user:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# timecardview username theirname1
se-10-0-0-0(config-tvuser)# enable
se-10-0-0-0(config-tvuser)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview users
theirname1
[Enabled]
1 total timecardview user(s)
se-10-0-0-0#
Related Commands
Command
Description
disable (TimeCardView user
configuration mode)
Disables the TimeCardView service for a specified
individual.
show timecardview users
Displays the list of TimeCardView users.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
TimeCardView 7.0 Command Reference
18
OL-17596-01
TimeCardView Commands
groupname tcv-payroll-specialists
groupname tcv-payroll-specialists
To create TimeCardView payroll specialists, use the groupname tcv-payroll-specialists command in
Cisco Unity Express configuration mode.
groupname tcv-payroll-specialists { member user-id | owner user-id }
Syntax Description
member user-id
The username of a TimeCardView payroll specialist. The user-id is
case-sensitive.
owner user-id
The username of a TimeCardView payroll specialist who controls the
payroll specialists group. The user-id is case-sensitive.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Examples
•
Use this command to create payroll specialists by assigning owners and members to the
payroll-specialist group.
•
You cannot designate as a payroll specialist someone who is not already in the TimeCardView
system. If you try to do so, you receive an error message.
•
You can have multiple owners for a group.
The following example illustrates adding an owner and a member to a group of payroll specialists, and
also verifying the configuration:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# groupname tcv-payroll-specialists privilege tcv-payroll
se-10-0-0-0(config)# groupname tcv-payroll-specialists owner theirname1
se-10-0-0-0(config)# groupname tcv-payroll-specialists member theirname2
se-10-0-0-0(config)# end
se-10-0-0-0# show user detail username theirname1
Username:
theirname1
Full Name:
Joe Theirname
First Name:
Joe
Last Name:
Theirname
Nickname:
Joe Theirname1
Phone:
Phone(E.164):
Fax:
Email:
TimeCardView 7.0 Command Reference
OL-17596-01
19
TimeCardView Commands
groupname tcv-payroll-specialists
Epage:
Language:
systemDefault
GroupMember:
<none>
GroupOwner:
tcv-payroll-specialists
Privileges:
<none>
se-10-0-0-0# show user detail username theirname2
Username:
theirname2
Full Name:
Jane Theirname
First Name:
Jane
Last Name:
Theirname
Nickname:
Jane Theirname2
Phone:
Phone(E.164):
Fax:
Email:
Epage:
Language:
systemDefault
GroupMember:
tcv-payroll-specialists
GroupOwner:
<none>
Privileges:
tcv-payroll
se-10-0-0-0#
Related Commands
Command
Description
groupname tcv-payroll-specialists
privilege tcv-payroll
Grants TimeCardView payroll-specialist privileges to a
group.
show timecardview users
Displays the list of TimeCardView users.
show user detail username
Displays details related to a TimeCardView user’s
privileges.
TimeCardView 7.0 Command Reference
20
OL-17596-01
TimeCardView Commands
groupname tcv-payroll-specialists privilege tcv-payroll
groupname tcv-payroll-specialists privilege tcv-payroll
To grant payroll-specialist privileges to a group, use the groupname tcv-payroll-specialists privilege
tcv-payroll command in Cisco Unity Express configuration mode.
groupname tcv-payroll-specialists privilege tcv-payroll
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Grant this privilege before you add owners and members to the group of TimeCardView payroll
specialists.
Examples
The following example illustrates granting payroll specialist privileges to a group:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# groupname tcv-payroll-specialists privilege tcv-payroll
se-10-0-0-0(config)# groupname tcv-payroll-specialists owner theirname1
se-10-0-0-0(config)# groupname tcv-payroll-specialists member theirname2
se-10-0-0-0(config)# end
se-10-0-0-0#
Related Commands
Command
Description
groupname tcv-payroll-specialists
Creates payroll specialists by assigning owners and
members to the payroll-specialist group.
show user detail username
Displays the list of TimeCardView users.
TimeCardView 7.0 Command Reference
OL-17596-01
21
TimeCardView Commands
maxsessions
maxsessions
To set the maximum number of TimeCardView sessions, use the maxsessions command in
TimeCardView configuration mode.
maxsessions number
Syntax Description
maxsessions number
Command Default
This command has no default value.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Maximum number of sessions.
The number of TimeCardView sessions ranges from 2 to the maximum number of sessions for your
platform. Both the default number of sessions and the maximum number of sessions depend on your
platform, as shown below in Table 1.
.
Table 1
Examples
Number of Sessions per Platform
Platform
Maximum or Default Number of Sessions
Cisco 1861
2
Cisco NME
8
Cisco UC 500
2
The following example illustrates the process of setting the maximum number of TimeCardView
sessions:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# maxsessions 2
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Maximum Sessions: 2
[...]
se-10-0-0-0#
TimeCardView 7.0 Command Reference
22
OL-17596-01
TimeCardView Commands
maxsessions
Related Commands
Command
Description
session-expiry-time
Sets automatic IP phone session logout time for
TimeCardView users.
service timecardview
Enters TimeCardView configuration mode.
service timecardview session terminate
Clears any or all ongoing TimeCardView sessions.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview sessions
Displays the TimeCardView sessions in progress,
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
OL-17596-01
23
TimeCardView Commands
notification email address
notification email address
To have TimeCardView automatically notify specified e-mail recipients when the database reaches
certain usage threshholds (described in “Database Design Guidelines” on page 24) and when database
purges occur, use the notification email address command in TimeCardView configuration mode.
notification email address [email protected]
Syntax Description
email address
[email protected]
Command Default
This command has no default value.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Single or multiple email addresses separated by commas.
The system has a 64 character limit (including commas).
Database Design Guidelines
The system checks its database every day at 11:30 p.m. If you configure TimeCardView to send
notification e-mails, it does so when its database reaches:
Examples
•
70% capacity
•
80% capacity
•
85% capacity
•
90% capacity, at which point it deletes the oldest 70% of the records. It keeps the most recent 20%.
This ensures that at least one month’s worth of the latest data remains after a purge of this type.
The following example illustrates configuring e-mail notification of specified individuals about
TimeCardView database capacity threshholds being reached and purges.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# notification email address
[email protected],[email protected],[email protected]
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Phone-call User Interface: Enabled
TimeCardView 7.0 Command Reference
24
OL-17596-01
TimeCardView Commands
notification email address
Maximum Sessions: 2
Supervisor Session logout time (secs): 60
Employee Session logout time (secs): 60
Week Start Day: Monday
Maximum Daily Working Duration (mins): 480
Maximum Daily Overtime Duration (mins): 90
Maximum In-Shift Break Time (mins): 1440
Maximum In-Shift Work Time (mins): 1440
Maximum In-Shift Lunch Time (mins): 1440
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
Notification Email(s):
[email protected],[email protected],[email protected]
se-10-0-0-0#
Related Commands
Command
Description
database purge schedule days
Configures the database purge schedule and the minimum
number of days data is to be kept.
enable (TimeCardView configuration
mode)
Globally enables the TimeCardView service.
service timecardview
Enters TimeCardView configuration mode.
show timecardview users
Displays the TimeCardView users.
TimeCardView 7.0 Command Reference
OL-17596-01
25
TimeCardView Commands
payroll server quickbooks address
payroll server quickbooks address
To configure Intuit’s QuickBooks payroll server integration, use the payroll server quickbooks address
command in TimeCardView configuration mode.
payroll server quickbooks address hostname-or-ip-address [ port integer ]
Syntax Description
port integer
Integer from dynamic port range; same as default server port number.
quickbooks address
hostname-or-ip-address
Hostname of IP address of the QuickBooks server.
Command Default
None
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Examples
The following example illustrates configuring the QuickBooks payroll server integration:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# payroll server quickbooks address qbserver
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Phone-call User Interface: Disabled
Maximum Sessions: 16
Supervisor Session logout time (secs): 60
Employee Session logout time (secs): 60
Week Start Day: Monday
Maximum Daily Working Duration (mins): 1440
Maximum Daily Overtime Duration (mins): 0
Maximum In-Shift Break Time (mins): 1440
Maximum In-Shift Work Time (mins): 1440
Maximum In-Shift Lunch Time (mins): 1300
Payroll Server Type: QuickBooks
Quickbooks Server Address: qbserver
Quickbooks Server Port: 57343
Synchronization Schedule: Weekly
Sync Transfer Mode: All Timesheets
Sync Day: Saturday
Sync Time (HH:MM 24 hour): 22:00
TimeCardView 7.0 Command Reference
26
OL-17596-01
TimeCardView Commands
payroll server quickbooks address
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time (HH:MM 24 hour): 00:30
Notification Email(s): [email protected]
se-10-0-0-0
Related Commands
Command
Description
payroll server synchronization schedule Configures the schedule for synchronizing TimeCardView
with QuickBooks.
service timecardview
Enters TimeCardView configuration mode.
service timecardview synchronize now
Immediately synchronizes TimeCardView with
QuickBooks.
show timecardview configuration
Displays TimeCardView configuration.
TimeCardView 7.0 Command Reference
OL-17596-01
27
TimeCardView Commands
payroll server synchronization schedule
payroll server synchronization schedule
To configure the schedule for synchronizing TimeCardView with Intuit’s QuickBooks, use the payroll
server synchronization schedule command in TimeCardView configuration mode.
payroll server synchronization schedule { daily | weekly day 1-7 } time hh:mm timesheets { all
| approved }
Syntax Description
all
Synchronizes all timesheets.
approved
Synchronizes only approved timesheets.
time hh:mm
Time at which synchronization takes place.
weekly day 1-7
Day of the week when synchronization occurs.
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Command Default
None
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Examples
The following example illustrates configuring the QuickBooks payroll server synchronization schedule:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# payroll server synchronization schedule weekly day 7
time 22:00 timesheets all
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Phone-call User Interface: Disabled
Maximum Sessions: 0
Supervisor Session logout time (secs): 60
Employee Session logout time (secs): 60
Week Start Day: Monday
Maximum Daily Working Duration (mins): 1440
Maximum Daily Overtime Duration (mins): 0
TimeCardView 7.0 Command Reference
28
OL-17596-01
TimeCardView Commands
payroll server synchronization schedule
Maximum In-Shift Break Time (mins): 1440
Maximum In-Shift Work Time (mins): 1440
Maximum In-Shift Lunch Time (mins): 1300
Payroll Server Type: QuickBooks
Quickbooks Server Address: qbserver
Quickbooks Server Port: 57343
Synchronization Schedule: Weekly
Sync Transfer Mode: All Timesheets
Sync Day: Saturday
Sync Time (HH:MM 24 hour): 22:00
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time (HH:MM 24 hour): 00:30
Notification Email(s): [email protected]
se-10-0-0-0
Related Commands
Command
Description
database purge schedule days
Configures the database purge schedule and the minimum
number of days data is to be kept.
maxsessions
Sets the maximum number of TimeCardView sessions.
payroll server quickbooks address
Configures QuickBooks payroll server integration.
service timecardview synchronize now
Immediately synchronizes TimeCardView with
QuickBooks.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
OL-17596-01
29
TimeCardView Commands
service timecardview
service timecardview
To enter TimeCardView configuration mode, use the service timecardview command in
Cisco Unity Express configuration mode.
service timecardview
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Examples
The following example illustrates the use of the service timecardview command:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# enable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Related Commands
Command
Description
enable (TimeCardView configuration
mode)
Globally enables the TimeCardView service.
disable (TimeCardView user
configuration mode)
Disables the TimeCardView service for individual
TimeCardView users.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
30
OL-17596-01
TimeCardView Commands
service timecardview purge now
service timecardview purge now
To execute an immediate purge of the TimeCardView database, use the service timecardview purge
now command in Cisco Unity Express EXEC mode.
service timecardview purge now
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Examples
The following example illustrates disabling the TimeCardView service, then purging its database.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# no enable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# service timecardview purge now
!!!WARNING!!!: This will *COMPLETELY ERASE* timecardview historical records. It is highly
recommended to backup timecardview before excecuting this command since it is
irreversible.
Are you sure you want to Purge? (y/n) [n]: y
Purge started successfully. Please check its status later.
se-10-0-0-0# show timecardview status
Service: Disabled
Active Sessions: 0
DB Status: IDLE
DB Usage: 0
Last Purge (04/12/2008 18:06:43):
Payroll Sync Status (dd/MM/yyyy HH:mm:ss):
se-10-0-0-0#
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
database purge schedule days
Configures the database purge schedule and the minimum
number of days data is to be kept.
TimeCardView 7.0 Command Reference
OL-17596-01
31
TimeCardView Commands
service timecardview purge now
Command
Description
notification email address
Configures TimeCardView to automatically notify specified
e-mail recipients when certain database usage threshholds
are reached and when database purges occur.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
32
OL-17596-01
TimeCardView Commands
service timecardview session terminate
service timecardview session terminate
To clear any or all ongoing TimeCardView sessions, use the service timecardview session terminate
command in Cisco Unity Express EXEC mode.
service timecardview session terminate { all | user user-id }
Syntax Description
all
All TimeCardView users.
user user-id
Username of a TimeCardView user.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced.
Usage Guidelines
Use the show timecardview sessions command to display all ongoing sessions.
Examples
The following example illustrates displaying sessions and clearing all of them.
se-10-0-0-0# show timecardview sessions
theirname1,
theirname3.
se-10-0-0-0# service timecardview session terminate all
se-10-0-0-0# show timecardview sessions
No active sessions.
se-10-0-0-0#
Related Commands
Command
Description
session-expiry-time
Sets automatic IP phone session logout time for
TimeCardView users.
show timecardview sessions
Displays the TimeCardView sessions in progress,
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
OL-17596-01
33
TimeCardView Commands
service timecardview synchronize now
service timecardview synchronize now
To immediately synchronize TimeCardView with Intuit’s QuickBooks, use the service timecardview
synchronize now command in Cisco Unity Express EXEC mode.
service timecardview synchronize now timesheets { all | approved }
Syntax Description
all
Synchronizes all timesheets.
approved
Synchronizes only approved timesheets.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Examples
The following example illustrates disabling the TimeCardView service, then purging its database.
se-10-0-0-0# service timecardview synchronize now timesheets approved
Payroll Sync started successfully. Please check its status later.
se-10-0-0-0# show timecardview status
Service: Enabled
Active Sessions: 0
DB Status: IDLE
DB Usage: 0
Last Purge (dd/MM/yyyy HH:mm:ss): 17/12/2008 10:06:25
Payroll Sync Status (dd/MM/yyyy HH:mm:ss): 20/12/2008 07:13:19
se-10-0-0-0#
Related Commands
Command
Description
database purge schedule days
Configures the database purge schedule and the minimum
number of days data is to be kept.
payroll server quickbooks address
Configures QuickBooks payroll server integration.
payroll server synchronization schedule Configures the schedule for synchronizing TimeCardView
with QuickBooks.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview status
Displays TimeCardView status.
TimeCardView 7.0 Command Reference
34
OL-17596-01
TimeCardView Commands
session-expiry-time
session-expiry-time
To set automatic IP phone session logout time for TimeCardView users, use the session-expiry-time
command in TimeCardView configuration mode.
session-expiry-time { supervisor | employee } secs
Syntax Description
employee secs
The number of seconds before the system automatically logs out
employees. The range is 60 to 600 seconds (1 to 10 minutes).
supervisor secs
The number of seconds before the system automatically logs out
supervisors. The range is 60 to 600 seconds (1 to 10 minutes).
Command Default
Automatic logout for both supervisors and employees is 300 seconds (5 minutes).
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Examples
The following example illustrates setting automatic session logout.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# session-expiry-time supervisor 600
se-10-0-0-0(config-timecardview)# session-expiry-time employee 120
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 600
Employee Session logout time (secs): 120
[...]
se-10-0-0-0#
Related Commands
Command
Description
service timecardview
Enters TimeCardView configuration mode.
service timecardview session terminate
Clears any or all ongoing TimeCardView sessions.
show timecardview configuration
Displays TimeCardView configuration.
show timecardview sessions
Displays the TimeCardView sessions in progress.
TimeCardView 7.0 Command Reference
OL-17596-01
35
TimeCardView Commands
shift limit
shift limit
To limit the amount of time TimeCardView users spend in the work, lunch, and break states, use the shift
limit command in TimeCardView configuration mode.
shift limit {work-duration | lunch-duration | break-duration } minutes 1-1440
Syntax Description
minutes 1-1440
Command Default
TimeCardView users can accumulate 1440 minutes (24 hours) in any combination of the three states.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Maximum number of minutes TimeCardView users can remain in any
status — work, lunch, or break.
When employees log in to TimeCardView, they can set their status to one of the following:
•
Work
•
Lunch
•
Break
You can limit the amount of time employees can spend in each state. The maximum number of hours per
day they can remain in any state is 1440 minutes or 24 hours. If you do not change these parameters, the
system allows an employee to accumulate 24 hours per day in any combination of the three states.
The system automatically logs out any user who does not change their state before 24 hours have elapsed
or before the limit time you set (whichever number is smaller) has elapsed.
Examples
The following example illustrates setting time limits on employee status:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# shift limit work-duration minutes 480
se-10-0-0-0(config-timecardview)# shift limit lunch-duration minutes 60
se-10-0-0-0(config-timecardview)# shift limit break-duration minutes 40
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 600
Employee Session logout time (secs): 120
Week Start Day: Monday
TimeCardView 7.0 Command Reference
36
OL-17596-01
TimeCardView Commands
shift limit
Maximum Daily Working Duration (mins): 1440
Maximum Daily Overtime Duration (mins): 0
Maximum In-Shift Break Time (mins): 40
Maximum In-Shift Work Time (mins): 480
Maximum In-Shift Lunch Time (mins): 60
Payroll Server Type: QuickBooks
Quickbooks Server Address: 192.0.2.3
Quickbooks Server Port: 57343
Synchronization Schedule: Daily
Sync Transfer Mode: All Timesheets
Sync Time: 21:00
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 21:30
Notification Email(s):
se-10-0-0-0# copy running-config startup-config
se-10-0-0-0#
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
daily
Limits the number of regular and overtime hours
TimeCardView users can work.
service timecardview
Enters TimeCardView configuration mode.
show timecardview configuration
Displays TimeCardView configuration.
TimeCardView 7.0 Command Reference
OL-17596-01
37
TimeCardView Commands
show supervisor
show supervisor
To display the employees who report to the specified supervisor, use the show supervisor command in
Cisco Unity Express EXEC mode.
show supervisor user-id
Syntax Description
supervisor user-id
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
The supervisor’s User ID, which is case-sensitive.
Usage Guidelines
Use this command to verify your supervisory structure.
Examples
The following example illustrates creating a chain of command with two employees, their supervisor and
the supervisor’s supervisor, and then verifying this:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# username Juser20 supervisor designate
se-10-0-0-0(config)# username Juser200 supervisor designate
se-10-0-0-0(config)# username Juser10 supervisor username Juser20
se-10-0-0-0(config)# username Juser11 supervisor username Juser20
se-10-0-0-0(config)# username Juser20 supervisor username Juser200
se-10-0-0-0(config)# end
se-10-0-0-0 # show supervisors
Juser20
Juser200
2 total supervisor(s)
se-10-0-0-0 # show supervisor Juser20
Juser10
Juser11
2 total employee(s)
se-10-0-0-0 # show supervisor Juser200
Juser10
Juser11
Juser20
3 total employee(s)
se-10-0-0-0 # show user supervisor username Juser11
Juser20
se-10-0-0-0 # show user supervisor username Juser10
Juser20
TimeCardView 7.0 Command Reference
38
OL-17596-01
TimeCardView Commands
show supervisor
se-10-0-0-0 # show user supervisor username Juser20
Juser200
se-10-0-0-0 #
Related Commands
Command
Description
show supervisors
Displays the names of the TimeCardView users who are
designated supervisors.
show timecardview users
Displays the list of TimeCardView users.
show user supervisor username
Displays the specified user’s supervisor.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
OL-17596-01
39
TimeCardView Commands
show supervisors
show supervisors
To display the TimeCardView users who are designated supervisors, use the show supervisors command
in Cisco Unity Express EXEC mode.
show supervisor
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Use this command to verify your supervisory structure.
Examples
The following example illustrates creating a chain of command with two employees, their supervisor and
the supervisor’s supervisor, and then verifying this:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# username Juser20 supervisor designate
se-10-0-0-0(config)# username Juser200 supervisor designate
se-10-0-0-0(config)# username Juser10 supervisor username Juser20
se-10-0-0-0(config)# username Juser11 supervisor username Juser20
se-10-0-0-0(config)# username Juser20 supervisor username Juser200
se-10-0-0-0(config)# end
se-10-0-0-0 # show supervisors
Juser20
Juser200
2 total supervisor(s)
se-10-0-0-0 # show supervisor Juser20
Juser10
Juser11
2 total employee(s)
se-10-0-0-0 # show supervisor Juser200
Juser10
Juser11
Juser20
3 total employee(s)
se-10-0-0-0 # show user supervisor username Juser11
Juser20
se-10-0-0-0 # show user supervisor username Juser10
Juser20
TimeCardView 7.0 Command Reference
40
OL-17596-01
TimeCardView Commands
show supervisors
se-10-0-0-0 # show user supervisor username Juser20
Juser200
se-10-0-0-0 #
Related Commands
Command
Description
show supervisor
Displays the employees who report to the specified
supervisor.
show timecardview users
Displays the list of TimeCardView users.
show user supervisor username
Displays the specified user’s supervisor.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
OL-17596-01
41
TimeCardView Commands
show timecardview configuration
show timecardview configuration
To display TimeCardView configuration, use the show timecardview configuration command in
Cisco Unity Express EXEC mode.
show timecardview configuration
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced.
Usage Guidelines
Examples
Use the show timecardview configuration command to display:
•
Whether or not the TimeCardView service is enabled
•
The maximum number of sessions
•
The supervisor and employee session logout times
•
The start of the work week
•
The maximum daily regular and overtime hours
•
The maximum amount of time employees can spend in the work, break, and lunch states
•
The payroll server configuration (set using the TimeCardView GUI)
•
The database purge schedule
•
The minimum number of days data is to be kept in the database
•
The time of day when scheduled purges take place
•
The e-mail addresses of those whom the system notifies when its database reaches its capacity
threshholds.
The following example illustrates displaying TimeCardView configuration:
se-10-0-0-0# show timecardview configuration
Service: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 600
Employee Session logout time (secs): 120
Week Start Day: Monday
Maximum Daily Working Duration (mins): 1440
TimeCardView 7.0 Command Reference
42
OL-17596-01
TimeCardView Commands
show timecardview configuration
Maximum Daily Overtime Duration (mins): 0
Maximum In-Shift Break Time (mins): 40
Maximum In-Shift Work Time (mins): 480
Maximum In-Shift Lunch Time (mins): 60
Payroll Server Type: QuickBooks
Quickbooks Server Address: 192.0.2.3
Quickbooks Server Port: 57343
Synchronization Schedule: Daily
Sync Transfer Mode: All Timesheets
Sync Time: 21:00
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 21:30
Notification Email(s):
se-10-0-0-0# copy running-config startup-config
se-10-0-0-0#
Related Commands
Command
Description
daily
Limits the number of regular and overtime hours
TimeCardView users can work.
database purge schedule days
Configures the database purge schedule and the minimum
number of days data is to be kept.
enable (TimeCardView configuration
mode)
Globally enables the TimeCardView service.
session-expiry-time
Sets automatic IP phone session logout time for
TimeCardView users.
maxsessions
Sets the maximum number of TimeCardView sessions.
notification email address
Configures TimeCardView to automatically notify specified
e-mail recipients when certain database usage threshholds
are reached and when database purges occur,
payroll server quickbooks address
Configures QuickBooks payroll server integration.
payroll server synchronization schedule Configures the schedule for synchronizing TimeCardView
with QuickBooks.
service timecardview purge now
Executes an immediate purge of the TimeCardView
database.
shift limit
Limits the amount of time TimeCardView users can spend in
the work, lunch, and break states.
TimeCardView 7.0 Command Reference
OL-17596-01
43
TimeCardView Commands
show timecardview sessions
show timecardview sessions
To display TimeCardView sessions, use the show timecardview sessions command in
Cisco Unity Express EXEC mode.
show timecardview sessions
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Use this command before or after clearing TimeCardView sessions.
Examples
The following example illustrates displaying sessions and clearing all of them.
se-10-0-0-0# show timecardview sessions
theirname1,
theirname3.
se-10-0-0-0# service timecardview session terminate all
se-10-0-0-0# show timecardview sessions
No active sessions.
se-10-0-0-0#
Related Commands
Command
Description
session-expiry-time
Sets automatic IP phone session logout time for
TimeCardView users.
maxsessions
Sets the maximum number of TimeCardView sessions.
service timecardview session terminate
Clears any or all ongoing TimeCardView sessions.
TimeCardView 7.0 Command Reference
44
OL-17596-01
TimeCardView Commands
show timecardview status
show timecardview status
To display TimeCardView status, use the show timecardview status command in Cisco Unity Express
EXEC mode.
show timecardview status
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Examples
Use this command to find out:
•
Whether the TimeCardView service is globally enabled or disabled
•
Whether there are any active sessions
•
Whether the database is idle or not
•
How full the database is
•
When the database was last purged
•
When TimeCardView was last synchronized
The following example illustrates displaying the TimeCardViewstatus after purging its database.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# no enable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# service timecardview purge now
!!!WARNING!!!: This will *COMPLETELY ERASE* timecardview historical records. It is highly
recommended to backup timecardview before excecuting this command since it is
irreversible.
Are you sure you want to Purge? (y/n) [n]: y
Purge started successfully. Please check its status later.
se-10-0-0-0# show timecardview status
Service: Disabled
Active Sessions: 0
DB Status: IDLE
DB Usage: 0
TimeCardView 7.0 Command Reference
OL-17596-01
45
TimeCardView Commands
show timecardview status
Last Purge (04/12/2008 18:06:43):
Payroll Sync Status (dd/MM/yyyy HH:mm:ss):
se-10-0-0-0#
Related Commands
Command
Description
database purge schedule days
Configures the TimeCardView database purge schedule and
the minimum number of days to keep data.
enable (TimeCardView configuration
mode)
Globally enables the TimeCardView service.
service timecardview purge now
Executes an immediate purge of the TimeCardView
database.
TimeCardView 7.0 Command Reference
46
OL-17596-01
TimeCardView Commands
show timecardview users
show timecardview users
To display the list of TimeCardView users, use the show timecardview users command in
Cisco Unity Express EXEC mode.
show timecardview users
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Examples
The following example illustrates displaying a TimeCardView username after adding the user.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# timecardview username theirname1
se-10-0-0-0(config-tvuser)# enable
se-10-0-0-0(config-tvuser)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview users
theirname1
[Enabled]
1 total timecardview user(s)
se-10-0-0-0#
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
disable (TimeCardView user
configuration mode)
Disables individual TimeCardView users.
enable (TimeCardView user
configuration mode)
Enables the TimeCardView service for individuals.
show supervisor
Displays the employees who report to the specified
supervisor.
show user detail username
Displays details related to a TimeCardView user’s
privileges.
show user supervisor username
Displays the specified user’s supervisor.
TimeCardView 7.0 Command Reference
OL-17596-01
47
TimeCardView Commands
show timecardview users
Command
Description
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
48
OL-17596-01
TimeCardView Commands
show user detail username
show user detail username
To display details relating to users with TimeCardView privileges, use the show user detail username
command in Cisco Unity Express EXEC mode.
show user detail username user-id
Syntax Description
username user-id
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
The username of a TimeCardView payroll specialist. The user-id is
case-sensitive.
Usage Guidelines
Use this command to verify which TimeCardView users have payroll specialist privileges.
Examples
The following example illustrates adding an owner and a member to a group of payroll specialists, and
also verifying the configuration:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# groupname tcv-payroll-specialists privilege tcv-payroll
se-10-0-0-0(config)# groupname tcv-payroll-specialists owner theirname1
se-10-0-0-0(config)# groupname tcv-payroll-specialists member theirname2
se-10-0-0-0(config)# end
se-10-0-0-0# show user detail username theirname1
Username:
theirname1
Full Name:
Joe Theirname
First Name:
Joe
Last Name:
Theirname
Nickname:
Joe Theirname1
Phone:
Phone(E.164):
Fax:
Email:
Epage:
Language:
systemDefault
GroupMember:
<none>
GroupOwner:
tcv-payroll-specialists
Privileges:
<none>
se-10-0-0-0# show user detail username theirname2
Username:
theirname2
Full Name:
Jane Theirname
First Name:
Jane
TimeCardView 7.0 Command Reference
OL-17596-01
49
TimeCardView Commands
show user detail username
Last Name:
Nickname:
Phone:
Phone(E.164):
Fax:
Email:
Epage:
Language:
GroupMember:
GroupOwner:
Privileges:
se-10-0-0-0#
Related Commands
Theirname
Jane Theirname2
systemDefault
tcv-payroll-specialists
<none>
tcv-payroll
Command
Description
groupname tcv-payroll-specialists
Creates payroll specialists by adding owner(s) and
member(s) to the group of payroll specialists.
groupname tcv-payroll-specialists
privilege tcv-payroll
Grants TimeCardView payroll-specialist privileges to a
group.
show timecardview users
Displays the list of TimeCardView users.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
username (epage)
Configures an epage address to enable a supervisor to send
a text message to an employee reporting to him or her.
TimeCardView 7.0 Command Reference
50
OL-17596-01
TimeCardView Commands
show user supervisor username
show user supervisor username
To display the specified TimeCardView user’s supervisor, use the show user supervisor username
command in Cisco Unity Express EXEC mode.
show user supervisor username user-id
Syntax Description
username user-id
Command Default
This command has no default value.
Command Modes
Cisco Unity Express EXEC (#)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
The Cisco Unity Express username of the TimeCardView user. The
user-id is case-sensitive.
Usage Guidelines
Use this command to verify your supervisory structure.
Examples
The following example illustrates creating a chain of command with two employees, their supervisor and
the supervisor’s supervisor, and then verifying this:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# username Juser20 supervisor designate
se-10-0-0-0(config)# username Juser200 supervisor designate
se-10-0-0-0(config)# username Juser10 supervisor username Juser20
se-10-0-0-0(config)# username Juser11 supervisor username Juser20
se-10-0-0-0(config)# username Juser20 supervisor username Juser200
se-10-0-0-0(config)# end
se-10-0-0-0 # show supervisors
Juser20
Juser200
2 total supervisor(s)
se-10-0-0-0 # show supervisor Juser20
Juser10
Juser11
2 total employee(s)
se-10-0-0-0 # show supervisor Juser200
Juser10
Juser11
Juser20
3 total employee(s)
se-10-0-0-0 # show user supervisor username Juser11
Juser20
se-10-0-0-0 # show user supervisor username Juser10
TimeCardView 7.0 Command Reference
OL-17596-01
51
TimeCardView Commands
show user supervisor username
Juser20
se-10-0-0-0 # show user supervisor username Juser20
Juser200
se-10-0-0-0 #
Related Commands
Command
Description
show supervisor
Displays the employees who report to the specified
supervisor.
show supervisors
Displays the names of the TimeCardView users who are
designated supervisors.
show timecardview users
Displays the list of TimeCardView users.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
52
OL-17596-01
TimeCardView Commands
timecardview username
timecardview username
To specify the individual Cisco Unity Express subscriber for whom the TimeCardView service is to be
enabled or disabled, use the timecardview username command in Cisco Unity Express configuration
mode. To delete a TimeCardView user, use the no form of this command.
timecardview username user-id
no timecardview username user-id
Syntax Description
username user-id
Command Default
This command has no default value.
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced on the Cisco Unity Express
network module.
Usage Guidelines
Examples
The Cisco Unity Express username of the subscriber. The user-id is
case-sensitive.
•
You can also provide TimeCardView service by importing employees from Intuit’s QuickBooks
using the TimeCardView GUI. Users imported that way are automatically enabled.
•
Delete specified TimeCardView users by using the no form of this command.
The following example illustrates adding the TimeCardView service for a specified Cisco Unity Express
subscriber.
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# timecardview username theirname1
se-10-0-0-0(config-tvuser)# enable
se-10-0-0-0(config-tvuser)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview users
theirname1
[Enabled]
1 total timecardview user(s)
se-10-0-0-0#
TimeCardView 7.0 Command Reference
OL-17596-01
53
TimeCardView Commands
timecardview username
Related Commands
Command
Description
disable (TimeCardView user
configuration mode)
Disables the TimeCardView service for a specified
individual.
enable (TimeCardView user
configuration mode)
Enables the TimeCardView service for a specified
individual.
show timecardview users
Displays the list of TimeCardView users.
show user supervisor username
Displays the specified user’s supervisor.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
54
OL-17596-01
TimeCardView Commands
user-interface phone-call
user-interface phone-call
To enable or disable the TimeCardView telephone user interface (TUI) voice prompts, use the
user-interface phone-call command in TimeCardView configuration mode.
user-interface phone-call { enable | disable }
Syntax Description
disable
Disables the TimeCardView TUI.
enable
Enables the TimeCardView TUI.
Command Default
The TUI is disabled.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
Note
Examples
•
TimeCardView provides users with voice prompts to guide them through all its processes, such as
logging in and transitioning from one status to the next.
•
The output from the show timecardview configuration command indicates whether the TUI is
disabled.
Do not confuse the TUI, which is audible on the phone, with the phone screen user interface, which is
visible on the phone.
The following example illustrates enabling the TUI for TimeCardView.
se-10-0-0-0# config t
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# user-interface phone-call enable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Phone-call User Interface: Enabled
[...]
se-10-0-0-0#
Related Commands
Command
Description
service timecardview
Enters TimeCardView configuration mode.
show run
Displays the status of the TimeCardView IP phone interface.
TimeCardView 7.0 Command Reference
OL-17596-01
55
TimeCardView Commands
user-interface phone-service
user-interface phone-service
To enable or disable the TimeCardView IP phone screen prompts, use the user-interface phone-service
command in TimeCardView configuration mode.
user-interface phone-service { enable | disable }
Syntax Description
disable
Disables the TimeCardView IP phone screen interface.
enable
Enables the TimeCardView IP phone screen interface.
Command Default
The phone service screen interface is enabled.
Command Modes
TimeCardView configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Usage Guidelines
By default, TimeCardView provides users with the phone screen user interface to guide them through all
its processes, such as logging in and transitioning from one status to the next.
Note
Examples
Do not confuse the phone screen user interface, which is visible on the phone, with the telephone
user interface (TUI), which is audible on the phone.
The following example illustrates disabling the screen prompts for TimeCardView.
se-10-0-0-0# config t
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# user-interface phone-service disable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Phone-service User Interface: Disabled
[...]
se-10-0-0-0#
Related Commands
Command
Description
service timecardview
Enters TimeCardView configuration mode.
show run
Displays the status of the TimeCardView IP phone interface.
TimeCardView 7.0 Command Reference
56
OL-17596-01
TimeCardView Commands
username
username
To create a supervisor and assign employees to report to him or her, use the username command in
Cisco Unity Express configuration mode. Use the no form of this command to remove the privilege or
dissolve the relationship.
username user-id supervisor { designate | username user-id [ alternate | primary ]}
no username user-id supervisor { designate | username user-id [ alternate | primary ]}
Syntax Description
username user-id
Command Default
A supervisor is an employee’s primary supervisor unless otherwise specified.
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced.
Usage Guidelines
User ID of a TimeCardView user. The user ID is case-sensitive. When
it occurs before the keyword supervisor in the command, the user ID
is that of the supervisor, and when it occurs after the keyword
supervisor, it is an employee’s user ID.
•
After designating supervisors, assign employees to them.
•
If you attempt to assign an employee to someone whom you have not already designated a
supervisor, you receive an error message.
•
If you specify an employee or a supervisor who is not already a TimeCardView user, you receive an
error message.
•
Employees can have primary and alternate supervisors. Unless you specify otherwise, the supervisor
you assign to an employee is that employee’s primary supervisor.
•
Any assignment overwrites all earlier ones, so that any pre-existing primary supervisory relationship
ceases.
•
If you attempt to make an employee his or her own supervisor, you receive an error message.
•
If you create a circular reporting relationship, you receive an error message.
•
Using the no username user-id supervisor designate command reduces the supervisor to employee
status, and also removes the direct reports from the supervisor’s reporting chain.
•
Using the no username user-id supervisor username user-id [primary | alternate] command
removes the specified employee from the specified supervisor’s list of direct reports.
TimeCardView 7.0 Command Reference
OL-17596-01
57
TimeCardView Commands
username
Examples
The following example illustrates creating a chain of command with two employees, their supervisor and
the supervisor’s supervisor, and then verifying this:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# username Juser20 supervisor designate
se-10-0-0-0(config)# username Juser200 supervisor designate
se-10-0-0-0(config)# username Juser10 supervisor username Juser20
se-10-0-0-0(config)# username Juser11 supervisor username Juser20
se-10-0-0-0(config)# username Juser20 supervisor username Juser200
se-10-0-0-0(config)# end
se-10-0-0-0 # show supervisors
Juser20
Juser200
2 total supervisor(s)
se-10-0-0-0 # show supervisor Juser20
Juser10
Juser11
2 total employee(s)
se-10-0-0-0 # show supervisor Juser200
Juser10
Juser11
Juser20
3 total employee(s)
se-10-0-0-0 # show user supervisor username Juser11
Juser20
se-10-0-0-0 # show user supervisor username Juser10
Juser20
se-10-0-0-0 # show user supervisor username Juser20
Juser200
se-10-0-0-0 #
Related Commands
Command
Description
show supervisor
Displays the employees who report to the specified
supervisor.
show supervisors
Displays the names of the TimeCardView users who are
designated supervisors.
show timecardview users
Displays the list of TimeCardView users.
show user supervisor username
Displays the specified user’s supervisor.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
TimeCardView 7.0 Command Reference
58
OL-17596-01
TimeCardView Commands
username (epage)
username (epage)
To enable a supervisor to send a text message to an employee reporting to him or her, use the username
command in Cisco Unity Express configuration mode to configure an epage address for the employee.
username user-id epage string
Syntax Description
epage string
RFC-2822 e-mail address, for example, [email protected].
username user-id
User ID of a TimeCardView user. The user ID is case-sensitive. When
it occurs before the keyword supervisor in the command, the user ID
is that of the supervisor, and when it occurs after the keyword
supervisor, it is an employee’s user ID.
Command Default
None
Command Modes
Cisco Unity Express configuration (config)
Command History
Cisco Unity Express Version
Modification
7.0
This command was introduced.
Usage Guidelines
If you do not configure an e-page address for each employee, TimeCardView tells supervisors that the
epage address is empty when they try to send text messages to their employees.
Examples
The following example illustrates configuring an epage address for an employee so that a supervisor can
send text messages to that person:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# username Theirname1 epage [email protected]
se-10-0-0-0(config)# end
se-10-0-0-0# show user detail username Theirname1
Username:
Theirname1
Full Name:
Sample Theirname
First Name:
Sample
Last Name:
Theirname
Nickname:
Theirname1
Phone:
Phone(E.164):
Fax:
Email:
Epage:
[email protected]
Language:
systemDefault
GroupMember:
<none>
GroupOwner:
<none>
Privileges:
<none>
se-10-0-0-0#
TimeCardView 7.0 Command Reference
OL-17596-01
59
TimeCardView Commands
username (epage)
Related Commands
Command
Description
show timecardview users
Displays the list of TimeCardView users.
show user detail username
Displays details related to a TimeCardView user’s
privileges.
show user supervisor username
Displays the specified user’s supervisor.
timecardview username
Specifies either the individual for whom the TimeCardView
service is to be enabled or disabled, or the TimeCardView
user who is to be deleted.
username
Either creates a supervisor and assigns employees to report
to him or her, or removes the privilege or dissolves the
relationship.
TimeCardView 7.0 Command Reference
60
OL-17596-01
TimeCardView Commands
week-start day
week-start day
To configure the day of the week on which work starts, use the week-start day command in
TimeCardView configuration mode. Use the no form of this command to reset the start of the work week
to Monday.
week-start day 1-7
no week-start day 1-7
Syntax Description
day 1-7
Command Default
The work week starts on Monday.
Command Modes
TimeCardview configuration (config-timecardview)
Command History
TimeCardView Version
Modification
7.0
This command was introduced.
Day of the week on which work starts.
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Usage Guidelines
Each time you configure the week start day, you overwrite any preceding configuration of it.
Examples
The following example illustrates the process of setting the day of the week on which work is to start
and verifying the result:
se-10-0-0-0# config t
Enter configuration commands, one per line. End with CNTL/Z.
se-10-0-0-0(config)# service timecardview
se-10-0-0-0(config-timecardview)# week-start day 3
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show timecardview configuration
Service: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 600
Employee Session logout time (secs): 120
Week Start Day: Wednesday
[...]
se-10-0-0-0#
TimeCardView 7.0 Command Reference
OL-17596-01
61
TimeCardView Commands
week-start day
Related Commands
Command
Description
copy timecardview timesheets url
Creates a comma-separated values (CSV) file and copies it
to an FTP server.
daily
Limits the number of regular and overtime hours
TimeCardView users can work.
service timecardview
Enters TimeCardView configuration mode.
shift limit
Limits the amount of time TimeCardView users can spend in
the work, lunch, and break states.
show timecardview configuration
Displays TimeCardView configuration.
TimeCardView 7.0 Command Reference
62
OL-17596-01