Configuring Custom Help for JustWare¶
If your organization creates custom help files for your implementation of JustWare, you can access those help files from inside the application. JustWare's context-sensitive help system can be configured to point to custom help files instead of the standard help system, and you can provide a Help menu option to access the custom help as well.
Prepare Custom Help Files¶
JustWare can be configured to point to any URL for help, so you can create custom help files using the tool or method that meets your organization's needs.
To be context-sensitive (F1 brings up most relevant topic) the help files must contain an Alias or Index file that matches file names with ID numbers corresponding to a context-sensitive help ID for each snap-in in JWXML.
To find or change the context-sensitive help ID in JWXML, open JWXMLSpy from the Maintenance Console and browse to the desired session file. Within the <SnapIn> element, specify the contextid attribute (for example: contextid="300"). Either change it to the ID you want (which matches the ID for the file name of the corresponding topic in your custom help files) or make note of it and type that as the ID for your help topic in the Alias/Index file.
Once you have matched ID numbers between relevant snap-ins in JWXML and your Alias file, you can point the Custom Help URL to your help files.
A reference for context IDs to JustWare topics can be found at the end of this page.
|
If the ID number found in the JWXML has no corresponding ID in the help files, the default home page for your help system will be displayed. It is recommended that you make this home page as helpful as possible to the user, including a brief table of contents and search capability. |
Specify the Custom Help URL¶
To make custom help files accessible from JustWare, a Custom Help URL must be specified either during installation or in the Maintenance Console. With this URL set up, when users press F1 with focus on a particular snap-in in JustWare, the custom help topic with the corresponding ID will be opened. A Help menu option can also be displayed to allow access to custom help files from the Help menu.
- During installation of JustWare you will encounter a screen entitled Select Online Help Virtual Directory Path and Name. The Virtual Directory Path and Virtual Directory Name fields refer to the standard JustWare help system, and will be automatically populated. Do not change these fields.
- Use the fields below to configure your custom help system.
- Custom Help URL: type the location of your custom help files. Include @[ContextID] in the URL to enable it to recognize context-sensitive ID's and direct the user to the relevant topic when F1 is pressed. The @[ContextID] will be replaced in the URL by whatever the Alias/Index file specifies as corresponding to the ID.
- Show in Help menu as: To include an option in the Help menu to launch your custom help, type a name for it here. If this field is left blank, only the standard JustWare Help will be shown in the Help menu (although F1 will still point to your custom help).
- Display standard JustWare help in menu: clear this check box to remove the standard JustWare help from the Help menu, or leave it selected to make it available. This option will be disabled unless you have specified a Custom Help URL.
OR
- Open the Maintenance Console and navigate to the SmartClients tab.
- Navigate to the Extra JustWare settings tab.
- In the Custom Help settings group, use the fields to configure your
custom help system:
- URL (should include @[ContextID] ) : specify the URL where your custom help files are located. Include @[ContextID] in the URL to enable it to recognize context-sensitive ID's and direct the user to the relevant topic when F1 is pressed. The @[ContextID] will be replaced in the URL by whatever the Alias/Index file specifies as corresponding to the ID.
- Show in Help menu as: To include an option in the Help menu to launch your custom help, type a name for it here. If this field is left blank, only the standard JustWare Help will be shown in the Help menu (although F1 will still point to your custom help).
- Display standard JustWare help in menu: clear this check box to remove the standard JustWare help from the Help menu, or leave it selected to make it available. This option will be disabled unless you have specified a Custom Help URL.
Context IDs for JustWare topics¶
| Context ID | Topic |
|---|---|
| 1 | Discovery Packets |
| 3 | Location Assignment Tool |
| 5 | Accounting Tools |
| 7 | My JustWare Batch Workflow |
| 9 | Count Enhance Element |
| 10 | Exhibit Status |
| 11 | Name Search |
| 100 | Copying Snap-in Records |
| 101 | Editing Multiple Snap-in Records |
| 103 | Vouchers |
| 150 | My JustWare |
| 151 | My JustWare Calendar |
| 152 | My JustWare Agency Time Tracking |
| 153 | My JustWare Agency Time Tracking |
| 154 | System Reports |
| 155 | My JustWare Tasks |
| 170 | Search |
| 171 | Name/Case Lookup |
| 200 | Names |
| 201 | Address Contact Info |
| 202 | Phone Contact Info |
| 203 | Email Contact Info |
| 204 | Name Attributes |
| 205 | Name Numbers |
| 206 | Case Involvements |
| 207 | Primary Relationships |
| 208 | Secondary Relationships |
| 209 | Name Calendar |
| 270 | Financial Obligations |
| 271 | Payment Tools |
| 272 | Tracking Payment Allocations |
| 273 | Manual Allocations |
| 274 | Payment Schedules |
| 300 | Cases |
| 301 | Copying a Case |
| 302 | Case Agencies |
| 303 | Case-Involved People |
| 304 | Related Cases |
| 305 | Case Attributes |
| 306 | Physical Location |
| 325 | Charges |
| 326 | Charges |
| 327 | Charges: Location |
| 328 | Charges: Charge Attributes |
| 329 | Charges: Charge Agencies |
| 330 | Charges: Charge Involvements |
| 331 | Charges: Intoxicants |
| 332 | Charges: Modify/Enhance |
| 333 | Charges: Exhibits |
| 334 | Charges: Charge History |
| 350 | Adjusting Entry |
| 351 | Bonds |
| 353 | Bonds |
| 354 | Bonds: Bond History |
| 355 | Non-collectable Financials |
| 375 | Conditions |
| 376 | Credit Suspend |
| 377 | Judgments |
| 378 | Sentences |
| 400 | Filing Cabinet |
| 401 | Case Notes |
| 402 | Rich Notes |
| 403 | Document Routing |
| 450 | Name Calendar |
| 451 | Case Correspondences |
| 452 | Involved People |
| 453 | Events |
| 454 | Past Events |
| 455 | Email and Pop-up Reminders |
| 456 | Case Tasks |
| 500 | Case Reports: Case Notes |
| 501 | Case Reports: Case Notes Complete |
| 502 | Case Reports: Case Summary |
| 503 | Case Reports: Involved Person Contact Info |
| 504 | Case Reports: Case Exhibits |
| 515 | Financial Reports: Financial Accounts |
| 516 | Financial Reports: Owed Money Amount Details |
| 517 | Financial Reports: Payment Receipt |
| 518 | Financial Reports: Voucher Amount Details |
| 519 | Financial Reports: Voucher List |
| 520 | Financial Reports: Voucher Receipt |
| 521 | Financial Reports: Bond Information |
| 522 | Financial Reports: Payment Received By User |
| 523 | Financial Reports: Payment Schedule Report |
| 530 | System Reports |
| 531 | System Reports |
| 533 | System Reports |
| 534 | System Reports |
| 535 | System Reports |
| 536 | System Reports |
| 545 | Name Reports: Case Involvements |
| 546 | Name Reports: Financial Name Summary |
| 547 | Name Reports: Name Information With Mugshot |
| 548 | Name Reports: Name Summary |
| 560 | System Reports: Advanced Case Search |
| 561 | System Reports: Advanced Calendar |
| 562 | System Reports: Advanced Case Involvements |
| 563 | System Reports: Advanced Event Matrix |
| 565 | System Reports: Agency User Logging |
| 566 | System Reports: Barcode Cases |
| 567 | System Reports: Barcode Exhibits |
| 568 | System Reports: Barcode Masterlist |
| 569 | System Reports: Cases By Statute |
| 570 | System Reports: Case Counts and Costs |
| 571 | System Reports: Case Hours Worked |
| 572 | System Reports: Case Notes Search |
| 573 | System Reports: Case Age Caseload |
| 576 | System Reports: Clearance Rates |
| 577 | System Reports: Conflict Check Name Screen |
| 578 | System Reports: Court Calendar |
| 579 | System Reports: Current Case Owners |
| 580 | System Reports: Current Exhibit Owners |
| 582 | System Reports: JW Usage Audit |
| 583 | System Reports: JW Cases By Statute |
| 584 | System Reports: Monthly Case Type Count |
| 585 | System Reports: Security Permissions by Profile |
| 586 | System Reports: Security Permissions by User |
| 587 | System Reports: Time Status |
| 588 | System Reports: Time to Disposition |
| 589 | System Reports: Trial Date Certainty |
| 590 | System Reports: Advanced Statute Search |
| 592 | System Reports: Case Search by Type |
| 593 | Admin Guide Home |
| 594 | System Reports: Case Summary Logging |
| 595 | Using Unit Log |
| 596 | Case Status History |
| 597 | Physical Location Tool |
| 602 | Business Rules |
| 603 | Case Reassignment Tool |
| 604 | Code Filtering |
| 605 | Auto Case Number Generation |
| 606 | Default Case Involve Types |
| 607 | Default Event Involved Names |
| 608 | Duplicate Name Detection |
| 610 | Default Event Reminders |
| 611 | Email Reminder Templates |
| 613 | Notifications: Datasource |
| 614 | Notifications: Template |
| 640 | Agency Accounts |
| 641 | Voucher Tools |
| 651 | Agency Code Table |
| 652 | Agency Persons Code Table |
| 653 | Application Person |
| 654 | Data Partitioning |
| 655 | Security Profile Data Partitioning |
| 656 | Agency Partitioning |
| 657 | Security Profiles |
| 658 | Creating Security Profiles |
| 659 | Setting Permissions for Security Profiles |
| 660 | Adding Users and Groups To A Profile |
| 661 | Creating Profile Attributes |
| 700 | Code Tables Introduction |
| 701 | Number Type Code Table |
| 702 | Case Involved People Code Table |
| 703 | Domain Mapping Table |
| 704 | Application Parameters |
| 706 | Case Type Code Table |
| 707 | Case Status Code Table |
| 708 | Case Attribute Code Table |
| 711 | Exhibit Type Code Table |
| 712 | Charge Attribute Code Table |
| 713 | Jurisdiction Code Table |
| 714 | County Code Table |
| 715 | District Code Table |
| 716 | State Code Table |
| 717 | Intoxicant Code Table |
| 718 | Charge History Code Table |
| 719 | Correspondence Type Code Table |
| 720 | Location Code Table |
| 721 | Status Code Table |
| 722 | Event Type Code Table |
| 723 | Case Relationships Code Table |
| 724 | Plea/Dispo Type Code Table |
| 725 | Sentence Type Code Table |
| 726 | Credit Suspend Type Code Table |
| 727 | Condition Type Code Table |
| 728 | Financial Account Administration |
| 729 | Account Status Code Table |
| 730 | Account Type Code Table |
| 731 | Bond Status Code Table |
| 732 | Bond Type Code Table |
| 733 | Bond Condition Type Code Table |
| 734 | Amount Due Type Code Table |
| 735 | Payment Status Code Table |
| 736 | Payment Type Code Table |
| 737 | Transfer Type Code Table |
| 738 | Voucher Status Code Table |
| 739 | Voucher Type Code Table |
| 740 | Document Generation |
| 741 | Document Type Code Table |
| 742 | Document Status Code Table |
| 744 | Name Administration |
| 745 | Address Type Code Table |
| 746 | Phone Type Code Table |
| 747 | Email Type Code Table |
| 748 | Name Type Code Table |
| 749 | Name Attribute Code Table |
| 751 | Driver License Class Code Table |
| 752 | Hair Color Code Table |
| 753 | Eye Color Code Table |
| 754 | Race Code Table |
| 755 | Gender Code Table |
| 756 | Related Person Code Table |
| 758 | Statutes |
| 759 | Modifier/Enhancer |
| 760 | Statute Prerequisites: Class Code Table |
| 761 | Statute Prerequisites: Category Code Table |
| 762 | Statute Prerequisites: Severity Code Table |
| 763 | Statute Prerequisites: Source Code Table |
| 764 | Statute Prerequisites: Text Type Code Table |
| 765 | Statute Prerequisites: Attribute Type Code Table |
| 766 | Time Tracking "Rate Code" Code Table |
| 767 | Time Tracking Rate Code Table |
| 768 | Time Tracking Type Code Table |
| 769 | Time Tracking Status Code Table |
| 770 | Task Type Code Table |
| 771 | Case Notes Type Code Table |
| 772 | Attributes Code List Code Table |
| 773 | Name Number Auto Generation |
| 774 | Auto Name Number Increment Code Table |
| 1000 | Document Scanning |
| 1002 | Docket Calendar |
| 1003 | Docket Management |
| 1004 | Adding Docket Events |
| 1005 | Select Docket |
| 1006 | Physical Location Tool |
| 1001 | Viewing Unit Log |
| 1007 | Keyboard Shortcuts |
| 1008 | Charge Type Code Table |
| 1009 | Case Payments Tool |
| 1010 | Deposits Tool |
| 1011 | Non-case Payments Tool |
| 1012 | Payment History |
| 1013 | Case Title Configuration |
| 1014 | ZIP Code Auto Fill Rules |
| 1015 | Pending Payments |
| 1016 | Post Time Tracking |
| 1017 | Filing Cabinet |
| 1300 | Public Document Orders Session |
| 1301 | Public Document Orders |
| 1302 | Public Document Order Items |
| 1303 | Public Document Payments |
| 1304 | Public Document Non-Collectable Financials |
| 1305 | Public Documents Settings Session |
| 1306 | Public Documents Search Field Configuration |
| 1307 | Public Documents Result Display Options |
| 1308 | Public Documents Delivery Methods Configuration |
| 1309 | Public Documents Shipping Status Configuration |
| 1310 | Public Documents Document Type Flat Rates Configuration |
| 1311 | Public Documents Setup |
| 1312 | Locked Documents Session |