What types of documentation can be created with HELP/KEY?

HELP/KEY is designed for creating and maintaining online help panels and hard-copy documentation specifically for CICS applications. It streamlines the documentation process, ensuring that users have access to accurate and up-to-date information within the CICS environment.

How does HELP/KEY integrate with CICS?

HELP/KEY supports the creation of both online help panels, accessible directly within CICS transactions, and hard-copy documentation, such as user manuals and reference guides. This dual capability ensures comprehensive documentation coverage.

What are the key benefits of using HELP/KEY?

HELP/KEY integrates with CICS by providing tools to define and manage help panels that are directly accessible from within CICS transactions. This integration ensures that users can access relevant documentation without leaving their current CICS session.

What configuration files or interfaces are used?

The command structure involves using the Panel Definition Facility (PDF) to define the layout and content of help panels. Commands include DEFINE PANEL, ADD TEXT, and LINK to create and structure the help information. For example: DEFINE PANEL MYPANEL; ADD TEXT 'This is help text'; LINK NEXTPANEL.

What protocols does HELP/KEY use for communication?

Configuration primarily involves defining panel layouts and help text within the PDF. The system uses internal data structures to store panel definitions and help text. There are no external configuration files.

How does HELP/KEY reduce training costs?

By providing readily available and context-sensitive help within CICS applications, users can quickly find the information they need, reducing the time spent searching for answers and minimizing downtime.

How does HELP/KEY enhance application usability?

HELP/KEY reduces training costs by providing comprehensive online help that users can access independently. This reduces the need for extensive classroom training and allows users to learn at their own pace.

What is the return on investment (ROI) of using HELP/KEY?

HELP/KEY enhances application usability by providing clear and concise documentation directly within the application. This makes the application easier to understand and use, leading to increased user satisfaction.

What access control model is used?

HELP/KEY relies on the security features of the CICS environment and does not implement its own authentication methods. Access to help panels is governed by CICS security settings.

What encryption is used?

HELP/KEY utilizes the access control model provided by CICS. This typically involves user IDs and security profiles to control access to resources, including help panels.

What audit/logging capabilities exist?

HELP/KEY does not perform encryption. Security is managed by the underlying CICS environment, which may use encryption for data transmission and storage.

How is user management handled?

Administration is primarily performed through the Panel Definition Facility (PDF) within the CICS environment. There is no separate command-line interface or web console.

What are the main configuration parameters?

User management is handled through the CICS security system. Access to HELP/KEY resources is controlled by CICS user IDs and security profiles.

What monitoring/logging capabilities exist?

The main configuration parameters relate to the definition of help panels within the PDF. These include panel layouts, text content, and linking between panels.

Share Your Product Experience

Help the community by sharing your experience with mainframe products. Your insights help others make informed decisions.

Share Your Experience

HELP/KEY

ASPG Active z/OS zVSE/VSEn

Help Documentation and Training CICS

Vendor

ASPG

Product Overview

The architecture of HELP/KEY is centered around several key components: the Panel Definition Facility (PDF), the Help Text Editor, the Online Help System, and the Documentation Generator. The PDF is the core component, providing the interface for defining panel layouts and content. The Help Text Editor allows for the creation and modification of help text.

The Online Help System delivers the help panels within CICS transactions. The Documentation Generator creates hard-copy documentation. These components interact through internal CICS mechanisms.

The PDF uses internal data structures to store panel definitions and help text. There are no external APIs. Security relies on CICS's access control model, using user IDs and security profiles.

The system does not use encryption. Compared to manual documentation systems, HELP/KEY offers a streamlined approach. The system operates entirely within the CICS environment, without external network dependencies.

The Online Help System provides the runtime environment for accessing the help panels.

Frequently Asked Questions

Help Improve This Directory

Notice outdated information? Have insights about this product? Help the mainframe community stay informed with accurate, current data.

Report Issue Suggest Product Share Event

Share Your Product Experience

Help the community by sharing your experience with mainframe products. Your insights help others make informed decisions.

Share Your Experience

Share Your Product Experience

HELP/KEY

Product Overview

Frequently Asked Questions

What is the primary function of HELP/KEY for CICS applications?

What types of documentation can be created with HELP/KEY?

How does HELP/KEY integrate with CICS?

What are the key benefits of using HELP/KEY?

undefined

What are the main components of HELP/KEY?

What is the command structure for creating help panels?

What configuration files or interfaces are used?

What protocols does HELP/KEY use for communication?

undefined

How does HELP/KEY improve user productivity?

How does HELP/KEY reduce training costs?

How does HELP/KEY enhance application usability?

What is the return on investment (ROI) of using HELP/KEY?

undefined

What authentication methods are supported by HELP/KEY?

What access control model is used?

What encryption is used?

What audit/logging capabilities exist?

undefined

What administrative interfaces are available?

How is user management handled?

What are the main configuration parameters?

What monitoring/logging capabilities exist?

undefined

Related Products

More from ASPG

Similar Products

Help Improve This Directory

Share Your Product Experience