 |
 |
|
||||
|
|
|
 |
WORLDOX® 96 Billing Frequently Asked Questions and Fast TrackWORLDOX Billing FAQRev 2.0 / Dec 26, 2001
Content1. About This FAQ 1. About This FAQ. 
This Frequently Asked Questions document, or FAQ, presents questions often asked about the WORLDOX Billing feature. It does not provide an overview to WORLDOX® Enterprise Document Manager® software. This FAQ is maintained by World Software Corporation, support@worldox.com. You can find the latest copy at the official WORLDOX web site: www.worldox.com. 2. What is the WORLDOX Billing Fast
Track? The WORLDOX Billing Fast Track is an eight-step quick start guide that takes you through the process of setting up WORLDOX Billing, editing a document, generating a billing statistics report, and outputting the information to a printer and to a text file. You can find the WORLDOX Billing Fast Track appended to the end of this FAQ. We recommend that you review this FAQ then work through the Fast Track. After completing the Fast Track, refer to this FAQ to custom-configure WORLDOX Billing to your specific requirements. The Billing feature in WORLDOX can track editing, or work, time spent and the number of pages printed for documents edited in Corel® WordPerfect® 8. WORLDOX Billing is inactive by default so in order to use it, you must activate it by adding a line to the WORLDOX.INI file and setting up a Billing database with the WORLDOX Administration program (WDADMIN.EXE) same as in Archiving FAQ. 4. What version of WORLDOX do I need? You must have a version of WORLDOX 96 dated on or after January 1, 1998 to use Billing. To find the release date of your copy of WORLDOX, open the Help menu and choose About. The About dialog displays the version of WORLDOX and its release date in the upper right hand corner. 5. What can I track with WORLDOX Billing? WORLDOX Billing tracks two things: time spent working on documents in WordPerfect and the number of pages printed for a document in WordPerfect. 6. Is WordPerfect the only program that
works with Billing? Yes, WORLDOX Billing will only record and report on work statistics for documents edited with Corel WordPerfect. 7. Under what conditions are document billing
statistics tracked? You must be editing a document in WordPerfect with WORLDOX billing enabled, and WORLDOX running. In order for the timer to record editing time, the WordPerfect application window needs to maintain focus (that is, WordPerfect must be the active window). 8. How do I activate WORLDOX Billing? WORLDOX Billing is inactive by default. Therefore, you must activate it, or "turn it on" before you can use it. To activate WORLDOX Billing you must edit the WORLDOX.INI file and Set up the Billing database in the WORLDOX Administration program. 9. How do I edit WORLDOX.INI and what edits
must I make to it to activate WORLDOX Billing? WORLDOX.INI is a text file that contains a number of settings used by the WORLDOX system. The file resides in the WORLDOX program Folder on the drive to which WORLDOX was installed. Typically this will be on your network server or a shared drive somewhere on the network. On a stand-alone PC this is probably C:\WORLDOX (or the directory to which you installed WORLDOX, if different). 1. First, make sure to exit WORLDOX. 2. To load WORLDOX.INI in Notepad (the standard Windows text editor),
open the Windows Run dialog and type NOTEPAD followed by the full
path to the WORLDOX.INI file. For example, for a typical network
installation you would type: 3. Find the [Startup] section in WORLDOX.INI 4. Create a new line beneath [Startup] and enter the following:
5. Save WORLDOX.INI and exit Notepad. 10. What is the document tracking window? The WORLDOX document tracking window displays the name of any documents for which billing statistics have been tracked that have been edited in your current WORLDOX session. We recommend that you use the document tracking window to test that Billing is enabled, but remove the window for normal use. The document tracking window shows the maximum idle time and the minimum work time. The body of the window shows an entry for each document being tracked for billing statistic collection in the current WORLDOX session. The window shows:
You can view active documents or posted documents. A document is considered active if it is currently being tracked for billing statistics. Active documents have pending statistics that have not yet been written to the Billing database. A posted document has had its billing statistics saved to the Billing database. You can check Auto-Refresh to continuously update the timer display or leave it unchecked and click the Refresh button when you want to see the elapsed edit time. 11. How do I display the document tracking
window? WORLDOX Billing offers an additional switch that you can use if you want confirmation that Billing is enabled. The confirmation, or verbose, mode displays a document tracking window when you start WORLDOX (subsequent to setting it up for billing). To display the document tracking window, use the following line in the [Startup] section of WORLDOX.INI: WD96PARAMS=/BV You must exit and restart WORLDOX before this change will take effect. With this line in WORLDOX.INI, WORLDOX displays the document tracking window at startup. You can close the window if you do not wish to view it without affecting the collection of statistics. 12. How do I remove the document tracking
window? If you no longer wish to have the document tracking window displayed each time WORLDOX starts, edit WORLDOX.INI file. Change the line WD96PARAMS=/BV in the [Startup] section to WD96PARAMS=/B. Save WORLDOX.INI and restart WORLDOX. 13. What is Maximum Idle Time? WORLDOX Billing times how long you work on a document within WordPerfect. There are times, however, when you may wish to stop timing. Idle time is the length of time, in seconds, during which no keys are pressed, that WORLDOX waits before stopping the timer temporarily. Timing begins again as soon as a key is pressed within WordPerfect. It works similar to how a screen saver works, but in reverse. For example, suppose the maximum idle time is set to 60 seconds. The moment an existing document is opened (with WORLDOX), or a new document is created in the WordPerfect editing window, the timer begins. Let's say that an operator has been working on a document for ten minutes, at which time the telephone rings. The operator stops typing in order to answer the telephone. At this point WORLDOX Billing has recorded ten minutes. As the operator speaks, the timer continues. If the operator begins typing within 60 seconds (the maximum idle time), then timing will go on without interruption. If, however, the operator does not touch the keyboard for sixty seconds, WORLDOX Billing will pause the timer at 11 minutes (10 minutes plus 60 seconds of idle time). When the operator begins working again on the document in WordPerfect the timer will begin again, starting at 11 minutes. Idle time is set by the WD96PARAMS value in WORLDOX.INI. The default value for maximum idle time is 10 seconds. For example, WD96PARAMS=/B /BMaxIdle=30. 14. What is Minimum Work Time? Sometimes it is necessary to use a document, say to print it or to view it briefly. In such cases it is usually not desirable to capture the time for billing purposes. WORLDOX Billing provides the minimum work time value, measured in seconds, to allow for this. When a document is opened or created by WORLDOX in WordPerfect, timing does not begin until the minimum work time has elapsed. So, for example, if the minimum work time is set to 30 seconds, an operator must work on the document in WordPerfect for at least 30 seconds to engage WORLDOX Billing. If an operator opens a document, prints it and exits within the minimum work time, then no time-based billing data is captured. There are two important points to note about minimum work time:
Minimum work time is set by the WD96PARAMS value in WORLDOX.INI. The default value for minimum work time is 5 seconds. For example, WD96PARAMS=/B /BMinwork=10. 15. How do I set Maximum Idle Time? To set a value for maximum idle time you must add the /BMaxIdle parameter to WD96PARAMS value in the [Startup] section of the WORLDOX.INI file. Note that the /B switch must precede /BmaxIdle as shown in the example below. The format for the parameter is as follows: /BMaxIdle={number of seconds} To set the maximum idle time to 15 seconds, for example: WD96PARAMS=/B /BMaxIdle=15 The following line enables WORLDOX Billing and sets the maximum idle time to 15 seconds and the minimum work time to 30 seconds: WD96PARAMS=/B /BMaxIdle=15 /BMinWork=30 16. How can I set Minimum Work Time? To set a value for minimum work time you must add the /BMinWork parameter to WD96PARAMS value in the [Startup] section of the WORLDOX.INI file. Note that the /B switch must precede /BMinWork as shown in the example below. The format for the parameter is as follows: /BMinWork={number of seconds} To set the minimum work time to 30 seconds, for example: WD96PARAMS=/B /BMinWork=30 The following line enables WORLDOX Billing and sets the maximum idle time to 15 seconds and the minimum work time to 30 seconds: WD96PARAMS=/B /BMaxIdle=15 /BMinWork=30 17. How can I verify my Billing idle and
work time settings? You can use the "verbose" switch to have WORLDOX display the document tracking window at startup. The document tracking window displays idle and work time settings along with other billing information. To set the verbose switch, you must use the /BV switch instead of the /B switch with the WD96PARAMS value in the [Startup] section of the WORLDOX.INI file. 18. What is the Billing database? The billing statistics captured by WORLDOX Billing are stored in a database. If billing is not used, then the database is not created. If you plan to use billing, you must set up a billing database by specifying the location of files to be tracked in the database, and the location for the billing database files. A single billing information file is created for each day's documents. The files are located in the directory specified in WDADMIN. The file names are a combination of
Examples: 98021700.WAT, 98021701.WAT 19. How do I set up a Billing database? 1. Start WDADMIN (you must first exit WORLDOX if it is running). 2. Select AuditTrail > Configure > Databases. This displays the Audit Trail Paths window. 3. Select Databases > Add (or click the Add button) in the Audit Trail Paths window. 4. Enter a Resource Path. (See What is the Resource Path? for more information.) 5. Enter a Database Path. (See What is the Database Path? for more information.) 20. What is the Resource Path? The Resource Path tells WORLDOX Billing where to look for documents to be used with billing. You should specify the root directory of the drive containing documents you want to track. For example, to record billing statistics for the network drive, F, you would enter F:\. (See How do I set up a Billing database? for more information.) 21. What is the Database Path? The Database Path is the location of the database files that will store the billing statistics generated by WORLDOX Billing as you work on documents within WordPerfect. You may place the database files anywhere on the network provided that the path is shared by all users and has no access restrictions placed upon it. We recommend that you use a directory below the WORLDOX program directory, as shown below. Example, F:\WORLDOX\AUDIT. (See How do I set up a Billing database? for more information.) The path you specify is created automatically if it does not exist. 22. What if I want billing statistics for
documents on more than one drive? You can have multiple Resource/Database path pairs. Each pair can represent a different drive. You can add additional pairs, with each pointing to the same database in order to consolidate your statistics. The following example tracks billing statistics for several network drives:
23. How are billing statistics posted to
the database? Billing statistics are stored along with a document as it is edited. Before they can be used in reports, however, statistics must be copied, or posted, to the Billing database. Posting occurs under the following circumstances:
Posting moves the billing statistics to the database with today's date ("today" being the day on which the statistics are posted). Posting is a background process which you can generally ignore. It becomes an issue only if an editing session is interrupted preventing the document from being closed normally. 24. How do I view billing statistics collected
so far? WORLDOX presents billing statistics in a report created within the WORLDOX Administration program, WDADMIN. You can set up the report to include all documents with posted billing statistics or you can set up a report filter to select a subset of documents. 25. How do I create a billing report? 1. Start WDADMIN (you must first exit WORLDOX if it is running). 2. Select AuditTrail > Query > Billing. This displays the Billing Report Filter window, which looks somewhat similar to the WORLDOX Save window. 3. Fill in the Report filter by selecting one or more Profile Groups and by specifying one or more of the following criteria:
4. Click OK when done specifying criteria. This displays a window from which to select whether to report on Edit time, pages printed, or both. 5. Select what you want to report. This generates the report, which is shown in the Audit Trail History window. 26. How do I work with billing reports? The billing report is displayed in the Audit Trail History window. It shows each WORLDOX Billing record along with subtotals and a grand total for relevant billing statistics. The display looks similar to the main WORLDOX window. You may manipulate the Column Headers the same way as in the main WORLDOX window. To add columns that are not displayed by default, click on a blank spot in the header bar and select a field from the pop-up menu. You can view the report onscreen, print it to a file, or export it to a delimited ASCII text file. You also can use the WORLDOX viewer to view any document listed in the report by highlighting it and clicking the View button (or by selecting View from the window's Audit menu). 27. How can I select which field to subtotal
on? To group related records and present a subtotal, simply sort on the column for which you want to see a subtotal. For example, if you want to see subtotal breakouts for each user, sort on the UserCode column heading by clicking the sort arrow in the column header. 28. How do I print billing statistics? Before printing billing statistics you must generate a billing report. See How do I create a billing report?. In the billing report window (Audit Trail History window) select the document billing statistic records to include in the printout. All records are included by default (so if you don't select any records, then all of them will be in the report). Click the Print button in the billing report window (or select Print from the Report menu) to display the report layout window. You can use the report layout window to customize the output format, if you wish. You can create several formats and save them with descriptive names for later recall. See the online help for additional information. Click the Begin button in the toolbar (or select Begin from the Report menu) to print the report. Confirm the printer you want to print to when prompted and select OK. 29. How do I export billing statistics? You can export billing statistics to an ASCII text file if you choose. The process is the same as for printing statistics. In the billing report window (Audit Trail History window) select the document billing statistic records to include in the export file. All records are included by default (so if you don't select any records, then all of them will be included). Click the Print button in the billing report window (or select Print from the Report menu) to display the report layout window. Either select a previously saved report format, adjust the current format, or accept the default layout shown in the report layout window. Select Textfile in the Destination section at the lower left corner of the window. WDADMIN displays a Delimiters panel to the right of the Destination panel, allowing you to describe the format of the export file (See What export formats are supported?). Click the Begin button in the toolbar (or select Begin from the Report menu) and provide a name for the file you want to create when prompted and select OK. 30. What export formats are supported? WDADMIN exports billing information as a delimited ASCII text file. In this file format, each field-for example, a document name, or a user code-is enclosed in a pair of characters called delimiters, and is separated by a character such as a comma. The default format for export is "comma-quote delimited" meaning that each field is enclosed by a pair of quotes, and is separated by a comma. Most applications to which you would be likely to import billing data will support this format. However, you may use a different format, by specifying delimiters and a separator in the Delimiters panel of the report layout window. Predefined formats for delimiters include: quotes, parenthesis, curly braces, and brackets. You may also select Custom which enables you to specify left and right delimiter characters. Predefined formats for separators include: comma, space, and tab. You may also specify a custom separator if you chose. 31. Can I automate billing reports? If you have a billing report set up that you would like to use on a daily basis, you can set up a shortcut icon on your Windows desktop to generate the report. 1. Right-click on your desktop where you want to place the icon. 2. Select New > Shortcut from the popup menu. 3. When prompted for the command line, enter the following: {path}WDADMIN.EXE /BILLING={path for docs}[\*] {path for docs} is the highest level directory under which lie the documents you want included in the billing report. {\*} ensures that all applicable documents in all directories beneath the specified path are included in the report. Examples: 1. F:\WORLDOX\WDADMIN.EXE /BILLING=F:\DATA\WPFILES\* 2. F:\APPS\WORLDOX\WDADMIN.EXE /BILLING=F:\CLIENTS\12342 Example 1 reports on all files under F:\DATA\WPFILES. Example 2 reports on files only in the F:\CLIENTS\12342 directory. The shortcut report includes billing statistics with yesterday's
date for documents in the designated path. This means, for example,
that if you double-click the icon on Thursday, the report will produce
results for Wednesday. When activated on Monday, the report includes
statistics generated for the preceding Friday, Saturday, and Sunday. -- End of WORLDOX Billing FAQ -- WORLDOX® Billing Fast Track Rev 2.0 / Dec 26, 2001 The following steps take you on the fast track to setting up, using, and generating output from WORLDOX billing. After completing this tour-which should take about ten minutes-WORLDOX Billing will be enabled on your system. You may, however, wish to use the WORLDOX Billing FAQ and configure billing settings to accommodate your specific requirements. 1. Edit WORLDOX.INI to place WD96PARAMS=/BV in the [Startup] section. 2. In WDADMIN, select AuditTrail > Configure > Databases and enter a resource path and a database path. The resource path points to where the files are that you wish to track with WORLDOX Billing. The database path is where you want to place the billing database files. Example, Resource path: F:\, Database path: F:\WORLDOX\AUDIT. 3. Start WORLDOX then start WordPerfect. Open (or create) a document in WordPerfect and begin editing it. Make sure you work on it for more than the minimum work time (5 seconds by default). Save the file to the WORLDOX Sample Files cabinet (profile group) when done editing it. 4. Exit WORLDOX, start WDADMIN and select AuditTrail > Query > Billing. Fill in the Billing Report Filter window. You can choose one or more cabinets (Profile Groups) and add screen documents by additional parameters such as file dates, path, file name, and user code. 5. Choose Edit Time from the Select Billing Type window to display a report of the documents you have edited for which WORLDOX Billing has tracked editing time statistics. When multiple documents are listed, you can get subtotals (breakouts) on any field simply by sorting on that field. If you wish to view a listed document in the WORLDOX viewer, simply highlight it and click the Viewer button (or select Audit > View). 6. Click the print icon to display the Report Layout Editor. Verify that under Destination, Printer is selected and click the Begin Report button (or select Report > Begin). This prints a hardcopy of the billing information using the default report layout. If you wish, you can modify the layout and save it with a new Report Format Title, such as Billing Report. 7. Export the information you have just printed by selecting Textfile in the Destination area of the layout editor. Change the report formatting if you wish, or just press the Begin button. Enter BILLTEST when prompted for a file name. 8. Close the Billing Audit Report window and exit WDADMIN.
-- End of WORLDOX Billing Fast Track -- World Software Corporation 124 Prospect St. Ridgewood, NJ USA 07450 201-444-3228 www.worldox.com © Copyright 2001 World Software Corporation. All rights reserved. WORLDOX is a registered trademark of World Software Corp. All other registered and unregistered trademarks are the property of their respective holders. |
||||||||||||||||||||||||||||
