Zum Hauptinhalt springen
Deutsch
|
English

DISABLEHELPBUTTON - Detailed description

FM-Portal

IC2878
FM-Portal

Overview

Parameter:DISABLEHELPBUTTON
Category: Custom Default
value: 0 (Help button is displayed)
Product: eTASK.Other (Custom)

What does this parameter do?

This parameter controls the visibility of the Help button in the taskbar and on various pages of the eTASK portal. The Help button provides users with context-sensitive help for the respective modules and functions. With this parameter, you can hide the default Help button if you provide your own, customer-specific help documentation. Administrators always see the Help button, regardless of this setting.

What is this parameter used for?

  • Hiding the standard Help button when using custom documentation

  • Integration of customer-specific help systems

  • Adaptation to company-specific support structures

  • Controlling access to the eTASK standard help

  • Control over help sources for end users

  • Enabling custom documentation strategies

Technical Details (for Administrators)

Format: Integer (0 or 1)
Default value: 0 (Help button is displayed)

Valid values:

  • 0 = Help button is displayed (default value, recommended)

  • 1 = Help button is hidden (except for administrators)

Important notes:

  • Administrators always see the Help button, regardless of this setting

  • This setting applies across the entire portal to all modules and pages

  • The button is hidden only for regular users

  • The eTASK standard help function remains technically available

  • Affects only the visual display of the button

Interaction with other parameters:

  • No direct dependencies on other parameters

  • Part of the portal’s general UI configuration

When should you change this value?

Set the value to 1 (hide) if:

  • You want to provide your own, customer-specific help documentation

  • Only your own documentation sources should be referenced

Set the value to 0 (show) if:

  • You want to use the standard eTASK help

  • Users should benefit from the full eTASK help

  • Recommendation: Keep the default value (0)

The eTASK standard help is comprehensive and is continuously updated. Change the value to 1 only if you provide your own equivalent help documentation that is specifically tailored to your business processes.

Important Notes

  1. Custom help must be provided
    If you hide the standard help button, ensure that alternative, comprehensive help documentation is available to your users.

  2. Communication to users
    If you hide the standard help button, clearly inform users about the alternative help sources (your own wiki, intranet, specific documentation).

  3. Consider maintenance requirements
    Custom help documentation must be continuously maintained and updated during portal updates. The eTASK standard help is updated automatically.

  4. Adapt training materials
    If you hide the button and provide your own help, adapt training materials accordingly.

  5. Ensure quality
    Ensure that your own documentation meets the desired quality standards.

Security

Does changing this parameter affect security?

No, this parameter has no direct impact on security.

Note:

  • The parameter controls only the visibility of a UI element

  • No impact on access control or data processing

  • Administrators always retain access to all functions

  • No changes to permissions or data flows

Practical example

Initial situation: Your company has mapped extensive, company-specific processes in the eTASK portal. You have created your own help system with detailed process documentation tailored specifically to your organizational structure, workflows, and naming conventions. The eTASK standard help describes the general functions, but not your specific processes. You want users to use only your customized documentation.

Situation before the change:

DISABLEHELPBUTTON = 0 (Standard help button is displayed)

  • eTASK standard help shows general functions

  • Process Help displays company-specific workflows

  • Users must switch between two help sources

  • The specific source is not as easy to access as the general one

  • Inconsistent terminology between standard help and internal processes is possible

Configuration: DISABLEHELPBUTTON = 1 (Standard help button is hidden)

Situation after change:

  • No more confusion due to duplicate help options

  • Users find their process-specific documentation

  • Consistent terms and terminology in the help

  • Help matches the implemented processes exactly

  • Clear, unambiguous help structure

Maintaining your own documentation:

Regular tasks:
After portal updates:

  • Check documentation for updates

  • New features: Integrate into your own help

  • User feedback: Update the FAQ

  • Process changes: Update help immediately

  • Regularly: Check for completeness - Screenshots: Update them when UI changes occur

Recommended setting

Default:0 (display - use eTASK standard help)

Reason:

  • eTASK standard help is complete and is continuously updated

  • No need to maintain your own documentation

  • Automatic updates for new portal versions

  • Professionally created and tested

  • Context-sensitive help for all functions

  • Cost-effective: No resources required for documentation maintenance

Important: Do not underestimate the effort required to create and maintain your own documentation. The eTASK standard help is comprehensive, up-to-date, and automatically maintained. Set DISABLEHELPBUTTON to 1 only if you are certain that your own documentation will offer the same or a higher standard in the long term.

War dieser Artikel hilfreich?