TimeCardView 7.0 CLI Administrator Guide
First released: January 2009
Last updated: March 17, 2010
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-17595-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, CCSI, Cisco Eos, Cisco Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase,
Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip
Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work,
Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and
Access Registrar, Aironet, AllTouch, 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 Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity,
Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the
IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY,
PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are
registered trademarks of Cisco 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. (1002R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the
document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
TimeCardView 7.0 CLI Administrator Guide
© 2009 Cisco Systems, Inc. All rights reserved.
CONTENTS
Introduction
1
Contents
1
Functional Overview 1
Purpose 1
Employees’ Role 2
Supervisors’ Role 2
Payroll Specialists’ Role
2
Overview of TimeCardView Configuration
3
Additional References 3
Documents Related to Cisco Unity Express
Technical Assistance 3
3
Obtaining Documentation and Submitting a Service Request
Installation
4
5
Prerequisites
5
Types of TimeCardView Software Upgrades
Platforms and Cisco IOS Software Images
6
6
Cisco IP Phones Supporting TimeCardView
Software Licenses and Factory-Set Limits
6
7
Installing TimeCardView 7
Installing the TimeCardView Package File on Cisco Unity Express 7
Configuring An Autologin for TimeCardView on Intuit’s QuickBooks 8
Installing the TCVQB-Connector on Intuit’s QuickBooks Server 8
Installing, Upgrading, or Downgrading Your TimeCardView License
Configuring Your System
9
11
Globally Enabling or Disabling TimeCardView
12
Disabling the TimeCardView Phone Screen Interface
Disabling the TimeCardView Telephone User Interface
Enabling TimeCardView Users 18
Required Data for This Procedure
Setting TimeCardView Sessions
Setting Automatic Session Logout
14
16
19
21
23
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
iii
Contents
Displaying and Clearing Sessions
25
Assigning Payroll Specialist Privileges 26
Required Data for This Procedure 26
Designating Supervisors and Assigning Them to Employees
Required Data for This Procedure 28
Configuring an Epage Address for an Employee
Setting the Week Start Day
31
33
Setting Working and Overtime Hours
35
Setting Time Limits on Employee Status
37
Database Purge Scheduling and Capacity
Database Design Guidelines 40
Configuring E-mail Notification 42
Required Data for This Procedure
Purging or Clearing Data Manually
40
42
44
Copying Timesheets to an External FTP Server
Backing Up and Restoring
46
46
Integrating With Intuit’s QuickBooks
Contents
49
49
Configuring TimeCardView to Talk to QuickBooks
Syncing Manually with QuickBooks
49
51
Scheduling Synchronization with QuickBooks
Index
28
52
55
TimeCardView 7.0 CLI Administrator Guide
iv
OL-17595-01
Introduction
First published: January 2009
Revised: March 17, 2010
Contents
•
Functional Overview, page 1
•
Overview of TimeCardView Configuration, page 3
•
Additional References, page 3
•
Obtaining Documentation and Submitting a Service Request, page 4
Functional Overview
This section briefly describes the capabilities of TimeCardView 1.0, and it contains the following
sections:
•
Purpose, page 1
•
Employees’ Role, page 2
•
Supervisors’ Role, page 2
•
Payroll Specialists’ Role, page 2
Purpose
TimeCardView is a time and attendance system for Cisco Unity Express users on Cisco IP phones
connected to Cisco Unified Communications Manager Express (Cisco Unified CME) or Cisco Unified
Communications Manager (see “Cisco IP Phones Supporting TimeCardView” on page 6 for a list of the
models supported). TimeCardView automatically tracks employees’ working hours and enables
supervisors to view employees’ real time status. It provides for online review and approval of timesheets
and it can generate the reports supervisors and payroll specialists need via the Historical Reporting
Client and export them to the .csv and .xls file formats.
TimeCardView interfaces with backend accounting software such as Intuit’s QuickBooks so that
timesheet data can be seamlessly transferred into the accounting system, thus eliminating human error.
Integrating with QuickBooks is optional.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
1
Introduction
Functional Overview
With QuickBooks, TimeCardView also saves Cisco Unity Express administrators from having to enter
employees’ names into the system one by one. Instead, employee data can be imported from QuickBooks
into the Cisco Unity Express system and vice versa, employee data can be exported from
Cisco Unity Express to QuickBooks via TimeCardView.
TimeCardView has the following user interfaces:
•
an IP phone interface for employees and supervisors,
•
a telephone user interface (TUI) (voice prompts),
•
a web-based graphical user interface (GUI) for supervisors, payroll specialists, and the
Cisco Unity Express administrator
•
a command line interface (CLI) for the Cisco Unity Express administrator.
Employees’ Role
Those whose working hours are to be tracked (hereafter referred to as employees, and not supervisors,
payroll specialists, and Cisco Unity Express administrators) access TimeCardView by using the
Services button on the Cisco IP phones. After they log in, TimeCardView presents a menu of options on
the IP phone interface for starting or ending their shifts, breaks, and lunches. Employees can also review
their hours. If an employee has a mailbox configured on the system, then the TimeCardView phone user
interface provides direct access to the employee’s voice-mailbox.
Employees can also use the web GUI for tasks like resetting their passwords. Employees who forget to
clock out at the end of their at the end of their activity (shift, break, lunch, etc.) or who exceed the
maximum working hours set by the payroll specialist (see “Payroll Specialists’ Role” on page 2) are
locked out until their supervisor re-enables access. The employee’s supervisor uses the TimeCardView
phone interface to override lock-outs.
Supervisors’ Role
Using the TimeCardView GUI or the phone interface, supervisors can monitor the status of the
employees who report to them and send voice messages to them (if voice-mailboxes are configured for
them) and e-page messages to them (if the Cisco Unity Express administrator has configured e-page
addresses for them). Supervisors can use the GUI to edit the timesheets of their direct reports, and they
can use the IP phone interface to edit or override the status of their direct reports. When the system locks
out an employee for forgetting to clock out at the end of his or her shift, for example, that employee’s
supervisor uses the TimeCardView phone interface to unlock the employee’s account.
Payroll Specialists’ Role
Like supervisors, payroll specialists use the TimeCardView web GUI to review, modify, and approve
employees’ timesheets.
Using the TimeCardView web GUI, payroll specialists can transfer timesheet data to a QuickBooks
server and export or import TimeCardView users’ names to or from QuickBooks. Payroll specialists and
supervisors can add and delete TimeCardView users. payroll specialists can review and approve all
users’ timesheets. They can set the maximum regular working hours per day, the duration of shifts,
breaks, lunch, maximum overtime hours per day, etc.
TimeCardView 7.0 CLI Administrator Guide
2
OL-17595-01
Introduction
Overview of TimeCardView Configuration
Overview of TimeCardView Configuration
This section briefly describes TimeCardView in relation to Cisco Unity Express and gives an overview
of the tasks involved in setting up TimeCardView.
TimeCardView is available as an add-on package to Cisco Unity Express, with which it co-resides on a
service module. Because you configure its users by enabling a Cisco Unity Express user as a
TimeCardView user, the installation of Cisco Unity Express is a prerequisite. The maximum number of
TimeCardView users is restricted to the maximum number of Cisco Unity Express users that your
platform supports.
All configuration-related commands appear in the running configuration of your Cisco Unity Express
installation.
Almost all configuration and administration functions for TimeCardView are available through the GUI.
After globally enabling TimeCardView, you enable access to TimeCardView for individual employees
required to use it, their supervisors and payroll specialist(s). Until this point, these three functions are
all simply TimeCardView users (in addition to being Cisco Unity Express users). Now you allocate
supervisor and payroll specialist privileges to the designated users.
The next steps set up the system parameters for the working hours and so on. Optionally, you can
configure integration with QuickBooks, which takes the form of configuring TimeCardView as a
QuickBooks integrated application, so that you can sync TimeCardView manually with QuickBooks.
The final configuration tasks are setting database capacity and scheduling database purges, along with
clearing data manually when required, and backing up and restoring. TimeCardView also provides the
facility to copy timesheets to an external FTP server.
When you have completed these tasks, you can start running the TimeCardView GUI so that supervisors
and payroll specialists can use it to perform their duties without having recourse to the
Cisco Unity Express command line interface. To facilitate operations, some of the GUI functionalities
are available as CLIs.
Additional References
•
Documents Related to Cisco Unity Express
•
Technical Assistance
Documents Related to Cisco Unity Express
See Cisco Unity Express Documentation, By Version for links to documents related to Cisco Unity
Express.
Technical Assistance
The Cisco Support website - http://www.cisco.com/techsupport - provides extensive online resources,
including documentation and tools for troubleshooting and resolving technical issues with Cisco
products and technologies.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
3
Introduction
Obtaining Documentation and Submitting a Service Request
To receive security and technical information about your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter,
and Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed
and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free
service and Cisco currently supports RSS Version 2.0.
TimeCardView 7.0 CLI Administrator Guide
4
OL-17595-01
Installation
First published: January 2009
Revised: March 17, 2010
This chapter describes the TimeCardView command-line interface (CLI) options for installing and
upgrading the TimeCardView software.
Use the tasks and procedures in this chapter before performing the administrative tasks described in the
subsequent chapters of this guide.
Note
Use this guide for a TimeCardView installation or upgrade. This guide does not provide information on
the installation of Cisco network modules, Cisco routers, Cisco Unified Communications Manager,
Cisco Unified Communications Manager Express routers, or Cisco Unity Express. For late-breaking
information about this version of TimeCardView, see the release notes.
This chapter covers:
•
Prerequisites, page 5
•
Types of TimeCardView Software Upgrades, page 6
•
Platforms and Cisco IOS Software Images, page 6
•
Cisco IP Phones Supporting TimeCardView, page 6
•
Software Licenses and Factory-Set Limits, page 7
•
Installing TimeCardView, page 7
•
Installing, Upgrading, or Downgrading Your TimeCardView License, page 9
Prerequisites
TimeCardView is provided as an add-on package to Cisco Unity Express, with which it co-resides on a
service module. Because you configure its users by enabling a Cisco Unity Express user as a
TimeCardView user, the installation of Cisco Unity Express is a prerequisite.
Verify that the telephones and extensions connected to the Cisco Unified CME router or
Cisco Unified Communications Manager server are configured. If you have not completed the
configuration, see the applicable version of the Cisco Unified Communications Manager Administrator
Guide or the applicable version of the Cisco Unified CME Administrator Guide for the procedures. For
Cisco Unified CME systems, you can use the Cisco Unity Express GUI for these procedures.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
5
Installation
Types of TimeCardView Software Upgrades
Types of TimeCardView Software Upgrades
Only one procedure is available for upgrading TimeCardView software, a clean install.
For a complete list of versions and the upgrade processes available for them, see the Release Notes for
TimeCardView 7.0.
Platforms and Cisco IOS Software Images
The TimeCardView application uses a set of commands that are similar in structure to Cisco IOS
software commands. However, TimeCardView commands do not affect the Cisco IOS configuration.
See the Release Notes for TimeCardView 7.0.x for detailed information about the supported
TimeCardView software images and hardware platforms.
TimeCardView is supported on:
•
Cisco 1861 Integrated Services Router
•
Enhanced network module (NME-CUE). The NME-CUE is a 24-port module that stores a maximum
of 250 voice mailboxes and 300 hours of voice messages.
Cisco IP Phones Supporting TimeCardView
TimeCardView supports the following Cisco Unified IP phone models:
Table 1
Cisco Unified IP Phones Supporting TimeCardView
Cisco 7921
Cisco 7925
Cisco 7931
Cisco 7940
Does not support the integrated login view of TimeCardView and VoiceView
Express (TimeCardView plus inbox option)
Cisco 7941
Cisco 7942
Cisco 7945
Cisco 7960
Does not support the integrated login view of TimeCardView and VoiceView
Express (TimeCardView plus inbox option)
Cisco 7961
Cisco 7962
Cisco 7965
Cisco 7970
Cisco 7971
Cisco 7975
Cisco CP500
Does not support the integrated login view of TimeCardView and VoiceView
Express (TimeCardView plus inbox option)
TimeCardView 7.0 CLI Administrator Guide
6
OL-17595-01
Installation
Software Licenses and Factory-Set Limits
Software Licenses and Factory-Set Limits
When you order TimeCardView, TimeCardView software is installed on the Cisco Unity Express
module at the factory. Spare modules also ship with the software installed.
For information about upgrading, or downgrading, see the relevant section of the Cisco Unity Express
Installation and Upgrade Guide.
System limits and license information for NME-CUE and information about Interactive Voice Response
(IVR) licenses, as well as for the Cisco 1861 are in the Release Notes for Cisco Unity Express. System
limits and license information for TimeCardView are in the Release Notes for TimeCardView7.0.x.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/).
Further information about the SSL and other Cisco Unity Express Software Copyrights and Licenses is
provided at:
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/rel2_3/licenses/lic_copy.html.
Installing TimeCardView
Installing this product entails only the first step below unless you intend to have TimeCardView integrate
with Intuit’s QuickBooks, in which case you must carry out the second and third steps in sequence:
1.
Installing the TimeCardView Package File on Cisco Unity Express, page 7 , and
2.
Configuring An Autologin for TimeCardView on Intuit’s QuickBooks, page 8
3.
Installing the TCVQB-Connector on Intuit’s QuickBooks Server, page 8.
Prerequisites
The following is required for installing TimeCardView:
•
The URL of the FTP server to which you have downloaded from the Cisco Software Download site
the following files (see the release notes for the exact file names):
– timecardview.version.pkg - Main package for TimeCardView on Integrated Service Engine
(ISE- c1861 only) and NME-CUE service modules
– timecardview.version.prt1 – Package payload containing all data and executable files
associated with TimeCardView on Integrated Service Engine (ISE - c1861 only) and
NME-CUE service modules.
If you want to integrate with QuickBooks,
– CUCE-TCVQB-Connector-Installer-version.exe – Self-installing image of TimeCardView
client for connecting to QuickBooks accounting software.
Installing the TimeCardView Package File on Cisco Unity Express
You can install or remove TimeCardView only in Cisco Unity Express online mode. You cannot add it
or remove it using the boothelper except when you perform a complete installation of the
Cisco Unity Express software. For more information, see your version of the Cisco Unity Express
Installation and Upgrade Guide.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
7
Installation
Installing TimeCardView
SUMMARY STEPS
1.
config t
2.
software download server url ftp://server-ip-address[/dir] [username username password
password]
3.
exit
4.
software install add package-name.
DETAILED STEPS
Step 1
Use config t to enter configuration mode.
Step 2
Enter software download server url ftp://server-ip-address[/dir][username username password
password] where
– server-ip-address is the URL of the FTP server
– username is the name of the valid user on the FTP server
– password is the username’s password to allow access to the FTP server
Step 3
Enter exit to exit configuration mode.
Step 4
Enter software install add package-name.
Configuring An Autologin for TimeCardView on Intuit’s QuickBooks
Although the description of this step does not fall within the scope of the present guide, you must
nonetheless configure an autologin for TimeCardView on the QuickBooks server at this point. For
instructions on this procedure, see the TimeCardView GUI Guide or the QuickBooks documentation.
Installing the TCVQB-Connector on Intuit’s QuickBooks Server
The TCVQB Connector is the utility that enables TimeCardView and QuickBooks to communicate; you
must install it on the server running QuickBooks and set its parameters for interfacing with
TimeCardView.
QuickBooks must be up and running when you install the TCVQB-Connector. During the installation,
the installer prompts you to enter:
•
a port number for the Connector to use to communicate with TimeCardView on the
Cisco Unity Express module
•
the path to and name of your QuickBooks company file, for example, C:\QBFiles\acme.QBW.
The default port number is 57343. You can change this after installation, by using Notepad to edit the
TCVConfig.ini file, which you find in the same folder where you installed the Connector. Your changes
do not take effect until you restart the TCVQB-Connector.
Access the The TCVQB-Connector log via the icon in the systray on the machine running QuickBooks.
The key to the log is as follows:
1 — errors, 2 — warnings and errors, 3 — debug messages, warnings and errors,
TimeCardView 7.0 CLI Administrator Guide
8
OL-17595-01
Installation
Installing, Upgrading, or Downgrading Your TimeCardView License
You must configure QuickBooks to allow TimeCardView access to the necessary files. For instructions,
see the TimeCardView GUI Guide or the QuickBooks documentation.
Installing, Upgrading, or Downgrading Your TimeCardView
License
See “Upgrading or Downgrading the Cisco Unity Express License in the Same Version” in your version
of the Cisco Unity Express Installation and Upgrade Guide.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
9
Installation
Installing, Upgrading, or Downgrading Your TimeCardView License
TimeCardView 7.0 CLI Administrator Guide
10
OL-17595-01
Configuring Your System
First published: January 2009
Revised: March 17, 2010
Command-line interface (CLI) commands are available to configure TimeCardView system components.
You enter all commands in Cisco Unity Express, some in EXEC mode, others in configuration mode,
and still others in TimeCardView service configuration mode..
This chapter describes the procedures for the following tasks:
•
Globally Enabling or Disabling TimeCardView, page 12
•
Disabling the TimeCardView Phone Screen Interface, page 14
•
Disabling the TimeCardView Telephone User Interface, page 16
•
Enabling TimeCardView Users, page 18
•
Setting TimeCardView Sessions, page 21
•
Setting Automatic Session Logout, page 23
•
Displaying and Clearing Sessions, page 25
•
Assigning Payroll Specialist Privileges, page 26
•
Designating Supervisors and Assigning Them to Employees, page 28
•
Configuring an Epage Address for an Employee, page 31
•
Setting the Week Start Day, page 33
•
Setting Working and Overtime Hours, page 35
•
Setting Time Limits on Employee Status, page 37
•
Database Purge Scheduling and Capacity, page 40
•
Configuring E-mail Notification, page 42
•
Purging or Clearing Data Manually, page 44
•
Copying Timesheets to an External FTP Server, page 46
•
Backing Up and Restoring, page 46
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
11
Configuring Your System
Globally Enabling or Disabling TimeCardView
Globally Enabling or Disabling TimeCardView
On the Cisco NME-CUE, TimeCardView is globally disabled by default after installation and activation.
You can only provide TimeCardView to individuals who are already Cisco Unity Express subscribers.
After globally enabling the service, you enable it for individual users. For a description of that
procedure, see “Enabling TimeCardView Users” on page 18.
Before you purge the TimeCardView database, you must disable the service.
To globally disable the service or enable it again, use the following procedure:
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
enable
or
no enable
4.
end
5.
end
6.
show timecardview configuration
TimeCardView 7.0 CLI Administrator Guide
12
OL-17595-01
Configuring Your System
Globally Enabling or Disabling TimeCardView
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
Enables TimeCardView
or
disables TimeCardView.
enable
Example:
se-10-0-0-0(service timecardview)# enable
no enable
Example:
se-10-0-0-0(service timecardview)# no enable
Step 4
Exits TimeCardView configuration mode.
end
Example:
se-10-0-0-0(service timecardview)# end
Step 5
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the TimeCardView configuration.
Example:
se-10-0-0-0# show timecardview configuration
Examples
The following example illustrates globally enabling the TimeCardView service.
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
Phone-call User Interface: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 60
Employee Session logout time (secs): 60
Week Start Day: Monday
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
13
Configuring Your System
Disabling the TimeCardView Phone Screen Interface
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): 1440
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
Notification Email(s):
se-10-0-0-0#
Disabling the TimeCardView Phone Screen Interface
By default, TimeCardView provides users with the phone screen user interface to guide them through all
its processes, like logging in and transitioning from one status to the next.
You can disable this service or re-enable it after disabling.
The output from the show run command indicates whether the phone screen user interface has been
disabled.
Note
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.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
user-interface phone-service disable
4.
end
5.
end
6.
show run
7.
copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
14
OL-17595-01
Configuring Your System
Disabling the TimeCardView Phone Screen Interface
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
user-interface phone-service disable
Disables the TimeCardView phone screen user
interface.
Example:
se-10-0-0-0(config-timecardview)# user-interface
phone-service disable
Step 4
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show run
Displays TimeCardView’s running configuration.
Example:
se-10-0-0-0# show run
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
15
Configuring Your System
Disabling the TimeCardView Telephone User Interface
Examples
The following output illustrates disabling the voice 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 run
Generating configuration:
[...]
service timecardview
daily overtime-duration minutes 90
daily working-duration minutes 480
enable
user-interface phone-service disable
end timecardview
[...]
end
se-10-0-0-0# copy running-config startup-config
se-10-0-0-0#
Disabling the TimeCardView Telephone User Interface
TimeCardView provides users with voice prompts to guide them through all its processes, like logging
in and transitioning from one status to the next. However, this service is disabled by default.
Use the following process to enable or disable this service.
The output from the show run command indicates whether the telephone user interface has been
disabled.
Note
Do not confuse the telephone user interface (TUI), which is audible on the phone, with the phone screen
user interface, which is visible on the phone.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
user-interface phone-call disable
4.
end
5.
end
6.
show run
7.
copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
16
OL-17595-01
Configuring Your System
Disabling the TimeCardView Telephone User Interface
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
user-interface phone-call disable
Disables the TimeCardView TUI (voice prompts).
Example:
se-10-0-0-0(config-timecardview)# user-interface
phone-call disable
Step 4
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show run
Displays TimeCardView’s running configuration.
Example:
se-10-0-0-0# show run
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
17
Configuring Your System
Enabling TimeCardView Users
Examples
The following output illustrates disabling the voice 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-call disable
se-10-0-0-0(config-timecardview)# end
se-10-0-0-0(config)# end
se-10-0-0-0# show run
Generating configuration:
[...]
service timecardview
daily overtime-duration minutes 90
daily working-duration minutes 480
enable
user-interface phone-call disable
end timecardview
[...]
end
se-10-0-0-0# copy running-config startup-config
se-10-0-0-0#
Enabling TimeCardView Users
You can provide TimeCardView service to individual users who are already Cisco Unity Express
subscribers, or in other words, you can add TimeCardView to Cisco Unity Express users. You do this by
setting an attribute for them, as described in the procedure in this section.
You can also provide TimeCardView service by importing users from Intuit’s QuickBooks using the
TimeCardView GUI. For instructions, see the TimeCardView GUI Guide or the online help. Imported
users are automatically enabled.
Note
Note
With regard to employees with the same name, the first time you synchronize timesheet data with
QuickBooks, TimeCardView drops into QuickBooks an identifier to distinguish between them.
You can see this in QuickBooks by going to Employees > Employee Center, and looking at the
names of the two employees. To the second one is appended “{userxxxx}” where xxxx is the
Cisco Unity Express extension. (QuickBooks takes no account of this identifier, because it uses
other data to distinguish between the two employees.)
QuickBooks can also provide you with Cisco Unity Express subscribers. Using the TimeCardView GUI,
you can import employee names from QuickBooks, and assign extensions to the already created
subscribers using the Cisco Unity Express CLI. If you do not want to give these subscribers
TimeCardView service, you must disable it for each of them individually.
Disable the TimeCardView service for individuals by using the no timecardview username command.
TimeCardView 7.0 CLI Administrator Guide
18
OL-17595-01
Configuring Your System
Enabling TimeCardView Users
Required Data for This Procedure
The following information is required for enabling or disabling TimeCardView for a
Cisco Unity Express subscriber:
•
user-id—The Cisco Unity Express username of the subscribers for whom you are making the
service available.
Note
Usernames and user-ids are case-sensitive.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
timecardview username user-id
3.
enable
or
no enable
4.
end
5.
end
6.
show timecardview users
7.
copy running-config startup-config
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
timecardview username user-id
Specifies a Cisco Unity Express subscriber and
enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config-tvuser)# timecardview username
theirname1
Step 3
enable
Example:
se-10-0-0-0(config-tvuser)# enable
or
no enable
Enables the TimeCardView service for the
Cisco Unity Express subscriber with the specified
user ID,
or
disables the TimeCardView service for the
Cisco Unity Express subscriber with the specified
user ID.
Example:
se-10-0-0-0(config-tvuser)# no enable
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
19
Configuring Your System
Enabling TimeCardView Users
Step 4
Command or Action
Purpose
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(config-tvuser)# end
Step 5
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview users
Displays a list of TimeCardView users configured on
the system and their status.
Example:
se-10-0-0-0# show timecardview users
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
Examples
The following example illustrates enabling the TimeCardView service for a specified 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#
TimeCardView 7.0 CLI Administrator Guide
20
OL-17595-01
Configuring Your System
Setting TimeCardView Sessions
Setting TimeCardView Sessions
The number of TimeCardView sessions is configurable, with the range extending 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
Number of Sessions per Platform
Platform
Maximum / Default Number of Sessions
Cisco 1861 Integrated Services Router
2
Cisco NME
8
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
maxsessions number
4.
end
5.
end
6.
show timecardview configuration
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
maxsessions number
Example:
Specifies the default/maximum number of sessions
Range: 2 to maximum number of sessions for your
platform. See Table 1 on page 21.
se-10-0-0-0(service timecardview)# maxsessions 2
Step 4
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(service timecardview)# end
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
21
Configuring Your System
Setting TimeCardView Sessions
Step 5
Command or Action
Purpose
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the maximum number of TimeCardView
sessions.
Example:
se-10-0-0-0# show timecardview configuration
TimeCardView 7.0 CLI Administrator Guide
22
OL-17595-01
Configuring Your System
Setting Automatic Session Logout
Examples
The following output illustrates the process of setting the maximum number of TimeCardView sessions:
se-10-0-0-0#
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
Phone-call User Interface: Enabled
Maximum Sessions: 2
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): 1440
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
Notification Email(s):
se-10-0-0-0#
Setting Automatic Session Logout
Automatic IP phone session logout time is configurable. Because no TimeCardView users should remain
in session indefinitely, the system automatically logs users out by default after 1 minute. Automatic
logout times for supervisors do not need to be the same as those for employees.
Set the automatic logout time in seconds. The range is 60 to 600 seconds (1 to 10 minutes).
To create TimeCardView users, see “Enabling TimeCardView Users” on page 18.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
session-expiry-time supervisor secs
or
session-expiry-time employee secs
4.
end
5.
end
6.
show timecardview configuration
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
23
Configuring Your System
Setting Automatic Session Logout
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode
Example:
se-10-0-0-0(config)# service timecardview
Step 3
session-expiry-time supervisor secs
Example:
Sets the amount of time that elapses before the system
automatically logs out the specified supervisor or
employee.
se-10-0-0-0(service-timecardview)# session-expiry-ti
me supervisor 600
or
session-expiry-time employee secs
Example:
se-10-0-0-0(service-timecardview)# session-expiry-ti
me employee 120
Step 4
Exits TimeCardView configuration mode
end
Example:
se-10-0-0-0(service-timecardview)# end
Step 5
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the supervisor and employee session logout
times.
Example:
se-10-0-0-0# show timecardview sessions
TimeCardView 7.0 CLI Administrator Guide
24
OL-17595-01
Configuring Your System
Displaying and Clearing Sessions
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
Phone-call User Interface: 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
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): 1440
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
Notification Email(s):
se-10-0-0-0#
Displaying and Clearing Sessions
You can clear any or all ongoing TimeCardView sessions. The following procedure describes first
displaying all sessions, then clearing a specific session, and finally clearing all sessions. The sequence
does not matter and you can omit any of these commands.
SUMMARY STEPS
EXEC mode:
1.
show timecardview sessions
2.
service timecardview session terminate user user-id
or
service timecardview session terminate all
3.
show timecardview sessions
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
25
Configuring Your System
Assigning Payroll Specialist Privileges
DETAILED STEPS
Step 1
Command or Action
Purpose
show timecardview sessions
Displays the TimeCardView sessions currently
active.
Example:
se-10-0-0-0# show timecardview sessions
Step 2
service timecardview session terminate user userid
Terminates the specified user’s session
or
Example:
Terminates all users’ sessions.
se-10-0-0-0# service timecardview session terminate
user theirname1
or
service timecardview session terminate all
Example:
se-10-0-0-0# service timecardview session terminate
all
Step 3
show timecardview sessions
Shows the active TimeCardView sessions.
Example:
se-10-0-0-0# show 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#
Assigning Payroll Specialist Privileges
Assign payroll specialist roles by invoking a group on which you confer payroll-specialist privileges.
Then you can add specified TimeCardView users as members to the group. You cannot designate as a
payroll specialist someone who is not already in the TimeCardView system.
Required Data for This Procedure
The following information is required for the tasks listed above:
•
Usernames of the employees who are to be payroll specialists:
– Owner(s) of the group
– Members of the group
TimeCardView 7.0 CLI Administrator Guide
26
OL-17595-01
Configuring Your System
Assigning Payroll Specialist Privileges
SUMMARY STEPS
EXEC mode:
1.
config t
2.
groupname tcv-payroll-specialists privilege tcv-payroll
3.
groupname tcv-payroll-specialists owner username
4.
groupname tcv-payroll-specialists member username
5.
end
6.
show timecardview payroll-specialists
7.
copy running-config startup-config
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
groupname tcv-payroll-specialists privilege
tcv-payroll
Grants the payroll specialist privilege to the specified
group.
Example:
se-10-0-0-0(config)# groupname
tcv-payroll-specialists privilege tcv-payroll
Step 3
groupname tcv-payroll-specialists owner username
Example:
Adds a TimeCardView user to the payroll specialist
group as owner, who controls the group. You can have
as many owners per group as you want.
se-10-0-0-0(config)# groupname
tcv-payroll-specialists owner theirname1
Step 4
groupname tcv-payroll-specialists member username
Adds a TimeCardView user to the payroll specialist
group as a member.
Example:
You can have multiple members per group.
se-10-0-0-0(config)# groupname
tcv-payroll-specialists member theirname2
Step 5
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
27
Configuring Your System
Designating Supervisors and Assigning Them to Employees
Examples
The following example illustrates granting payroll specialist privileges:
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#
Designating Supervisors and Assigning Them to Employees
To create a supervisor and assign employees to him or her, use the following procedures.
Note that in these procedures, the TimeCardView user begins as a user and becomes either an employee
or a supervisor depending on his or her role.
Note
User-ids are case-sensitive.
After designating supervisors, assign employees to them. 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
supervisor relationship ceases to exist.
If you specify an employee or a supervisor who is not already a TimeCardView user or one for whom
the TimeCardView service has been disabled, you receive an error message.
If you attempt to assign an employee to someone whom you have not already designated a supervisor,
you receive an error message. If you attempt to make an employee his or her own supervisor, you receive
an error message. If assigning a particular employee to a particular supervisor creates a circular reporting
relationship, you receive an error message.
Note
Using 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.
Note
Using the no username employee-id supervisor username supervisor-id [primary | alternate]
command removes the specified employee from the specified supervisor’s list of direct reports.
Required Data for This Procedure
•
Usernames of the employees who are to be supervisors
•
Usernames of the employees you allocate to each supervisor
TimeCardView 7.0 CLI Administrator Guide
28
OL-17595-01
Configuring Your System
Designating Supervisors and Assigning Them to Employees
SUMMARY STEPS
EXEC mode:
1.
config t
2.
username user-id supervisor designate
3.
username employee-id supervisor username supervisor-id alternate
4.
end
5.
show supervisors
6.
show supervisor supervisor-id all
7.
show supervisor supervisor-id direct
8.
show user supervisor username employee-id all
9.
show user supervisor username employee-id alternate
10. copy running-config startup-config
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
username user-id supervisor designate
Creates a supervisor.
Example:
se-10-0-0-0(config)# username theirname4 supervisor
designate
Step 3
username employee-id supervisor username
supervisor-id alternate
Example:
Assigns to the specified employee the specified
alternate supervisor. Unless you use the ‘alternate’
keyword, the supervisor is by default a primary
supervisor.
se-10-0-0-0(config)# username theirname40 supervisor
username theirname4
Step 4
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 5
show supervisors
Lists all the supervisors.
Example:
se-10-0-0-0# show supervisors
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
29
Configuring Your System
Designating Supervisors and Assigning Them to Employees
Step 6
Command or Action
Purpose
show supervisor supervisor-id all
Displays a list of all the employees reporting to the
specified supervisor.
Example:
se-10-0-0-0# show supervisor theirname4 all
Step 7
show supervisor supervisor-id direct
Displays a list of the employees reporting directly to
the specified supervisor. ’
Example:
se-10-0-0-0# show supervisor theirname4 all
Step 8
show user supervisor username employee-id all
Displays both of the specified employee’s
supervisors, primary and alternate.
Example:
se-10-0-0-0# show user supervisor theirname40 all
Step 9
show user supervisor username employee-id alternate
Example:
Displays the specified employee’s alternate
supervisor. To see the primary supervisor, substitute
the keyword ‘primary’for the keyword ‘alternate’.
se-10-0-0-0# show user supervisor username
theirname40 alternate
Step 10
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
30
OL-17595-01
Configuring Your System
Configuring an Epage Address for an Employee
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 #
Configuring an Epage Address for an Employee
To enable a supervisor to send a text message to an employee reporting to him or her, you must configure
an epage address for the employee.
If you do not configure e-page addresses for employees, when supervisors try to send text messages to
their employees, they get error messages saying that the epage address is empty.
The string argument for the epage keyword is an RFC-2822-compliant email address, for example,
[email protected].
SUMMARY STEPS
EXEC mode:
1.
config t
2.
username user-id epage string
3.
end
4.
show user detail username user-id
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
31
Configuring Your System
Configuring an Epage Address for an Employee
DETAILED STEPS
EXEC mode:
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
username user-id epage string
Configures an epage address for the specified
employee.
Example:
se-10-0-0-0(config)# username theirname4 epage
[email protected]
Step 3
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 4
show user detail username user-id
Displays details for the specified employee, in
particular, the epage address.
Example:
se-10-0-0-0# show user detail username theirname4
Examples
The following output 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 CLI Administrator Guide
32
OL-17595-01
Configuring Your System
Setting the Week Start Day
Setting the Week Start Day
By default, the starting day of the work week is Monday. Other days can be set using the following
procedure. The variable for the days of the week is a number:
1 - Monday
2 - Tuesday
3 - Wednesday
4 - Thursday
5 - Friday
6 - Saturday
7 - Sunday
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
week-start day 1-7
4.
end
5.
end
6.
show timecardview configuration
7.
copy running-config startup-config
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
week-start day 1-7
Sets the day on which the work week is to start.
Example:
se-10-0-0-0(timecardview-config)# week-start day 3
Step 4
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(config-timecardview)# end
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
33
Configuring Your System
Setting the Week Start Day
Step 5
Command or Action
Purpose
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Example:
Displays the day on which the work week is to start.
If this parameter is not set, the system displays the
default day, Monday.
se-10-0-0-0# show timecardview configuration
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
Examples
The following output illustrates the process of setting the day of the week on which work is to start:
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
Phone-call User Interface: Enabled
Maximum Sessions: 2
Supervisor Session logout time (secs): 60
Employee Session logout time (secs): 60
Week Start Day: Wednesday
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): 1440
Purge Cycle (days): 90
Purge Days-to-Keep (days): 30
Purge Time: 00:30
Notification Email(s):
se-10-0-0-0#
TimeCardView 7.0 CLI Administrator Guide
34
OL-17595-01
Configuring Your System
Setting Working and Overtime Hours
Setting Working and Overtime Hours
You can set a limit on the number of regular hours employees can work per day and on their overtime
hours.
If an employee does not change their status (from one state to another) before reaching the limit, the
system locks that person’s status so that he or she cannot change it, for example, to start a new shift. Only
the employee’s supervisor can unlock the person’s account and change the person’s status. To do this,
the supervisor uses the TimeCardView TUI.
TimeCardView users cannot accumulate more than 1440 minutes (24 hours) of regular and/or overtime
hours.
By default, TimeCardView users can accumulate up to 1440 minutes per day regular hours and 0
overtime hours. Therefore, if you do not set either of these parameters, employees can work up to 24
hours per day and the system logs all their hours as regular hours.
If you limit the number of regular hours employees can work (range: 1 to 24 hours) and set a limit of
zero on their overtime hours (range: 0 to 24 hours), they cannot accrue overtime.
Set the times in minutes to be worked per day. Cancel settings previously made by setting the default:
use the default or the no form of the command: [no | default] daily [working-duration |
overtime-duration] minutes number.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
daily working-duration minutes 1-1440
4.
daily overtime-duration minutes 0-1440
5.
end
6.
end
7.
show timecardview configuration
8.
copy running-config startup-config
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
35
Configuring Your System
Setting Working and Overtime Hours
Step 3
Command or Action
Purpose
daily working-duration minutes number
Sets the maximum number of minutes per day
employees can work. Range: 1 to 1440, default 1440.
Example:
se-10-0-0-0(timecardview-config)# daily
working-duration minutes 480
Step 4
se-10-0-0-0(timecardview-config)# daily
overtime-duration minutes 90
Sets the maximum number of overtime minutes per
day employees can work. Range: 0 to 1440, default 0.
If you change the default, do not forget to limit the
number of regular working hours, otherwise
employees cannot accrue overtime.
end
Exits TimeCardView configuration mode.
daily overtime-duration minutes number
Example:
Step 5
Example:
se-10-0-0-0(config-timecardview)# end
Step 6
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# exit
Step 7
show timecardview configuration
Displays the maximum number of regular and
overtime hours employees can work.
Example:
se-10-0-0-0# show timecardview configuration
Step 8
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
36
OL-17595-01
Configuring Your System
Setting Time Limits on Employee Status
Examples
The following output illustrates the process of 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 480
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
Service: Enabled
Phone-call User Interface: Enabled
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):
se-10-0-0-0# copy running-config startup-config
se-10-0-0-0#
Setting Time Limits on Employee Status
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.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
37
Configuring Your System
Setting Time Limits on Employee Status
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
shift limit work-duration minutes 1-1440
4.
shift limit lunch-duration minutes 1-1440
5.
shift limit break-duration minutes 1-1440
6.
end
7.
end
8.
show timecardview configuration
9.
copy running-config startup-config
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
shift limit work-duration minutes number
Limits the number of minutes employees can remain
in the work state. Range: 1 to 1440, default 1440.
Example:
se-10-0-0-0(timecardview-config)# shift limit
work-duration minutes 480
Step 4
shift limit lunch-duration minutes number
Limits the number of minutes employees can remain
in the lunch state. Range: 1 to 1440, default 1440.
Example:
se-10-0-0-0(timecardview-config)# shift limit
lunch-duration minutes 60
Step 5
shift limit break-duration minutes number
Limits the number of minutes employees can remain
in the break state. Range: 1 to 1440, default 1440.
Example:
se-10-0-0-0(timecardview-config)# shift limit
break-duration minutes 40
Step 6
Exits TimeCardView configuration mode.
end
Example:
se-10-0-0-0(config-timecardview)# end
TimeCardView 7.0 CLI Administrator Guide
38
OL-17595-01
Configuring Your System
Setting Time Limits on Employee Status
Step 7
Command or Action
Purpose
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# exit
Step 8
show timecardview configuration
Example:
Displays the maximum amount of time employees
can remain in any state. If these parameters are not
set, the system displays the defaults.
se-10-0-0-0# show timecardview configuration
Step 9
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
Examples
The following output illustrates the process of 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
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#
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
39
Configuring Your System
Database Purge Scheduling and Capacity
Database Purge Scheduling and Capacity
If you do not schedule database purges, TimeCardView purges itself when it overruns its maximum
capacity. Such a purge is not a simple dump; the system is set up to retain as much and as recent data as
possible. The design guidelines described below govern its behavior.
You can configure the system to dump old data and retain only the latest data by specifying the number
of days data should be kept.
You can schedule database purges to occur at specified intervals. However, if the database fills to
capacity before your scheduled purge, the system purges itself in accordance with the design guidelines
below.
Database Design Guidelines
The system checks its database every day at 11:30 p.m. If you configured TimeCardView to send
notification e-mails (see “Configuring E-mail Notification” on page 42), the system sends them when its
database reaches 70% of its capacity, again when it reaches 80%, and again when it reaches 85%
capacity. If nobody takes any action before the database reaches 90% capacity, the system deletes the
oldest 70% of the records, keeping the most recent 20%. This ensures that at least one month’s worth of
the latest data remains after a purge of this type.
You can always view dabatase usage with dates and times of purges, and sync status with dates and times
by using the show timecardview configuration command.
Note
You can also purge TimeCardView data manually. For instructions, see “Purging or Clearing Data
Manually” on page 44.
SUMMARY STEPS
EXEC mode:
1.
Config t
2.
service timecardview
3.
database purge schedule days number days-to-keep number
4.
end
5.
end
6.
show timecardview configuration
7.
copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
40
OL-17595-01
Configuring Your System
Database Purge Scheduling and Capacity
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
database purge schedule days number days-to-keep
number
Specifies the number of days between purges and the
minimum number of days the system must keep data.
Example:
se-10-0-0-0(timecardview-config)# database purge
schedule days 90 days-to-keep 30
Step 4
end
Exits TimeCardView configuration mode.
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the number of days between purges and the
minimum number of days data is to be kept.
Example:
se-10-0-0-0# show timecardview configuration
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
41
Configuring Your System
Configuring E-mail Notification
Examples
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
Service: Enabled
Phone-call User Interface: Enabled
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):
se-10-0-0-0#
Configuring E-mail Notification
TimeCardView can automatically notify specified e-mail recipients when certain database usage
threshholds are reached (see “Database Design Guidelines” on page 40) and when database purges
occur. Use the following procedure to set the e-mail addresses of those who receive notification. You can
specify multiple addresses separated by commas. The system has a 64 character limit (including
commas).
Required Data for This Procedure
The following information is required for the tasks described above:
•
Email addresses for those to be notified of database purges.
TimeCardView 7.0 CLI Administrator Guide
42
OL-17595-01
Configuring Your System
Configuring E-mail Notification
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
notification email address email-address
4.
end
5.
end
6.
show timecardview configuration
7.
copy running-config startup-config
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
se-10-0-0-0(timecardview-config)# notification email
address [email protected],[email protected]
Specifies the e-mail address(es) of the recipient(s) of
the notification e-mails. You can have multiple email
addresses, each separated from the next by a comma.
However, there is a limit of 64 characters (including
commas).
end
Exits TimeCardView configuration mode.
notification email address email-address
Example:
Step 4
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
end
Exits configuration mode.
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the e-mail address(es) to which notification
will be sent.
Example:
se-10-0-0-0# show timecardview configuration
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
43
Configuring Your System
Purging or Clearing Data Manually
Examples
The following example illustrates configuring email notification of specified individuals about
TimeCardView database 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
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#
Purging or Clearing Data Manually
You can delete all the records in the TimeCardView database, and still retain all your configuration data,
which is to say that you can keep the schema in place. 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.
You must disable the TimeCardView service before executing a purge (see “Globally Enabling or
Disabling TimeCardView” on page 12
After you enter the command to clear the data and before the system does so, you receive a warning
message. You must acknowledge this warning before the system proceeds with the purge. When it
finishes, the system sets the resource usage to zero.
TimeCardView 7.0 CLI Administrator Guide
44
OL-17595-01
Configuring Your System
Purging or Clearing Data Manually
SUMMARY STEPS
Cisco Unity Express EXEC mode:
1.
service timecardview purge now
2.
y
3.
show timecardview status
DETAILED STEPS
Cisco Unity Express EXEC mode:
Step 1
Enter service timecardview purge now.
The system displays a warning message.
Step 2
Enter y to acknowledge the warning message or n to abort the purge operation.
Step 3
Enter show timecardview status.
Examples
The following output 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#
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
45
Configuring Your System
Copying Timesheets to an External FTP Server
Copying Timesheets to an External FTP Server
You can copy timesheet records to an external FTP server. TimeCardView converts them into comma
separated values (CSV) and saves them to a plain text file. You specify the name of the file and the URL,
for example, ftp:ftp.nowhere.com/dir/filename.
copy timecardview timesheets url URL username name password password
After you enter the command, the system displays the status of the transfer.
Note
You cannot transfer the CSV file back into TimeCardView.
You can customize this CSV file to create new types of timesheet reports. It contains the following fields,
in the sequence shown below:
•
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
Backing Up and Restoring
TimeCardView can be backed up and restored using your Cisco Unity Express backup function. The
Cisco Unity Express command backup category all in Cisco Unity Express offline mode backs up
timesheets in addition to all other data.
Your TimeCardView configuration is backed up and restored with the other Cisco Unity Express
configuration data, which ensures that both configurations are synchronized. Backup history is
conserved in accordance with the same schema as Cisco Unity Express. For more information on this,
see your version of the Cisco Unity Express CLI Administrator Guide.
Note
Avoid backing up or restoring when work shifts are in progress. If you try to do so, you receive a warning
message, which you must acknowledge before you can proceed. If you do proceed, any TimeCardView
user whose status is ‘at work’ at the time of the backup is changed to ‘locked’ in the backup file. If this
backup file is used in a restore process, a supervisor must override the locked status with the correct date
and time information.
TimeCardView 7.0 CLI Administrator Guide
46
OL-17595-01
Configuring Your System
Backing Up and Restoring
If you restore and TimeCardView discovers a discrepancy between the old data and the data currently
being gathered, the system appends the current shift activities of all users to the restored data so that the
ongoing shift information is conserved. In other words, the restore process does not overwrite any
already recorded timesheet data.
You can secure your backups by transferring data over an SSL connection or by encrypting backup files.
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
47
Configuring Your System
Backing Up and Restoring
TimeCardView 7.0 CLI Administrator Guide
48
OL-17595-01
Integrating With Intuit’s QuickBooks
First published: January 2009
Revised: March 17, 2010
Integration with QuickBooks is optional.
Contents
•
Configuring TimeCardView to Talk to QuickBooks, page 49
•
Syncing Manually with QuickBooks, page 51
Configuring TimeCardView to Talk to QuickBooks
To export timesheet data to QuickBooks, the system requires access to a specific file on the QuickBooks
server. On the TimeCardView side, you must specify the QuickBooks server’s DNS name or its IP
address. By default, the TCVQBConnector uses port number 57343 for handling requests from
Cisco Unity Express. You must configure the port number only if you want the the TCVQB-Connector
to use a port number other than its default.
After setting up the QuickBooks permissions for TimeCardView referenced in Configuring An
Autologin for TimeCardView on Intuit’s QuickBooks, page 8 and completing the procedure below,
verify that the two applications are communicating properly. To do this, look at the log by right-clicking
the TCVQB-Connector icon in the systray and selecting the "View Log" option.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
payroll server quickbooks address address port number
4.
end
5.
end
6.
show timecardview configuration
7.
copy running-config startup-config
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
49
Integrating With Intuit’s QuickBooks
Configuring TimeCardView to Talk to QuickBooks
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
Step 3
payroll server quickbooks address address port
number
Example:
se-10-0-0-0(timecardview-config)# payroll server
quickbooks address 192.0.2.3 port 7
Step 4
Points TimeCardView to the QuickBooks payroll
server. The address variable is either the DNS name
or the IP address. The port number is required if the
TCVQUB-Connector uses a port number other than
its default, 57343.
Exits TimeCardView configuration mode.
end
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the payroll server setup and related
information.
Example:
se-10-0-0-0# show timecardview configuration
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
Examples
The following example illustrates setting the QuickBooks payroll server parameters.
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 192.0.2.3 port 7
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
Maximum Sessions: 2
TimeCardView 7.0 CLI Administrator Guide
50
OL-17595-01
Integrating With Intuit’s QuickBooks
Syncing Manually with QuickBooks
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):
se-10-0-0-0#
Syncing Manually with QuickBooks
You can synchronize TimeCardView with QuickBooks by either transferring only approved timesheets
or all timesheets. The default behavior is to transfer all timesheets.
If TimeCardView cannot make the transfer, you receive an error message, for example, “Timesheets in
an invalid URL. Please try again.” This message indicates that the IP address or DNS name you gave for
the QuickBooks server was wrong, or that the QuickBooks administrator did not set up TimeCardView
with the correct access privileges as described in “Configuring TimeCardView to Talk to QuickBooks”
on page 49.
SUMMARY STEPS
EXEC mode:
1.
service timecardview synchronize now timesheets approved
2.
show timecardview status
DETAILED STEPS
Step 1
Command or Action
Purpose
service timecardview synchronize now timesheets
approved
Transfers TimeCardView data to QuickBooks.
Optionally you can specify the transfer of approved
timesheets only.
Example:
se-10-0-0-0# service timecardview synchronize now
timesheets approved
Step 2
show timecardview status
Displays the time and the date that the last
synchronization took place.
Example:
se-10-0-0-0# show timecardview status
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
51
Integrating With Intuit’s QuickBooks
Scheduling Synchronization with QuickBooks
Examples
se-10-0-0-0# service timecardview synchronize now timesheets approved
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):
Payroll Sync Status (04/12/2008 18:06:43):
se-10-0-0-0#
Scheduling Synchronization with QuickBooks
You can configure a schedule for synchronizing TimeCardView with QuickBooks, specifying daily or
weekly, the day of the week, and the time of day. You can also specify whether all timesheets are to be
transferred or only those that have been approved.
SUMMARY STEPS
EXEC mode:
1.
config t
2.
service timecardview
3.
payroll server synchronization schedule weekly day 7 time 22:00 timesheets all
4.
end
5.
end
6.
show timecardview configuration
7.
copy running-config startup-config
DETAILED STEPS
Step 1
Command or Action
Purpose
config t
Enters configuration mode.
Example:
se-10-0-0-0# config t
Step 2
service timecardview
Enters TimeCardView configuration mode.
Example:
se-10-0-0-0(config)# service timecardview
TimeCardView 7.0 CLI Administrator Guide
52
OL-17595-01
Integrating With Intuit’s QuickBooks
Scheduling Synchronization with QuickBooks
Step 3
Command or Action
Purpose
payroll server synchronization schedule weekly day
1-7 time hh:mm timesheets all
Configures the synchronization schedule, daily or
weekly. If you set a daily schedule, you must specify
the time using the 24 hour clock; if you set a weekly
schedule, you must also specify the day of the week:
Example:
se-10-0-0-0(timecardview-config)# payroll server
synchronization schedule weekly day 7 time 22:00
timesheets all
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
For timesheets, you must specify either all or
approved.
Step 4
Exits TimeCardView configuration mode.
end
Example:
se-10-0-0-0(config-timecardview)# end
Step 5
Exits configuration mode.
end
Example:
se-10-0-0-0(config)# end
Step 6
show timecardview configuration
Displays the synchronization schedule.
Example:
se-10-0-0-0# show timecardview configuration
Step 7
copy running-config startup-config
Copies the configuration changes to the startup
configuration.
Example:
se-10-0-0-0# copy running-config startup-config
Examples
The following output 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
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
53
Integrating With Intuit’s QuickBooks
Scheduling Synchronization with QuickBooks
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
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
TimeCardView 7.0 CLI Administrator Guide
54
OL-17595-01
INDEX
A
D
access
data transfer status
2
adding TimeCardView users
alternate supervisor
deleting
2
direct reports
28
automatic
supervisors
IP phone session logout time
session logout
46
28
28
deleting TimeCardView users
23
direct reports, deleting
23
2
28
disabling the TimeCardView service for individuals
B
E
backup
encryption
security
Break state
employee
47
status
47
2
enable command
2
button
encryption
Services (Cisco IP phone)
e-page
2
12
47
2
exceeding maximum working hours
2
C
chain, reporting
I
28
Cisco IP phone interface
clocking out
individual disablement of TimeCardView
2
interface
2
command
enable
Cisco IP phone
2
phone interface
2
IP
12
service timecardview
12
show timecardview configuration
show timecardview status
timecardview username
user-interface phone-call
47
creating supervisors
IP phone session, automatic logout
12
19
L
16
14
locking out
2
logout, automatic IP phone session
28
23
40, 44
user-interface phone-service disable
connection, SSL
18
logout time, session
23
24
TimeCardView 7.0 CLI Administrator Guide
OL-17595-01
55
18
Index
Lunch state
2
Break
2
Lunch
2
Shift
M
2
Work
2
status
maximum
working hours, exceeding
message, voice
data transfer
2
employee
2
mode, offline
46
2
show timecardview command
46
40, 44
supervisor
alternate
O
28
primary
offline mode
28
relationship, pre-existing
46
28
supervisors
P
password
creating
28
deleting
28
removing employees from
2
pre-existing supervisor relationship
primary supervisor
28
28
28
T
time, session logout
R
24
timecardview username command
removing employees from supervisors
19
TimeCardView users
28
reporting chain
28
adding
restore security
47
deleting
2
2
U
S
security, backup and restore
Services button (Cisco IP phone)
service timecardview command
session logout, automatic
session logout time
user-interface phone-call command
47
user-interface phone-service disable command
2
14
12
23
V
24
voice message
Shift
state
16
2
2
show timecardview configuration command
show timecardview status command
SSL connection
12
W
40, 44
47
working hours, exceeding maximum
Work state
state
2
2
TimeCardView 7.0 CLI Administrator Guide
56
OL-17595-01