Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Administrators Guide
Table Of ContentsWhats Covered in the Admin Guide ...........................................................................
Table Of Contents      Microsoft SQL Server Database ........................................................................
Administrators Guide      Configuring Email Notifications ...................................................................
Whats Covered in the Admin GuideThis guide covers the administrative issues and tasks to be done for deployment of an OnTi...
OnTime 2008 OverviewIntroduction to OnTimeOnTime is a multi-user Defect, Feature, Incident and Task Management system desi...
OnTime 2008 OverviewImage          related screenshots, specifications and other documents toAttachment     be attached to...
Administrators Guide                                 a Web interface. Using the OnTime Remote Server,                     ...
OnTime 2008 Overviewcustom email templates to ensure all of the appropriate information is conveyed via user and customern...
Administrators GuideThis new custom field type allows the creation of new custom fields that contain hyperlinks to web sit...
OnTime 2008 Overview   OnTime 2008 Remote Server -allows remote connectivity to an OnTime database through Web    Service...
Administrators Guideside installation and can be accessed by users with just a web browser. No additional software isneede...
OnTime 2008 OverviewNotice that in the OnTime for VS.NET interface, all of the defects, features, and tasks are shown in o...
Administrators GuideWith the Customer Portal, your customers can work with defects, features and incidents. The OnTimeadmi...
OnTime 2008 OverviewUsers of OnTime Web Server and OnTime Customer Portal should not use Windows IntegratedAuthentication,...
Administrators Guideupdates from the database via database refreshes. All desktop users of OnTime connect to a singleSQL s...
Administrator GuideStartup WizardWhen first logging into the database, you will be presented with the Startup Wizard scree...
Administrators GuideIn Step 1 of the Startup Wizards, enter a password to be using by the built in Admin account.14
Administrator Guide                15
Administrators GuideIn Step 2 of the Startup Wizard, you can determine which of our object types you are planning on using...
Administrator GuideIn Step 3 of the Startup Wizard, you can select how your items will be named globally:                 ...
Administrators Guide18
Administrator GuideIn Step 4 of the Startup Wizard, you can decide whether you would like to enable Work Logs. WorkLogs ar...
Administrators GuideNext, Chose if youd like to create basic data to help you get started, including a list of tasks to he...
Administrator Guide                21
Administrators GuideStep 6 within the Web Edition startup wizard allows the default width options to be determined to allo...
Administrator Guide                23
Administrators Guide   Planning your OnTime Deployment   Prior to installing OnTime 2008, you might find it helpful to hav...
Administrator Guidetracking. OnTime 2008 Express edition allows users to quickly get up and running easily.     Please not...
Administrators Guide    You have many tens, hundreds, thousands or even millions of customers, for whom you would like   ...
Administrator Guide         http://msdn2.microsoft.com/en-us/express/bb410792.aspxOnce on that page, scroll down and find ...
Administrators Guide     4.   In the command prompt, switch to the “C:MSDERelA” directory     5.   Now type the following ...
Administrator Guide   Windows 2000/XP/2003/Vista   Visual Studio.NET 2005   SQL Server 2000/2005, MSDE 2000, or SQL 200...
Administrators GuideClick Next and the license agreement screen will appear:30
Administrator GuideOn the next screen, chose whether OnTime will be installed for all users or just the user installing.On...
Administrators GuideThe next step is to define where the Windows client will be installed. If the default folder is not co...
Administrator GuideUse the Finish button to end the installation. Once this is done, the installation is complete. (It isr...
Administrators GuideClick Next and the license agreement screen will appear:34
Administrator GuideOn the next screen, chose whether OnTime will be installed for all users or just the user installing.On...
Administrators GuideThe next step is to define where the Web files will be installed. If the default folder is not correct...
Administrator GuideOn the next screen, chose to have OnTime Setup create the needed virtual directory within IIS or toonly...
Administrators GuideUse the Finish button to end the installation. It is recommended to use Windows Update to ensure thatt...
Administrator GuideClick Next and the license agreement screen will appear:                                               ...
Administrators GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason the...
Administrator GuideThe next step is to define where the VS.Net client will be installed. If the default folder is not corr...
Administrators GuideUse the Finish button to end the installation. As recommended on the screen, use Windows Update toensu...
Administrator GuideClick Next and the license agreement screen will appear:                                               ...
Administrators GuideOnce the I Agree radio button is selected, the Next button will become active. If for some reason thel...
Administrator GuideThe next step is to define where the E-mail Services will be installed. If the default folder is not co...
Administrators GuideClick Next and the license agreement screen will appear:46
Administrator GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason thel...
Administrators GuideThe next step is to define where the Customer Portal files will be installed. If the default folder is...
Administrator GuideThe next step is to create a virtual directory for the installation. This directory will hold the infor...
Administrators GuideUse the Finish button to end the installation.Once the OnTime 2008 Customer Portal site has been insta...
Administrator GuideClick Next and the license agreement screen will appear:                                               ...
Administrators GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason the...
Administrator GuideThe next step is to define where the Remote Server files will be installed. If the default folder is no...
Administrators GuideOn the next screen, chose to have OnTime Setup create the needed virtual directory within IIS or toonl...
Administrator GuideThe next step is to create a virtual directory for the installation. This directory will hold the infor...
Administrators Guide       From the OnTime for VS.NET Client       The first time that Visual Studio.NET is started after ...
Administrator GuideOnTime 2008 requires a connection to an existing installation of Microsoft SQL Server to either create ...
Administrators Guide     6.   Optionally, choose to populate the new database with Sample Data. If you are simply         ...
Administrator GuideIn the Activation Key field, enter the activation key that was obtained from Axosoft. When the key isen...
Administrators GuideActivating an OnTime Database ManuallyIf you have difficulty activating your OnTime database, contact ...
Administrator Guide   OnTime will then ask for the information you were provided by Axosoft staff. Provide this informatio...
Administrators Guide                                          OnTime Windows                                         OnTim...
Administrator GuideAfter clicking OK on the Convert Trial key dialog, the OnTime Windows will restart or OnTime WebEdition...
Administrators Guide                                             OnTime Web Edition   Items marked with a red X will need ...
Administrator GuideLogging Into OnTime for the First TimeDuring the database creation process, OnTime creates a built-in u...
Administrators GuideGeneral SettingsThe General Settings section allows global options to be specified.    Allow workflow...
Administrator Guide   Include the current users email address in the list of from emails when sending emails -    Another...
Administrators GuideItem TypesThe item types settings allow you to customize the labels of the item types (e.g. change the...
Administrator GuideTo modify the labels, simply edit the current labels. Make sure that if you change an item types labely...
Administrators GuideTo modify the labels, in Windows simply double-click the label in the Display Label column to edit it,...
Administrator GuideSimply un-check the detail tabs that you wish to hide from the user interface.Item Details SettingsThe ...
Administrators GuideAttachmentsThe attachments options allow the administrator to limit how attachments can be stored.   ...
Administrator Guide   List users by project access - This checkbox allows you to filter the list of users so that only us...
Administrators Guide    Incident Number Prefix - allows the beginning of the incident to be specified. This leading     a...
Administrator GuideLockingOnTime 2008 supports large amounts of concurrent users. To help prevent any item or data loss th...
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Administrator guide
Upcoming SlideShare
Loading in …5
×

Administrator guide

1,437 views

Published on

ontime test

Published in: Technology
  • Be the first to comment

Administrator guide

  1. 1. Administrators Guide
  2. 2. Table Of ContentsWhats Covered in the Admin Guide ............................................................................................................... 1OnTime 2008 Overview .................................................................................................................................. 2 Introduction to OnTime................................................................................................................................ 2 Features and Benefits.............................................................................................................................. 2 Typical Installation ................................................................................................................................... 4 OnTime in the Enterprise ......................................................................................................................... 4 Whats New in OnTime 2008....................................................................................................................... 4 Project Wiki.............................................................................................................................................. 5 Custom Fields for Projects....................................................................................................................... 5 Custom Customer and Customer Contact Fields..................................................................................... 5 Import Customers and Customer Contacts.............................................................................................. 5 Enhanced Email Templates ..................................................................................................................... 5 Item Locking ............................................................................................................................................ 5 New Custom Field Type - Hyperlink......................................................................................................... 5 Alerts on Workflow Steps......................................................................................................................... 6 Customers Can Add Themselves to Notification Lists ............................................................................. 6 Reschedule Features............................................................................................................................... 6 Drag and Drop Attachments .................................................................................................................... 6 Multi-Edit Fields User Option ................................................................................................................... 6 The OnTime Product Line ........................................................................................................................... 6 OnTime for Windows ............................................................................................................................... 7 OnTime Web Edition................................................................................................................................ 7 OnTime for VS.NET................................................................................................................................. 8 OnTime Customer Portal ......................................................................................................................... 9 OnTime Remote Server ......................................................................................................................... 10 How database authentication works .......................................................................................................... 10 OnTime to SQL: Windows Integrated Authentication............................................................................. 10 OnTime to SQL: SQL Authentication ..................................................................................................... 11 How do the OnTime Products Fit Together? ............................................................................................. 11 ii
  3. 3. Table Of Contents Microsoft SQL Server Database ............................................................................................................ 11 OnTime Remote Server ......................................................................................................................... 11 OnTime for Windows and OnTime for VS.Net ....................................................................................... 11 OnTime Web Edition.............................................................................................................................. 12 OnTime Customer Portal ....................................................................................................................... 12 OnTime SDK.......................................................................................................................................... 12Administrator Guide ...................................................................................................................................... 13 Startup Wizard........................................................................................................................................... 13 Planning your OnTime Deployment........................................................................................................... 24 Choosing OnTime Products................................................................................................................... 24 Deciding if you need OnTime Email Service.......................................................................................... 25 Deciding if you need Customer Portal ................................................................................................... 25 Deciding if you need the Remote Server ............................................................................................... 26 Microsoft SQL Server 2005 or SQL Express Edition ............................................................................. 26 Microsoft SQL Server 2000 or MSDE 2000 ........................................................................................... 27 OnTime Installation ................................................................................................................................... 28 Installation requirements........................................................................................................................ 28 OnTime for Windows Installation Process ............................................................................................. 29 OnTime Web Server Installation Process .............................................................................................. 33 OnTime for VS.Net Installation Process................................................................................................. 38 OnTime Email Service Installation Process ........................................................................................... 42 OnTime Customer Portal Installation Process ....................................................................................... 45 OnTime Remote Server Installation Process ......................................................................................... 50 Setting up OnTime 2008............................................................................................................................ 55 OnTime Database Setup Window.......................................................................................................... 56 How OnTime and SQL Server Communicate ........................................................................................ 58 Activating an OnTime Database ............................................................................................................ 58 Converting Between Professional and Express ..................................................................................... 61 Logging Into OnTime for the First Time ................................................................................................. 65 Configuring System Options .................................................................................................................. 65 iii
  4. 4. Administrators Guide Configuring Email Notifications .............................................................................................................. 76 Setting up OnTime 2008 Email Service..................................................................................................... 79 Managing Email Accounts ..................................................................................................................... 82 Setting up OnTime 2008 Customer Portal................................................................................................. 92 Configuring OnTime Customer Portal.................................................................................................... 93 Managing Customer Portal Customers ................................................................................................ 107 Customer Portal Single Sign-On.......................................................................................................... 115 External Customer Portal Authentication ............................................................................................. 115 External Customer Portal Authentication Sample ................................................................................ 116 Setting up OnTime 2008 Remote Server................................................................................................. 122 Create New Database or Connect to an Existing Database ................................................................ 122 Setting up a Security GUID.................................................................................................................. 124 Connecting to an OnTime Remote Server ........................................................................................... 125 Administrative How-To Information ......................................................................................................... 126 Upgrading an OnTime Database ......................................................................................................... 127 Backing Up and Restoring Databases ................................................................................................. 128 Importing Content ................................................................................................................................ 131 Adjusting Web and Portal Session State ............................................................................................. 138 Managing Locks................................................................................................................................... 139Index ........................................................................................................................................................... 141 iv
  5. 5. Whats Covered in the Admin GuideThis guide covers the administrative issues and tasks to be done for deployment of an OnTime 2008Solution. The guide walks the administrator of the OnTime System through step-by-step instructions onhow to plan for, install and setup OnTime.This guide also includes some common administrative tasks such as Upgrading an OnTime Databasefrom previous versions, Importing Data into your OnTime database and Exporting OnTime Data to aCSV file. 1
  6. 6. OnTime 2008 OverviewIntroduction to OnTimeOnTime is a multi-user Defect, Feature, Incident and Task Management system designed to allowteams of software developers and testers to manage and track all aspects of a software project. Thesystem tracks all user information, settings, projects, defects, features and tasks through a centrallyshared database hosted by Microsoft SQL Server 2000, SQL Server 2000 MSDE, SQL Server 2005Standard, or SQL Server 2005 Express.Features and BenefitsA brief summary of OnTimes unique functionality is provided in the table below: Feature Benefit Project OnTime allows for defects, features, incidents and tasks to Hierarchy be tracked and organized by project using a hierarchical Tree tree, much like the Windows file system. This powerful feature allows for work items related to a project to be grouped together and found easily with just the click of a button. Project Wiki OnTime allows you to create Wiki pages associated to your projects to track or present information vital to your project. You can create and collaborate on project specifications, coding guidelines or any other information that youd like. You can also view an automatically generated table of contents, see recent changes to your wiki pages, or search through wiki pages to easy find the information needed. Multi-User OnTime allows for any number of users to simultaneously Support access the OnTime database and work with the same data from multiple platforms. It automatically tracks all user settings for each user and prevents data loss by locking items that are currently in use. Locks can be configured to automatically refresh and timeout after a period of time has pass as well as manually managed through the Lock Manager. OnTime installations have been tested with as many as 1,000 users. Full OnTime allows for administrators to create custom fields, Customizati modify the look of add/edit screens, modify the view on windows, create custom filters and much more to impliment your development or support processes into OnTime. Nearly all aspects of OnTimes functionality can be customized and Axosoft provides a Web Services SDK for integrating defect reporting and feature request capabilities into existing or new applications. File and OnTimes unlimited file attachment capabilities allows for 2
  7. 7. OnTime 2008 OverviewImage related screenshots, specifications and other documents toAttachment be attached to any defect, feature, task, incident or evens project. OnTime even allows for this information to be stored inside the OnTime database so that any user can access attachments from any client type - even over the Internet.Role & OnTimes powerful security features allow information to beProject locked and secured based on definable user roles. AnySecurity number of security roles can be defined to provide the exact set of privileges and limit project access. Each user can in turn have any number of assigned roles, so a user can act as a tester on some projects, while he or she might have developer privileges on another set of projects.Full Audit OnTime tracks all user changes to defects, features, andTrails & incidents creating a detailed set of audit information thatHistory includes the person who made the change, the date and time of change as well as the details of each change.Powerful If youre currently tracking defects, features or tasks in aImport/Expo spreadsheet or some other tool, no worries. You canrt import all your existing items using OnTimes powerful import capabilities, which include the ability to map your existing fields to the appropriate OnTime field, set default values for new fields and even save your templates for future reuse.Email Email Notifications allow every team member to stayNotification informed about changes to items tracked in the system.s OnTimes powerful email notification includes the ability to subscribe to changes of defects and features by item, by project or globally. You can even subscribe customers to receive email notification of changes. Email notifications can also be configured extensively to include the desired information and format.Powerful OnTime includes more than 15 built-in reports that provideReporting an extensive view on you projects. Applicable reports automatically pick up current filter and search criteria so that there is no need to "setup" the report before looking at a preview. Reports can also be exported to PDF format so you can easily share reports with colleagues who dont necessarily have access to OnTime. OnTime also provides an end-user report designer, allowing you to create powerful custom reports.Customer The optional OnTime Customer Portal allows you to setupPortal a brandable customer-facing web site that provides a means for your customers to self-register to report and view defects and feature requests. Using the Customer Portal Admin, you can easily define the specific access level for your customers, down to the fields and projects that customers are allowed to see.Enterprise Users who access the OnTime system from outside theConnectivity corporate network or within environments that are not able to access the database directly are no longer limited to just 3
  8. 8. Administrators Guide a Web interface. Using the OnTime Remote Server, remote Windows Client or VS .Net Plugin users can now connect to an OnTime database through a web service using an SSL secured HTTPS connection, even from behind a firewall and proxy. Choice of OnTime provides users with the choice of 3 different Clients clients: Windows Desktop application, a Web client accessed through a web browser (Internet Explorer, FireFox, Netscape and Safari are supported) or through an integrated client inside the Visual Studio.NET environment. Users can optionally choose to access the system using all 3 clients depending on which client meets their needs at any given time. State-of-the- OnTime was designed from the ground up using state-of- Art the-art technologies including 100% managed .NET Code Technology and Microsoft SQL Server backend. This emphasis on design and technology has allowed OnTime to have incredible application performance, reliability and scalability.Typical InstallationA typical OnTime 2008 installation consists of multiple users, each with a different role. For example,most installations will include users who are project managers, developers and testers. Each user typeor individual user might prefer a different client type. OnTime Windows Client - This type of client is usually preferred by software testers and project managers and provides a rich desktop application to access the OnTime system. OnTime Web Client - This browser-based client is usually preferred by remote users, or users who are away from their desk and need access to the OnTime system. OnTime VS.NET Client - This integrated Visual Studio.NET client is usually preferred by software developers who dont want to leave the VS.NET IDE to access the OnTime system.Although OnTime supports multiple databases, most teams will find a single database is sufficient fortracking all projects and related information.OnTime in the EnterpriseLarger organizations might choose to install the entire line of OnTime solutions, including the OnTimeCustomer Portal, Remote Server and Web Services SDK. In such scenarios, the installation of OnTimemight become more complex. OnTime can easily scale from a single-user application to an enterprise-ready solution handling hundreds or even thousands of users and projects.Whats New in OnTime 2008OnTime 2008 delivers over 60 new features that help software development teams collaborate and shipsoftware on time better than ever before. Major highlights include a new project wiki that inherits muchof OnTime’s trademark usability, including the project hierarchy. Extreme customization has beenadded at the project and customer levels. And, now OnTime allows users to configure a number of4
  9. 9. OnTime 2008 Overviewcustom email templates to ensure all of the appropriate information is conveyed via user and customernotifications. Here are some of our favorite new features.Project WikiOnTime 2008 has been energized with a new Project Wiki. This new feature acts as a collaborationpoint for your projects where requirements, processes, attachments and knowledge can be shared. It’sthe perfect starting point for any new project, it continues to be useful throughout the project life cycle,and permanently captures information that would otherwise be lost in personal email conversations. Now, each folder in your project hierarchy acts as a unified information repository. You can easilycreate new pages within the tree structure, add links to other relevant pages, and even include imagesfrom your OnTime database. Since your project wiki is right inside of OnTime, this eliminates the needfor a separate application that requires duplicate user accounts and security roles. With OnTime, yourteams wiki is self-managed and secure. Audit trails keep an historical archive of all changes, while theintuitive Table of Contents and Recently Changed Pages views help ensure your team can effortlesslystay up to date.Custom Fields for ProjectsThe power of OnTime custom fields has now been extended to Projects. Easily control what specificproject data you would like to track and how you would like it to be organized on the screen. The newCustom Fields Layout window, with its drag-and-drop interface, makes it easier than ever to tailor fitOnTime to your business needs.Custom Customer and Customer Contact FieldsWith OnTime 2008 tracking your important Customers and Customer contacts information has neverbeen easier. Now with the easy to use drag and drop based Custom Field Layout editor, you can easilycreate groups and organize your customer custom fields. Also, Customer and Customer Contact fieldscan now be added to the main data grid allowing the existing power of the data grid to be leveragedagainst Customer and Customer Contact custom fields.Import Customers and Customer ContactsThe same ease of importing defects, features, tasks, and incidents has now been applied to Customersand Customer Contacts. Now you can import your clients and contacts from your existing contactmanagement applications or use the import feature to update customers and contacts already in theOnTime system. Just like the existing item import, you can save all of your import configuration settingsinto a template to effortlessly import Customers and Customer Contacts.Enhanced Email TemplatesNotifications and alerts have always been an important mainstay of OnTime’s project visibility and teamcollaboration benefits by automatically keeping team members aware of changes to items in thedatabase. This has been greatly enhanced in OnTime 2008 through the use of a number of 100%customizable e-mail templates. Create variable e-mail notifications that can be arranged andspecialized for different actions of the OnTime process. Alert notifications, Customer notifications, andUser notifications can be tailored to include the exact information you need.Item LockingThis new feature allows hundreds of users to work with OnTime simultaneously without fear of losingdata or editing an item currently open by another OnTime user. To make things easier than before,items receive a lock when they are edited and the lock is then released when the item is closed. Otherusers attempting to use the item will be informed that the item is locked. Administrators can also easilyunlock items when needed using the Lock Manager utility.New Custom Field Type - Hyperlink 5
  10. 10. Administrators GuideThis new custom field type allows the creation of new custom fields that contain hyperlinks to web sitesrelated to your defects, features, tasks, incidents, customers, customer contacts, and even projects. Links can be dynamically constructed using fields within the item and can be inserted as URLparameters to easily allow integration with existing web sites. Some examples include linking anincident to a forum post orAlerts on Workflow StepsWith OnTime 2008, alerts can now include triggers based on workflow steps. This allows OnTime tosend out notifications when a workflow step changes the same way alerts works for the rest of yourdata.Customers Can Add Themselves to Notification ListsWhen creating a new item in the OnTime Customer Portal, customers now have the ability to easily addthemselves to the notification list for the created item. Customers can simply check a box at the bottomof the item submission form to stay updated about the status of the item they are submitting.Reschedule FeaturesIn OnTime 2008, changing the scheduling of your features is now easier than ever. The reschedulefeature lets you easily change the dates associated with a feature with a few clicks. For example if aproject is pushed back two weeks, we can use the reschedule feature to bump the due dates for ourfeatures up two weeks.Drag and Drop AttachmentsIn the OnTime 2008 Windows client, attachments can now be easily placed in Defects, Features,Tasks, or Incidents by simply dragging and dropping the file from your desktop.Multi-Edit Fields User OptionWith OnTime 2008, you can now select with fields, including your custom fields, to be included with theMulti-Edit feature. Each user can independently specify which fields are displayed in the multi-edit dropdown menu.The OnTime Product LineThe OnTime 2008 product line consists of: OnTime 2008 for Windows - provides a rich windows application for managing software development efforts. The rich Windows client provides a powerful and fast UI with drag-and-drop capabilities. OnTime 2008 Web Server -allows users to access the OnTime system from anywhere in the world with just a web browser. Supported browsers include Internet Explorer, Netscape, FireFox and Safari. OnTime 2008 for VS.NET - integrates the OnTime system inside the Visual Studio .NET 2005. Software developers never need to leave the VS.NET IDE to access the most commonly used functionality of the OnTime system. OnTime 2008 Customer Portal - provides a brandable customer-facing web site for end-users. Visitors of the Customer Portal can self register to view and report defects and request features.6
  11. 11. OnTime 2008 Overview OnTime 2008 Remote Server -allows remote connectivity to an OnTime database through Web Services even for OnTime Windows and VS.NET clients. Users can connect through firewalls and proxies. OnTime 2008 SDK - provides a set of Web Services APIs for obtaining and modifying defects and features allowing defect reporting and feature request capabilities to be integrated into any existing application.In each of the sections below, well cover these products in more detail.OnTime for WindowsOnTime for Windows runs on any Windows desktop with the .Net Framework V2.0 installed. EachOnTime desktop connects to a database which resides on an MS SQL Server or optionally through theOnTime Remote Server. Access to OnTime is controlled by user accounts. User accounts can beconfigured to prompt for login information each time the program is started or to use WindowsAuthentication to determine the user logging in.The main interface for OnTime for Windows looks like this:The main benefit of the OnTime Windows client is the familiar and rich Desktop application userinterface. However, each user wishing to run the OnTime Windows client needs to install the client onhis or her machine.OnTime Web EditionOnTime Web Server runs on any Microsoft Windows 2000 or 2003 Server with IIS 5.0 or 6.0 and the.NET Framework Runtime V2.0 installed. As the name implies, the OnTime Web Server is a server- 7
  12. 12. Administrators Guideside installation and can be accessed by users with just a web browser. No additional software isneeded on the client-side for using the OnTime Web Server.The main user interface for OnTime Web Server looks like this:The main benefit of the OnTime Web Server is the fact that the system can be accessed from anywherein the world and users dont need any special software to access the system. A web browser such asInternet Explorer or FireFox is sufficient to access the OnTime system through an OnTime Web Serverinstallation.OnTime for VS.NETOnTime for VS.NET is a miniature version of OnTime for Windows. This version of OnTime runs only asan embedded application within the Visual Studio .NET 2005 interface. Like the Windows edition, theVS.NET edition connects from a desktop to a database on an MS SQL Server or optionally through theOnTime Remote Server. When an OnTime user brings up the VS.NET interface, a tools window isembedded inside the VS.NET interface to access the information in the OnTime System.The interface to OnTime for VS.Net looks like this:8
  13. 13. OnTime 2008 OverviewNotice that in the OnTime for VS.NET interface, all of the defects, features, and tasks are shown in onelist. Project items can be differentiated by the icons to the left of the Item ID for each item. Additionalinformation for the items do not show on the home page for the project. In order to see the additionalinformation, the item must be viewed or edited.OnTime Customer PortalThe OnTime Customer Portal allows your clients, customers or end users to work with OnTime bygiving them the ability to easily create, view and edit defects, features and incidents. Administratorscan limit where in the project tree a customer can view items, what actions a customer can perform, aswell as which fields can be viewed or edited.The main Customer Portal Interface looks like this: 9
  14. 14. Administrators GuideWith the Customer Portal, your customers can work with defects, features and incidents. The OnTimeadministrator defines which fields are seen when the customer clicks the item name. This information isshown on a separate web page.OnTime Remote ServerThe OnTime Remote Server allows users of the Windows and VS.NET clients to connect to Ontime insituations and environments whwere connecting directly to the database is not possible. The RemoteServer acts as a gateway between remote users and the OnTime Database by using a secured URLand acting as a web service. For security purposes, a GUID is setep within the Remote server to beused in configuration of remote clients.How database authentication worksIn order to access OnTime data, users must be authenticated to use the OnTime application. Thisauthentication is set up on a per user basis can be done using either Windows IntegratedAuthentication or OnTime Authentication. In addition, OnTime needs to authenticate itself to the SQLserver. This authentication is done using either Windows Integrated Authentication or an SQLAuthentication.The OnTime user to the OnTime authentication is described in the Creating New Users section of theUsers Guide. Here, we will cover the authentication that occurs between the OnTime applications andthe SQL server.OnTime to SQL: Windows Integrated AuthenticationWhen Windows Integrated authentication is used for the OnTime to SQL connections, one Id andpassword will need to be created for each machine which will be making a connection to the SQLserver. Users are not required to provide a user ID and password when a database connection isinitiated. Instead, their Windows ID and password will be used. While this method of authentication iseasier for the users, as it does not require the memorization of a second set of log in information, it ismuch less secure than SQL Authentication.10
  15. 15. OnTime 2008 OverviewUsers of OnTime Web Server and OnTime Customer Portal should not use Windows IntegratedAuthentication, as these sessions are not tied to any single machine.OnTime to SQL: SQL AuthenticationWhen SQLs built in authentication is used for the OnTime to SQL connections, a single user id andpassword is created for all instances of OnTime. Whenever a user connects to a database, they mustknow the specific SQL user id and password for the installation.The SQL user id is required to be either the default SA user which is set up with every SQL installation,or another SQL user with the same level of privileges. Because this user is set up on an SQLinstallation by SQL installation basis, the password and user id are more secure than the WIndowsIntegrated setup.Any user of OnTime can be set to connect to the SQL server using the SQL authentication method.How do the OnTime Products Fit Together?As can be seen from the diagram, the OnTime 2006 products allow users to access the database fromwithin a single network or remotely via the internet.Microsoft SQL Server DatabaseOnTime 2008 uses a SQL server database to store all information. Users access the data in thedatabase by connecting to the SQL server either directly or via the OnTime Remote Server. Althoughmultiple databases can be created using OnTime, most teams find that a single OnTime database issufficient for their needs. Additionally, working with multiple databases can violate your licensingagreement as every OnTime user must be properly licensed. OnTime sets up a non-exclusiveconnection to the SQL server, either directly, or through OnTime Remote Server.OnTime Remote ServerThe OnTime Remote Server allows users of the Windows and VS.NET clients to connect to an OnTimedatabase through a secured URL using Web Services. All users who access the data via the RemoteServer must be provided with a security GUID and the URL for access.OnTime for Windows and OnTime for VS.NetOnTime for Windows and OnTime for VS.Net are the desktop based interfaces to the database. Theyreside within the same network as the SQL server or the Remote server. Users of these two productsaccess the data by authentication with the appropriate server and passing data to, and receiving 11
  16. 16. Administrators Guideupdates from the database via database refreshes. All desktop users of OnTime connect to a singleSQL server, whether it be a direct connection or an indirect connection via an OnTime Remote Server.OnTime Web EditionThe OnTime Web Edition allows OnTime users to access OnTime over the web. This can be great forusers who work remotely or prefer using a web browser. Users can connect to this IIS based webapplication using either port 80 or port 443. Port 443 is the preferred port, as it is the most secure webaccess port available. If desired, the OnTime Web Edition can be set up to use Port 80. Port 80 is notas secure as Port 443.The OnTime Web Edition will then in turn connect directly to the database. Configuration for thedatabase connection is only needed on the server hosting the OnTime Web Edition and not for usersaccessing the OnTime Web Edition through a browser.OnTime Customer PortalOnTime Customer Portal is a way for OnTime users customers to access limited data in the OnTimedatabase. Customer Portal users use a browser based interface to access the database. CustomerPortal users can access data from anywhere there is Internet access.The OnTime administrator sets up what access Customer Portal users will have to the projects anditems within the database. The administrator also controls which Customer Portal users have accessand how they acquire access. Administration for the Customer Portal is done through the OnTimeWindows Client or the OnTime Web Edition.OnTime SDKThe OnTime SDK provides a structured interface for developers to utilize when created newapplications or integrating OnTIme into existing applications. This web service connects directly to thedatabase. Existing or new applciations can then connect to the SDKs web services to perform actionsand retrieve data within OnTime.12
  17. 17. Administrator GuideStartup WizardWhen first logging into the database, you will be presented with the Startup Wizard screen. This screenhelps you to configure your database for the first time. If you do not want to configure your databaseusing the Startup Wizard, simply click Cancel. You can revisit these settings under the Main Tabssection in the System Options screen (Tools --> System Options). 13
  18. 18. Administrators GuideIn Step 1 of the Startup Wizards, enter a password to be using by the built in Admin account.14
  19. 19. Administrator Guide 15
  20. 20. Administrators GuideIn Step 2 of the Startup Wizard, you can determine which of our object types you are planning on usingfor your organization:16
  21. 21. Administrator GuideIn Step 3 of the Startup Wizard, you can select how your items will be named globally: 17
  22. 22. Administrators Guide18
  23. 23. Administrator GuideIn Step 4 of the Startup Wizard, you can decide whether you would like to enable Work Logs. WorkLogs are detailed time entries that can track how much time is being spent on the individual items inyour database.In Step 5 of the Startup Wizard, select the options you would like to use. The startup wizard can createsample items to help get you started as well as create tasks the help you explore OnTime. 19
  24. 24. Administrators GuideNext, Chose if youd like to create basic data to help you get started, including a list of tasks to help youexplore OnTime. Remember, if youd like a large set of data to work with, be sure to enable20
  25. 25. Administrator Guide 21
  26. 26. Administrators GuideStep 6 within the Web Edition startup wizard allows the default width options to be determined to allowOnTime to work with specific browsers.You are ready to get started with your database!22
  27. 27. Administrator Guide 23
  28. 28. Administrators Guide Planning your OnTime Deployment Prior to installing OnTime 2008, you might find it helpful to have answers to the following questions: 1. How many client licenses do I need? 2. Do I need the OnTime Email Service? 3. Do I need the OnTime Customer Portal? 4. Do I need the OnTime Remote Server? 5. Do I need to purchase Microsoft SQL Server 2005 or is SQL Server 2005 Express sufficient? 6. Do I need to purchase Microsoft SQL Server 2000 or is MSDE 2000 sufficient? The following sections will help you determine the answers to these questions. Choosing OnTime Products OnTime 2008 Clients OnTIme 2008 users are licensed based off the 2 types of applications they can use. The users centric to your software development effort (QA Testers, Developers, Project Managers, Support Engineers, etc) can use any of the 3 user applications: the OnTime Windows client, the OnTime Web Edition, or the Visual Studio .NET 2005 plug-in. These three applications are licensed together under a Mixed Mode license which allows 1 licensed user to utilize any of these 3 applications. While users have the option to use any of the three clients, here are some strengths of each individual client type:  OnTime Windows Client - This client is a rich windows application that runs as a local runtime using the .NET 2.0 framework. The rich Windows client provides a powerful and fast UI with drag- and-drop capabilities.  OnTime Web Edition - allows users to access the OnTime system from anywhere in the world with just a web browser. Supported browsers include Internet Explorer and FireFox.  OnTime for VS.NET - integrates the OnTime system inside the Visual Studio .NET 2005. Software developers never need to leave the VS.NET IDE to access the most commonly used functionality of the OnTime system. Alternatively, your customers, end users, or clients would work with OnTime using the OnTime Customer Portal. These customer licenses are separate from the user licenses. OnTime 2008 Express and Professional OnTime 2008 is available in two versions: Express and Professional.Professional OnTime 2008 Professional is the fully featured edition of OnTime, allowing for unlimited workflows, security roles, POP email accounts, and all other OnTime options. The Professional edition is equivalent to feature set of previous editions of OnTime.Express OnTime 2008 Express is the new basic edition of OnTime. OnTime Express includes the core functionality of WIki, Bug Tracking Requirements Managements, Task tracking, and Helpdesk Incident 24
  29. 29. Administrator Guidetracking. OnTime 2008 Express edition allows users to quickly get up and running easily. Please notethe following restrictions: Maximum of 5 Security Roles Maximum of 1 Field Template per item type Maximum of 1 Workflow per item type Maximum of 1 POP Email Account No Ability to Customize Email Templates No Alerts No Ability to use a separate Email Queue service No Remote Server No Custom Report Designer or Custom Reports No Project Dashboard No Access to the main Audit Trails tab No Customer PortalDeciding if you need OnTime Email ServiceThe OnTime 2008 Email Service provides an automatic way of getting customer emails entered intoOnTime as defects, features, tasks, or incidents. Here are some reasons why you would find thisservice useful: You need a way of tracking customer issues to provide better support for your products, and you need to be able to receive incoming emails that automatically get converted into issues. The Email Service can read any POP3 account and add the emails into OnTime as defects, features, tasks, or incidents. In conjunction with OnTimes email conversation feature you can use OnTime as a HelpDesk tool. You want to provide an easy way for you customers to report bugs or give feedback about your products or services, and dont necessarily need a customer-facing web site (Customer Portal). You want to provide a way for your developers and testers to report bugs from anywhere and anytime, without exposing OnTime outside of your domain.Deciding if you need Customer PortalThe OnTime 2008 Customer Portal provides a brandable customer-facing web site for end-users. Visitors of the Customer Portal can self register to view and report defects and request features. Hereare some of the reasons you might find the OnTime Customer Portal a useful addition to your OnTimeinstallation: Your internal sales staff wants a view into the features and defects that are in development and wants to know the status of these items for sales purposes. However, it would be costly to purchase a full OnTime license for each sales staff. OnTime Customer Portals pricing is based on large numbers of users and provides a great alternative to the full OnTime client licenses. 25
  30. 30. Administrators Guide You have many tens, hundreds, thousands or even millions of customers, for whom you would like to provide a means to view the most popular set of defects and feature requests. Furthermore, you might want to allow these customers to report defects and request features. The OnTime Customer Portal provides the perfect mechanism to achieve this goal. You want to provide limited visibility to your OnTime database to a group of users. Access to defects and features can be controlled by project, by filter and even by individual items. You want a large group of users to be able to self-register to access the latest defects and features through an RSS XML feed. The OnTime Customer Portal provides an easy to use self-registration system that can allow users to have access to defects and features through an XML-based RSS (Real Simple Syndication) feed.Deciding if you need the Remote ServerThe OnTime Remote Server allows remote users to connect to an OnTime database through theInternet even when using the OnTime Windows and VS.NET clients. There are other reasons why youmight want to use the OnTime Remote Server. These are the most likely scenarios under which usingan OnTime Remote Server might make sense: Remote OnTime users want to access the OnTime system from the rich Windows or VS.NET client types rather than being restricted to OnTimes Web client. Internal users dont have access to an SMTP server due to firewall or other network security restrictions. In this scenario, OnTime Remore Server would handle the sending of email notifications. Due to security concerns, access to SQL Server is not granted to individual workstations or users. In this scenario, OnTime Remote Server would act as the gateway to the OnTime database.Microsoft SQL Server 2005 or SQL Express EditionOnTime can also store its information in a database on Microsoft SQL Server 2005 or Microsoft SQLServer 2005 Express. Microsofts SQL Express Edition is essentially a free version of SQL Server 2005,however to determine whether you need Microsoft SQL Server 2005 or the freely available ExpressEdition database, consider the following similarities and differences between them: The Express database engine does not ship with any administrative tools, although Microsoft provides the SQL Server Management Studio Express for free download. Support for only 1 CPU The Express database size is limited to a maximum of 4GB. The Express service is limited to 1GB of memory for queries and data pages (this does not include total application footprint). The Express database engine does not support many of the salability and reliability features of the Microsoft SQL Server 2005, such as replication and clustering.For more detailed information see the SQL Server 2005 Features Comparison article: http://www.microsoft.com/sql/prodinfo/features/compare-features.mspxObtaining Microsoft SQL Server 2005 Express EditionTo download and install the free SQL Server 2005 Express Edition, visit the following link:26
  31. 31. Administrator Guide http://msdn2.microsoft.com/en-us/express/bb410792.aspxOnce on that page, scroll down and find the link to download the SQLEXPR.EXE fileInstalling Microsoft SQL Server 2005 Express EditionAfter you finish downloading the SQLEXPR.EXE file, simply run this file and the SQL Server Expresswill be installed.If you already have another SQL Server installed and running on your computer (SQL 2000 or MSDE2000), the SQL Server 2005 Express will install as an instance (i.e. not the default server). This meansthat you may need to use ".SQLEXPRESS" or ".SQL2005" as the server name when connecting to itthrough OnTime (instead of using "(local)" or the machine name).Microsoft SQL Server 2000 or MSDE 2000OnTime 2008 stores all of its information inside a database using either Microsoft SQL Server 2000 orMSDE 2000. Microsofts MSDE 2000 is essentially a free version of SQL Server 2000, however todetermine whether you need Microsoft SQL Server 2000 or the freely available MSDE 2000 database,consider the following similarities and differences between the full SQL Server 2000 product and MSDE2000: The MSDE 2000 database engine has a Workload Governor which limits the performance of the database system when more than 8 concurrent requests are made to the database. Notice that this is not the same as 8 users. Its possible to have hundreds of users in OnTime and never have 8 concurrent requests to SQL Server - however, the likelihood of running into this limitation increases as the number of OnTime users increase. The MSDE 2000 database engine does not ship with any administrative tools. Although OnTime 2008 provides simple backup and restore capabilities for your databases, user management, additional security and other database administrative tasks are not supported by the MSDE 2000 product. The MSDE 2000 database size is limited to a maximum of 2GB. The MSDE 2000 database engine does not support many of the scalability and reliability features of the Microsoft SQL Server 2000, such as replication and clustering. The MSDE 2000 is being phased out, with SQL Server 2005 Express taking its place.Obtaining MSDE 2000To download and install the Free MSDE 2000 database engine from Microsoft, visit the following link: http://www.microsoft.com/sql/prodinfo/previousversions/msde/download.mspxInstalling MSDE 2000After you finish downloading the MSDE 2000 file from the above link, follow these steps to install MSDE2000: 1. Unpack the MSDE 2000 files by running the MSDE2000A.exe” file that you downloaded from the link above 2. When prompted for a location to unpack the files, leave the default “C:MSDERelA” if you have enough disk space (about 250MB) 3. After the unpacking finishes, open a Command Prompt (Start Menu->Run->Type “CMD”) 27
  32. 32. Administrators Guide 4. In the command prompt, switch to the “C:MSDERelA” directory 5. Now type the following command setup.exe SAPWD=somepassword SECURITYMODE=SQL DISABLENETWORKPROTOCOLS=0This command will setup the Microsoft SQL Server Desktop Edition (MSDE 2000) on your machine.Important Note: If the setup fails due to the presence of another instance of MSDE 2000, and you don’twant to use the same instance of MSDE for OnTime, you can name this new instance by using thefollowing command for installation:setup.exe SAPWD=somepassword INSTANCENAME=OnTimeDBServer SECURITYMODE=SQLDISABLENETWORKPROTOCOLS=0OnTime InstallationInstallation of the OnTime product line takes only a few minutes. The process mostly consists of runningthrough a simple wizard driven interface for the product(s) that interests your organization.Installation requirementsOnTime 2008 WindowsSystem Requirements: Windows 2000/XP/2003/Vista .NET Framework V2.0 SQL Server 2000/2005, MSDE 2000, or SQL 2005 ExpressOnTime 2008 Web ServerSystem Requirements: Windows 2000/2003 Server, Vista, or Windows XP (not recommended for production) .NET Framework V2.0 IIS V5 or V6 SQL Server 2000/2005, MSDE 2000, or SQL 2005 Express Client: Most Web Browsers (Internet Explorer 7+, FireFox 1.5+) Client: Acrobat Reader 5.0 or higher (for viewing reports)OnTime 2008 VS.NetSystem Requirements:28
  33. 33. Administrator Guide Windows 2000/XP/2003/Vista Visual Studio.NET 2005 SQL Server 2000/2005, MSDE 2000, or SQL 2005 ExpressOnTime 2008 Email ServiceSystem Requirements: Windows 2000/XP/2003/Vista .NET Framework V2.0 SQL Server 2000/2005, MSDE 2000, or SQL 2005 Express Any one of OnTime 2005 for Windows or Web or VS.NETOnTime 2008 Customer Portal ServerSystem Requirements: Windows 2000/2003 Server, Vista, or Windows XP (not recommended for production) .NET Framework V2.0 IIS V5 or V6 SQL Server 2000/2005, MSDE 2000, or SQL 2005 Express Any one of OnTime 2008 for Windows or Web or VS.NET Client: Most Web Browsers (Internet Explorer 6 or 7, FireFox)OnTime 2008 Remote ServerSystem Requirements: Windows 2000/2003 Server, Vista, or Windows XP (not recommended for production) .NET Framework V2.0 IIS V5 or V6 SQL Server 2000/2005, MSDE 2000, or SQL 2005 Express Client: Any one of OnTime 2008 for Windows or Web or VS.NETOnTime for Windows Installation ProcessUpon double clicking the "OnTime2008WindowsSetup.exe" file, the welcome screen will appear: 29
  34. 34. Administrators GuideClick Next and the license agreement screen will appear:30
  35. 35. Administrator GuideOn the next screen, chose whether OnTime will be installed for all users or just the user installing.Once the I Agree radio button is selected, the Next button will become active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation. 31
  36. 36. Administrators GuideThe next step is to define where the Windows client will be installed. If the default folder is not correct,use the Browse button to navigate to desired folder. At this point, it is also a good idea to verify thatenough disk space is available to install and run OnTime. When ready, click Install to start theinstallation. The installation will begin and screens containing installation status bars will appear.If a previous version of OnTime is detected, the following popup will appear, allowing the older versionto be uninstalled.When the installation has completed, the screen will appear:32
  37. 37. Administrator GuideUse the Finish button to end the installation. Once this is done, the installation is complete. (It isrecommended to use Windows Update to ensure that the current computer has the most recentupdates to the .Net Framework.) The next step is to configure, create, and activate the OnTimedatabase. For information on this process see the Connecting to OnTime 2008 for Windows section ofthe User Guide.OnTime Web Server Installation ProcessUpon double clicking the "OnTime2008WebSetup.exe" file, the welcome screen will appear: 33
  38. 38. Administrators GuideClick Next and the license agreement screen will appear:34
  39. 39. Administrator GuideOn the next screen, chose whether OnTime will be installed for all users or just the user installing.Once the I Agree radio button is selected, the Next button will be come active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation. 35
  40. 40. Administrators GuideThe next step is to define where the Web files will be installed. If the default folder is not correct, use theBrowse button to navigate to desired folder. At this point, it is also a good idea to verify that enoughdisk space is available. When ready, click Next to move to the Virtual Directory Selection screen.36
  41. 41. Administrator GuideOn the next screen, chose to have OnTime Setup create the needed virtual directory within IIS or toonly install the OnTime files. If only the files are installed, OnTIme 2008 Web Edition will need to bedeployed manually within IIS.If the option to set up the virtual directory is checked, the next step is to create a virtual directory for theinstallation. This directory will hold the information required to run OnTime 2008 Web. Keep the defaultdirectory name or provide an alternate. You can also choose a different web site to install OnTime to, ifyou have multiple web sites on your server.Click Install to start the installation. The installation will begin and screens containing installation statusbars will appear. When the installation has completed, this screen will appear: 37
  42. 42. Administrators GuideUse the Finish button to end the installation. It is recommended to use Windows Update to ensure thatthe current computer has the most recent updates to the .Net Framework. Once this is done, theinstallation is complete. The next step is to configure, create, and activate the OnTime database. Forinformation on this process see the Connecting to OnTime 2008 Web Server section of the User Guide.OnTime for VS.Net Installation ProcessUpon double clicking the "OnTime2008VSNetSetup.exe" file, the welcome screen will appear:38
  43. 43. Administrator GuideClick Next and the license agreement screen will appear: 39
  44. 44. Administrators GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation.On the next screen, chose whether OnTime will be installed for all users or just the user installing.40
  45. 45. Administrator GuideThe next step is to define where the VS.Net client will be installed. If the default folder is not correct, usethe Browse button to navigate to desired folder. At this point, it is also a good idea to verify that enoughdisk space is available to install and run OnTime. When ready, click Install to start the installation. Theinstallation will begin and screens containing installation status bars will appear. When the installationhas completed, the screen will appear: 41
  46. 46. Administrators GuideUse the Finish button to end the installation. As recommended on the screen, use Windows Update toensure that the current computer has the most recent updates to the .Net Framework. Once this isdone, the installation is complete. The next step is to configure, create, and activate the OnTimedatabase. For information on this process see the Connecting to OnTime 2008 for VS.Net section of theUser Guide.OnTime Email Service Installation ProcessUpon double clicking the "OnTime2008ServiceSetup.exe" file, the welcome screen will appear:42
  47. 47. Administrator GuideClick Next and the license agreement screen will appear: 43
  48. 48. Administrators GuideOnce the I Agree radio button is selected, the Next button will become active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation.44
  49. 49. Administrator GuideThe next step is to define where the E-mail Services will be installed. If the default folder is not correct,use the Browse button to navigate to desired folder. At this point, it is also a good idea to verify thatenough disk space is available to install and run OnTime. When ready, click Install to start theinstallation. The installation will begin and screens containing installation status bars will appear. Whenthe installation has completed, the screen will appear:Use the Finish button to end the installation. As recommended on the screen, use Windows Update toensure that the current computer has the most recent updates to the .Net Framework. Once this isdone, the installation is complete. The next step is to configure, create, and activate the OnTimedatabase. For information on this process see the Connecting to OnTime 2008 for Windows section ofthe User Guide.OnTime Customer Portal Installation ProcessUpon double clicking the "OnTimeCustomerPortalSetup.exe" file, the welcome screen will appear: 45
  50. 50. Administrators GuideClick Next and the license agreement screen will appear:46
  51. 51. Administrator GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation. 47
  52. 52. Administrators GuideThe next step is to define where the Customer Portal files will be installed. If the default folder is notcorrect, use the Browse button to navigate to desired folder. At this point, it is also a good idea to verifythat enough disk space is available. When ready, click Next to move to the Virtual Directory Selectionscreen.On the next screen, chose to have OnTime Setup create the needed virtual directory within IIS or toonly install the OnTime files. If only the files are installed, OnTIme 2008 Web Edition will need to bedeployed manually within IIS.48
  53. 53. Administrator GuideThe next step is to create a virtual directory for the installation. This directory will hold the informationrequired to run OnTime 2008 Customer Portal. Keep the default directory name or provide an alternate.You can also choose a different web site to install OnTime to, if you have multiple web sites on yourserver.Click Install to start the installation. The installation will begin and screens containing installation statusbars will appear. When the installation has completed, this screen will appear: 49
  54. 54. Administrators GuideUse the Finish button to end the installation.Once the OnTime 2008 Customer Portal site has been installed, youre ready to configure the site foryour customers. Go to the Setting up OnTime 2008 Customer Portal section in the AdministratorsGuide for details.OnTime Remote Server Installation ProcessUpon double clicking the "OnTime2008RemoteServerSetup.exe" file, the welcome screen will appear:50
  55. 55. Administrator GuideClick Next and the license agreement screen will appear: 51
  56. 56. Administrators GuideOnce the I Agree radio button is selected, the Next button will be come active. If for some reason thelicense agreement can not be accepted, then click Cancel to abort the installation.On the next screen, chose whether OnTime will be installed for all users or just the user installing.52
  57. 57. Administrator GuideThe next step is to define where the Remote Server files will be installed. If the default folder is notcorrect, use the Browse button to navigate to the desired folder. At this point, it is also a good idea toverify that enough disk space is available. When ready, click Next to move to the Virtual DirectorySelection screen. 53
  58. 58. Administrators GuideOn the next screen, chose to have OnTime Setup create the needed virtual directory within IIS or toonly install the OnTime files. If only the files are installed, OnTIme 2008 Web Edition will need to bedeployed manually within IIS.54
  59. 59. Administrator GuideThe next step is to create a virtual directory for the installation. This directory will hold the informationrequired to run OnTime 2008 Remote Server. Keep the default directory name or provide an alternate.You can also choose a different web site to install OnTime to, if you have multiple web sites on yourserver. Although OnTime Remote Server can communicate over any non-secured port, it is highlyrecommended that a secured SSL port (such as port 443) is used when OnTime 2008 Remote Serveris rolled into production.Click Install to start the installation. The installation will begin and screens containing installation statusbars will appear. When the installation has completed, the screen will appear:Use the Finish button to end the installation. As recommended on the screen, use Windows Update toensure that the current computer has the most recent updates to the .Net Framework. Once this isdone, the installation is complete. The next step is to configure, create, and activate the OnTimedatabase. For information on this process see the Setting up an OnTime 2008 Remote Server sectionof the Administrators Guide.Setting up OnTime 2008After you have installed OnTime and before any user can connect to an OnTime system, an OnTimedatabase must be created using the OnTime Database Setup tool. To start the OnTime DatabaseSetup tool, follow the instructions for the appropriate OnTime product: From OnTime for Windows Client The first time that the OnTime for Windows client is started, the OnTime Database Setup window appears. Alternatively, the OnTime Database Setup window can be accessed from the OnTime Windows client by going to Tools --> Manage Database or selecting the Manage Database icon on the toolbar. 55
  60. 60. Administrators Guide From the OnTime for VS.NET Client The first time that Visual Studio.NET is started after installing the OnTime for VS.NET client, the OnTime Database Setup window appears. Tthe OnTime Database Setup window can be accessed from the OnTime NS.NET plugin by selecting the Manage Database icon on the toolbar. From OnTime Web Server, Customer Portal and Remote Server If the web client is going to be used, you must first run the OnTime 2008 Web Configuration tool. From the Start Menu, select:  OnTime Web: All Programs --> Axosoft --> OnTime 2008 --> OnTime Web Configuration --> OnTime 2008 Web Configuration.  OnTime Customer Portal: All Programs --> Axosoft --> OnTime 2008 --> Customer Portal Configuration --> OnTime 2008 Customer Portal Configuration  OnTime Remote Server: All Programs Axosoft --> OnTime 2008 --> OnTime Remote Server Configuration --> OnTime 2008 Remote Server Configuration The OnTime Configuration window will appear: If youve installed OnTime 2008 in the default location, simply click the Load Settings button. The settings file will load and the Manage OnTime Database button will become enabled. Click it to bring up the OnTime Database Setup Window.OnTime Database Setup WindowThe OnTime Database Setup window is used to create a new database, establish a connection to anexisting database, or to initiate the conversion of an existing database created by a previous version ofOnTime:56
  61. 61. Administrator GuideOnTime 2008 requires a connection to an existing installation of Microsoft SQL Server to either create anew database or connect to an existing database. From the OnTime Database Setup window, performthese actions: 1. Complete the server name field to point OnTime to an existing Microsoft SQL Server. 2. Select the authentication type between OnTime and SQL Server 2000. This information is usually obtained from your SQL Server administrator. If you are unsure of what to do at this point, 3. Select the radio button to Create a New Database. 4. Provide a database name (any database name that does not already exist will work) 5. Select the default language for your database. The language you choose here will populate some of the system fields (Priority, Severity, etc.) with default strings of the language you select. 57
  62. 62. Administrators Guide 6. Optionally, choose to populate the new database with Sample Data. If you are simply evaluating OnTime, choosing to populate the new database with sample data will provide you with a large array of data that you can use to browse the OnTime system. 7. Click on the "Create Database" button to create your database.OnTime will proceed to create a new database and will provide an indicator of where in the databasecreation process is at. Once an OnTime database has been created, it must then be activated.Note: This process only needs to be done once. All other OnTime clients can choose to open anexisting database and point the system to this newly created database.How OnTime and SQL Server CommunicateIts important to understand how OnTime communicates with SQL Server. Every application thatdirectly accesses a Microsoft SQL Database must first establish a connection with SQL Server in one oftwo modes: Windows Integrated Authentication - Allows Windows login information to be passed to SQL Server for authentication and authorization. This authentication mode requires all users of the OnTime system to have direct access to Microsoft SQL Server using their Active Directory (Windows) account. Because OnTime Web Server runs as the "ASPNET" user by default and because the ASPNET user does not have access to SQL Server by default, it is not recommended that this access method is used with OnTime Web Server. However, in environments where each user is also a SQL Server user, it might make sense to use Windows Integrated Authentication for the communication between OnTime and SQL Server. SQL Server Authentication - allows a login id and password that’s unique to SQL Server (such as the “sa” user). This authentication mode is typically preferred for an OnTime Web Server installation. Often times a unique OnTime User is created in SQL Server with "db_Owner" privileges on the OnTime database to restrict this user to just the OnTime database.Note: When using “SQL Server Authentication” OnTime stores the login id and password in anencrypted string inside the XML configuration file (OnTime.config).Note: Even if you select "SQL Server Authentication" for the communication between OnTime andMicrosoft SQL Server, your OnTime users can still connect to OnTime using Windows IntegratedAuthentication. Authentication to OnTime is completely independent of authentication for SQL Server.Activating an OnTime DatabaseEach OnTime Database needs to be activated before it can be used. By default, OnTime 2008 installswith a 30-Day Trial key which is pre-activated and cannot be reactivated. This 10 user trial key can betoggled between the Professional and Express versions by going to Help --> Convert Activation Key toProfessional Version. You can obtain a free single-user activation key from Axosoft or you will receivea full activation key when you purchase any of the OnTime products.If you are running the OnTime Windows or VS.NET clients, the database activation window comes upautomatically if you have not yet activated the database with a full activation key. You can also bring upthe activation window from inside the application from the Help --> Enter Activation Key menu.If you are running the OnTime Web Server, you need to run the OnTime 2008 Web Configuration utilityand click the Activate OnTime Database button. To run the tool, from the Start Menu select AllPrograms --> Axosoft --> OnTime 2008 Web Edition --> OnTime 2008 Web Configuration.Note: This process only needs to be done once for an OnTime database, not individually for each clienttype (Windows, Web, VS.NET Plugin)The OnTime Database Activation window looks like this:58
  63. 63. Administrator GuideIn the Activation Key field, enter the activation key that was obtained from Axosoft. When the key isentered, select “Activate over Internet” and then click the Activate Database button. If licensing issuespertaining to the differences between OnTime Express Edition and OnTime Professional Edition arefound, please see the Converting Databases Between Pro and Express Licenses section. Afercompliting, the database will be activated. If a trial version is being used, no additional key informationwill be needed. Simply click “Continue Trial” to evaluate OnTime 2008. Click the close button tocontinue. After the database has been activated, use of the database can be continued as defined inthe Users Guide.Activating an OnTime Database Through a Proxy ServerIf you normally use a proxy server to browse the Internet, you will likely need to provide the proxyinformation to the OnTime 2008 Smart Activation window. To obtain your proxy information, see yournetwork administrator. Once you have obtained your proxy information, click on the "Change Settings"link, then click the "Proxy Settings" link to enter the proxy information. You should then be ready toactivate the OnTime database over the Internet. 59
  64. 64. Administrators GuideActivating an OnTime Database ManuallyIf you have difficulty activating your OnTime database, contact Axosoft Support to obtain an activationconfirmation XML. Clicking the Request Activation Confirmation XML link button will open up an e-mailmessage that you can send to Axosoft to request the XML. Once you have been provided theappropriate activation confirmation XML, click the Change Settings link and choose the "ActivateManually" radio option and click on the "Activate Database".60
  65. 65. Administrator Guide OnTime will then ask for the information you were provided by Axosoft staff. Provide this information in the new window. Converting Between Professional and Express The introduction of OnTime 2008 also introduces two versions of OnTime. Just like previous editions of OnTime, OnTime2008 Professional allows unlimited creation of field templates, workflows, email accounts to be checked, or any other OnTime feature. The Express version is targeted for developers that only need one view for each item type as well as one workflow for each item type. For a full description of the differences between OnTime 2008 Professional and Express, please see the Chosing OnTime Client Products section. Converting Trial Databases When you install OnTime 2008, a trial key is automatically created. On install, the default trial key is created as a Professional key but can easily be converted over to an Express key should you wish to evaluate the Express version of OnTime.Professional to Express This key can be converted back and forth between Professional and Express keys by selecting the Help --> Convert Activation Key to Express Version. 61
  66. 66. Administrators Guide OnTime Windows OnTime Web EditionA confirmation dialog will appear to let you know about the action you are getting ready to perform. When converting from a Professional to Express database, any limitations that will be violated will needto be fixed before OnTime can be loaded. For example, if you have 2 field templates for defects andconvert your Profefssional database to Express, you will need to remove one of these field templates. This can be done before converting your database or, when loading OnTime, if the conditions forExpress are violated, a window will pop up allowing you to correct these issues or covert back toProfessional.62
  67. 67. Administrator GuideAfter clicking OK on the Convert Trial key dialog, the OnTime Windows will restart or OnTime WebEdition will bring you to the login prompt. In OnTime Windows, click the Continue Trial button on theactivation screen and login with your credentials. In OnTime Web Edtion, you will be brought directly tothe login page. If the database violates any of the restrictions of OnTime Express, the followingwindow will appear. OnTime Windows 63
  68. 68. Administrators Guide OnTime Web Edition Items marked with a red X will need to be corrected before loading OnTime. Clicking Fix from the menu will open up the appropriate management window for the item to be corrected. Remove the unneeded items and click OK. Once all items are corrected and marked with a green check mark, the Continue Trial button will become active and we can now load up OnTime 2008 Express. If you would like to cancel this process and return the trial database to Professional, in the Windows Client click the "Convert Key to Pro link and in the Web Edition, select Help --> Convert Activation Key to Professional Version.Express to Professional Since converting from Express edition to Professional edition cannot cause any licensing issues, from the menu simply select Help --> Convert Activation Key to Professional Version. In OnTime Windows, the application will be restarted and in OnTime Web Edition, you will be returned to the login prompt. The OnTime Database has now been converted to the Professional Edition. Be sure to have all your users log out as well. Licensing Issues upon Key Activation 64
  69. 69. Administrator GuideLogging Into OnTime for the First TimeDuring the database creation process, OnTime creates a built-in user with the following logininformation: Login ID: Admin Password: [BLANK]Note: The built-in Admin account does not have a password. After logging in as the Admin user, youshould change the Admin accounts password to ensure proper security to your OnTime database.Changing the Admin Users PasswordTo change the built-in Admin users password, once youve logged into OnTime as Admin select theTools --> User Options menu item. You will be taken to the User Options window. Click the ChangePassword button in Windows, or the Change Password link in Web. (See the User Options andSettings section in the Users Guide for more information)Leave the Old Password blank and type in a new password and confirmation and save the changes.Configuring System OptionsThe System Options stores certain global settings that let you customize some aspects of the OnTimeapplication. These options can be configured by going to Tools --> System Options. 65
  70. 70. Administrators GuideGeneral SettingsThe General Settings section allows global options to be specified. Allow workflow steps and alerts to run processes - When defining workflow steps or alerts, you have the option of having the workflow step run an external process. This can pose a security concern since the external process will be run on the computer where a user changes the workflow step through OnTime. The Allow workflow steps to run processes checkbox lets you enable or disable the running of these external processes. Allow users to create picklists based on stored procedures - Allows users to create pick lists based on stored procedures created in the database. As this is a low level action performed against the database and can pose a security risk, this option is disabled by default. Enabling this option allows a SQL stored procedure to be used to return fields used to populate a picklist. This can be used to create custom, dynamic picklists or to populate a picklist with information stored elsewhere in the database. Allow users to manually enter email addresses in the From address when sending emails - When using OnTime to send out new emails or replies to incoming emails tied to defects, features, tasks or incidents, the From email address should usually be one of the accounts being polled and set up in the OnTime Email Service. However, there are times when users may want to send out emails with a different From address. If you wish to allow users to be able to type in any arbitrary email address as the From address, check the Allow users to manually enter email addresses in the From address when sending emails checkbox.66
  71. 71. Administrator Guide Include the current users email address in the list of from emails when sending emails - Another option is to have OnTime automatically add the current users email address in the drop down of addresses along with the accounts from the OnTime Email Service. Check the Include the current users email address in the list of From emails when sending emails checkbox to enable this option. Hide Complete Task check boxes on the list of tasks - The main tasks list on the Tasks tab will include a checkbox, by default, to allow users to quickly set tasks as completed. You may remove these checkboxes from the list for all users by checking the Hide Complete Task check boxes on the list of tasks checkbox. Show Database Information on Main Window - This options appends the name of the currently used database to the OnTime 2008 title bar. Copy worklogs when copying items across item types - When copying an across items types, normally the worklog data is not copies due to the fact that this would create duplicate worklog entries for work that in reality was only performed once. To have the worklogs copied, check this options. Keep in mind, when moving an item across item types, worklog information is preserved in the newly created item. Built-In Reports Font - changes the font for all of the reports that ship with OnTime2008 HTML Editor [Enter] key behavior - Allows altering the behavior of the Enter key when using the HTML editor within Large Text fields (ie Description, Notes, Resolution fields) or Wiki pages. Use Shift-Enter to insert the default break.Main TabsThe Main Tabs section allows selection of which tabs will be visible. These selections are global andremove or add the tab for all users of the OnTime system. If you only need to restrict access to a tabfor a specific set of users, create an appropriate security role. 67
  72. 72. Administrators GuideItem TypesThe item types settings allow you to customize the labels of the item types (e.g. change the label Defectto Bug). This will change the labels everywhere in the application.68
  73. 73. Administrator GuideTo modify the labels, simply edit the current labels. Make sure that if you change an item types labelyou modify both the singular and plural labels.Field LabelsThe field labels settings allows you to customize the names, or labels, of the fields for defects, features,tasks, and incidents. These are the labels that are displayed on the add/edit window and the columnsin the defect, feature, task, and incident lists. 69
  74. 74. Administrators GuideTo modify the labels, in Windows simply double-click the label in the Display Label column to edit it, orin Web click the edit icon in the Actions column.Details Tab SettingsIn OnTime, the main window displays a set of tab which contain details for the selected item. Thedetails tab settings allow you to select which details tabs to display on the main window for projects,defect, features, tasks, and incidents.70
  75. 75. Administrator GuideSimply un-check the detail tabs that you wish to hide from the user interface.Item Details SettingsThe Item Details Settings section allows options pertaining to how item information is stored anddisplayed for an item. All setting within this section are global and will affect all users. Store Detail Fields as HTML - changes the storage and edit behavior for Detail Fields (ie: Description, Notes, Resolution). Storing details fields as HTML allows the usage of the rich text editor to change fonts, create tables, use bullets, and other basic text options. This also stores the detail field using HTML. Alternatively, unchecking this option will remove the rich text controls from the detail fields and store the data as flat text. Note: Changing this setting will cause irrevocably change all details fields by removing all formatting. Stamp Detail Fields at Top/Bottom - Changes the location of the text inserted when hitting the Stamp button within a detail field. Setting this to the top will insert the stamp above the current text to create entries in descending order chronologically. Alternatively, setting this option to the bottom will insert the stamp below any currently entered text to create entries in an ascending order chronologically. Force Customer Search Control - Checking this option will override the User Option for the display of customer contacts within the Customer Portal tab of defects and features. The search control will always be used instead of the dropdown control. 71
  76. 76. Administrators GuideAttachmentsThe attachments options allow the administrator to limit how attachments can be stored. Store in DB Only - file attachments are stored directly into the database and any user with access can view or download the file Store Path Reference Only - instead of storing the file directly in the OnTime database, a link in the form of a UNC path (serversharemyfile.txt) is stored. Store Either DB or Path Reference - allows attachments to be stored using either methodUser Lists SettingsThe user lists settings allows you to customize which users are listed in user dropdown fields likeAssigned To and Reported By for defects, features, and tasks.72
  77. 77. Administrator Guide List users by project access - This checkbox allows you to filter the list of users so that only users who have access to the selected project are displayed. If the checkbox is not checked, all users in the system are displayed. If the checkbox is checked, only those users who are in a security role with permission to the selected project are listed. Include inactive users in user lists when adding Defects, Features, Tasks, or Incidents - this checkbox allows you to filter out inactive users when adding new items. If the checkbox is checked, inactive users will be displayed in the lists. If the checkbox is unchecked inactive users will not be displayed.Incident SettingsThe Incident Settings allow the incident ID numbers to be configured. Each Incident number will becomposed of the Incident number prefix and the next number, which can be padded with zeros. 73
  78. 78. Administrators Guide Incident Number Prefix - allows the beginning of the incident to be specified. This leading alphanumeric string will be joined with the incident number and any zeros used for padding. Next Number is - specified the number to be used for creation of a new incident. This number will automatically increment when a new incident is created Format number to fixed width - This option forces the incident number to be created using a preset number of characters. Zeros will be added to the incident number to retain the desired length Number of digits in Incident Number - This option is enabled when the format number to fixed with option is selected. The digit length can be specified. For example, if our next incident number is 92 and we have 5 digits in the incident number, our padded number would 00092.MIME Types (Web Edition Only)The MIME types section allows the file types for attachments to be specified. The default MIME typesgenerally work well in most environments. If you need to add, remove, or change a MIME type, simpleuse the appropriate toolbar button. Adding and editing require that the File Extension and the contenttype to be entered or modified. To delete a MIME type, simply select the desired entry and click thedelete button on the toolbar.74
  79. 79. Administrator GuideLockingOnTime 2008 supports large amounts of concurrent users. To help prevent any item or data loss thatmight come from multiple users working on the same item, items are locked when a user opens it, thenthe lock is released when the item is closed or saved, or the lock will eventually time out. The lockingsection of the system options allows us to specify options pertaining to the locking system. 75

×