Application Options Reference - hmislk/hmis GitHub Wiki

Application Options Reference

Overview

This reference guide provides a comprehensive list of application configuration options available in the HMIS system. These settings allow administrators to customize system behavior according to organizational needs.

How to Access Application Options

Navigation: Administration → Manage Institutions → Application Options

Once in the Application Options interface:

  1. Use the search function to find specific configuration keys
  2. Browse through categories to find related settings
  3. Click on any configuration key to modify its value
  4. Save changes to apply them system-wide

Pharmacy Configuration Options

Pharmacy Transfer and Issue Operations

Display Controls

These options control what information is visible during pharmacy transfer and issue operations:

Configuration Key Type Default Description
Stock Transaction - Show Rate and Value Boolean false Shows/hides rate and value columns in all stock transactions
Pharmacy Transfer Issue - Show Rate and Value Boolean false Controls rate and value visibility specifically in transfer issue operations
Display Colours for Stock Autocomplete Items Boolean true Enables color-coding of stock items based on expiry dates and stock levels

Bill Format and Printing

Control how pharmacy transfer bills appear and print:

Configuration Key Type Default Description
Pharmacy Transfer Issue Bill is PosHeaderPaper Boolean true Controls main print button visibility for POS-style receipts
Pharmacy Transfer Issue Bill is POS Paper without details Boolean false Generates simple POS receipts without item details
Pharmacy Transfer Issue Bill is POS Paper with details Boolean false Generates detailed POS receipts with full item information
Pharmacy Transfer Issue Bill is POS Paper with header Boolean false Includes institutional header on POS receipts
Pharmacy Transfer Issue Bill is Template Boolean false Uses custom template for bill formatting

Rate Calculation Methods

Important: Only ONE of these should be set to true at any time:

Configuration Key Type Default Description
Pharmacy Transfer is by Purchase Rate Boolean false Calculates transfer costs using original purchase rates
Pharmacy Transfer is by Cost Rate Boolean false Calculates transfer costs using calculated cost rates
Pharmacy Transfer is by Retail Rate Boolean true Calculates transfer costs using retail selling rates

Bill Number Generation

Control how transfer bill numbers are generated:

Configuration Key Type Default Description
DepNumGenFromToDepartment Boolean false Generates separate bill number series for each from-to department combination

Transfer Report Configuration

Customize what appears in pharmacy disbursement reports:

Configuration Key Type Default Description
Report Font Size of Item List in Pharmacy Disbursement Reports String 10pt Sets font size for item listings in reports
Pharmacy Disbursement Reports - Display Serial Number Boolean true Shows sequential numbering in report item lists
Pharmacy Disbursement Reports - Display Code Boolean true Shows item codes in disbursement reports
Pharmacy Disbursement Reports - Display Batch Number Boolean false Shows batch numbers for tracked items
Pharmacy Disbursement Reports - Display Date of Expiary Boolean true Shows expiration dates in reports
Pharmacy Disbursement Reports - Display Purchase Rate Boolean true Shows original purchase rates
Pharmacy Disbursement Reports - Display Purchase Value Boolean false Shows calculated purchase values
Pharmacy Disbursement Reports - Display Retail Sale Rate Boolean false Shows retail selling rates
Pharmacy Disbursement Reports - Display Retail Sale Value Boolean false Shows calculated retail values
Pharmacy Disbursement Reports - Display Transfer Rate Boolean false Shows actual transfer rates used
Pharmacy Disbursement Reports - Display Transfer Value Boolean false Shows actual transfer amounts

Bill Customization

Customize bill appearance:

Configuration Key Type Default Description
Pharmacy Transfer Issue Bill Footer CSS String '' Custom CSS styling for bill footers
Pharmacy Transfer Issue Bill Footer Text String '' Custom text to appear at bottom of bills

Laboratory Configuration Options

Laboratory Interface Settings

Configuration Key Type Default Description
The system uses the Laboratory Dashboard as its default interface Boolean Varies When enabled, Laboratory Dashboard becomes primary interface and Sample Management may be hidden
Pharmacy Analytics - Show Department Stock By Batch Boolean Varies Controls batch-level stock reporting in pharmacy analytics

Laboratory Reports

Configuration Key Type Default Description
Lab Daily Summary Report - Legacy Method Boolean Varies Uses original reporting method (may be slower)
Lab Daily Summary Report - Optimized Method Boolean Varies Uses improved DTO-based reporting (recommended for performance)

Billing and Financial Configuration

Shift-Based Operations

Configuration Key Type Default Description
applicationPreference.opdBillingAftershiftStart Boolean Varies Requires active cashier shift for OPD billing operations
applicationPreference.pharmacyBillingAfterShiftStart Boolean Varies Requires active cashier shift for pharmacy billing

Impact of Enabling Shift-Based Operations:

  • Users must start a cashier shift before billing
  • Financial Transaction Manager becomes available in relevant menus
  • Enhanced financial accountability and tracking
  • End-of-shift reconciliation procedures become mandatory

Search and Autocomplete

Configuration Key Type Default Description
OPD Bill Item Search By Autocomplete Boolean Varies Changes OPD billing interface to use autocomplete search (opd_bill_ac.xhtml)

Cash Management Configuration

Shift End Procedures

Configuration Key Type Default Description
Recording Shift End Cash is Required Before Viewing Shift Reports Boolean Varies Enforces cash counting before accessing shift reports

Shortage and Excess Handling

Configuration Key Type Default Description
Shift Shortage Bills are enabled Boolean Varies Allows recording of cash shortages with explanations
Shift Excess Bills are enabled Boolean Varies Allows recording of excess cash with investigations

Configuration Best Practices

Planning Changes

1. Assessment Phase

  • Current State Analysis: Document existing configuration before changes
  • User Impact Review: Assess how changes will affect daily workflows
  • Training Requirements: Plan user education for interface changes
  • Performance Considerations: Evaluate potential system performance impacts

2. Testing Phase

  • Test Environment: Always test configuration changes in non-production environment first
  • User Acceptance Testing: Get feedback from key users before full implementation
  • Integration Testing: Verify configurations work correctly with existing workflows
  • Performance Testing: Monitor system performance with new configurations

3. Implementation Phase

  • Staged Rollout: Implement changes gradually, starting with less critical departments
  • Communication Plan: Inform all affected users about upcoming changes
  • Support Preparation: Ensure help desk staff understand new configurations
  • Documentation Updates: Update user guides and training materials

Monitoring and Maintenance

1. Post-Implementation Monitoring

  • Performance Metrics: Monitor system performance after configuration changes
  • User Feedback: Collect feedback on usability and workflow impacts
  • Error Monitoring: Watch system logs for configuration-related issues
  • Usage Analytics: Track adoption and usage patterns of new features

2. Ongoing Maintenance

  • Regular Reviews: Periodically assess if configurations still meet organizational needs
  • Optimization Opportunities: Look for ways to improve system performance through configuration
  • User Training Updates: Provide refresher training on configuration-dependent features
  • Documentation Maintenance: Keep configuration documentation current

Common Configuration Scenarios

Scenario 1: Simplifying Pharmacy Interface

Objective: Reduce complexity for basic pharmacy operations

Recommended Settings:

Stock Transaction - Show Rate and Value = false
Pharmacy Transfer Issue - Show Rate and Value = false
Pharmacy Disbursement Reports - Display Purchase Rate = false
Pharmacy Disbursement Reports - Display Purchase Value = false
Pharmacy Disbursement Reports - Display Retail Sale Rate = false
Pharmacy Disbursement Reports - Display Retail Sale Value = false

Result: Simplified interface with minimal financial information

Scenario 2: Enhanced Financial Accountability

Objective: Implement comprehensive financial controls

Recommended Settings:

applicationPreference.opdBillingAftershiftStart = true
applicationPreference.pharmacyBillingAfterShiftStart = true
Recording Shift End Cash is Required Before Viewing Shift Reports = true
Shift Shortage Bills are enabled = true
Shift Excess Bills are enabled = true

Result: Mandatory shift procedures with full accountability

Scenario 3: Optimized Laboratory Operations

Objective: Streamline laboratory workflow

Recommended Settings:

The system uses the Laboratory Dashboard as its default interface = true
Lab Daily Summary Report - Optimized Method = true
Lab Daily Summary Report - Legacy Method = false

Result: Modern laboratory interface with improved performance

Troubleshooting Configuration Issues

Common Issues and Solutions

Changes Not Taking Effect

Problem: Configuration changes made but not visible to users
Solutions:

  • Clear browser cache and refresh pages
  • Restart application server if changes affect system-level behavior
  • Verify configuration was actually saved in the system
  • Check if user has appropriate permissions to see affected features

Performance Degradation

Problem: System becomes slower after configuration changes
Solutions:

  • Review enabled display options and disable unnecessary ones
  • Use optimized versions of features where available (e.g., DTO reports)
  • Monitor database query performance for complex configurations
  • Consider staged implementation of performance-heavy features

Conflicting Settings

Problem: Unexpected behavior or system errors
Solutions:

  • Ensure mutually exclusive options are properly configured (only one enabled)
  • Review related settings that might interact with changed configurations
  • Check configuration hierarchy (application vs institution vs department)
  • Verify configuration key names are spelled correctly

Security and Access Considerations

Configuration Access Control

  • Administrative Privileges: Only users with appropriate administrative rights should modify application options
  • Change Documentation: Maintain audit trail of who made configuration changes and when
  • Testing Requirements: Always test configuration changes before implementing in production

Impact Assessment

  • Data Visibility: Consider privacy implications of configuration changes that affect data display
  • Workflow Changes: Assess how configuration changes might impact existing procedures
  • Training Requirements: Plan user education for significant configuration modifications

Getting Help with Configuration

Internal Resources

  1. System Administrator: Primary contact for configuration questions and issues
  2. Department Heads: For understanding business requirements behind configuration needs
  3. Power Users: Experienced users who can provide feedback on configuration impacts
  4. Documentation: This guide and related configuration documentation

External Support

  1. HMIS Technical Support: For complex configuration issues or system-level problems
  2. User Community: Other HMIS users who may have similar configuration needs
  3. Training Resources: Additional documentation and training materials

Related Resources:

Important Reminders:

  • Always test configuration changes in a non-production environment first
  • Document the business justification for all configuration changes
  • Consider the impact on user training and support when making changes
  • Monitor system performance after implementing new configurations
âš ī¸ **GitHub.com Fallback** âš ī¸