Progress
Results Administration
and Development Guide


Integration Points and Procedures

Integration procedures are modules of the Results engine that let programmers integrate Results into an application or end-user environment. These Progress procedures execute at key integration points, such as at Results startup or just prior to executing a query. Results performs default processing at certain integration points and no processing at others. You can insert your own integration procedure at an integration point to override default Results processing.

To define an integration procedure for a Results integration point, choose Query Customize Integration Procedures. The Integration Procedures dialog box appears:

The Integration Procedures dialog box contains the following user-interface elements:

Integration Point

Lists the available integration points. The current integration point is highlighted.

Procedure for

Specifies the Progress procedure file associated with the current integration point. Choose the Files button to locate an existing procedure file and associate it with the current integration point.

To remove an integration procedure from an integration point, select an integration point and then clear the associated integration procedure name from the Procedure field.

The key to using integration procedures is understanding when they will execute and what is the default processing at the different integration points.Table 3–1 provides important information about integration points and procedures.

Table 3–1: Integration Points and Procedures
Integration
Point
Common
Use
Execution/
Default Processing
Example
Integration Procedure
Feature Security
Prohibits the use of certain Results features by user ID.
Executes once at Results startup. No default processing.
aderes/u-secure.p 
Field Security
Prohibits access to sensitive fields by user ID. You can use this procedure to specify fields that the user cannot access.
Executes once prior to each time Results displays a list of fields for the user to choose from. No default processing.
aderes/u-field.p 
Initialize Vars and Interface
Initializes new shared variables and other data structures used by features and integration procedures.
Executes once at Results startup. No default processing.
aderes/u-define.p 
Log Program
Checks user IDs at Results startup for product security configuration.
Executes once at startup. The aderes/_slogin.p procedure provides the default processing. You cannot edit _slogin.p.
aderes/u-login.p 
Log Screen
Defines the graphics used in the Results window.
Executes once at Results startup. The u-logo.p example procedure provides default processing.
aderes/u-logo.p 
Menu Item Override
Manages the sensitivity of programmer-defined menu options and toolbar icons.
Executes once after the execution of any feature in Results. No default processing.
aderes/u-mcheck.p 
Query Directory Switch
Controls the location and user access to query directory (.qd) files.
Executes when the user chooses the Directory button in the Open, Save As, or Delete dialog boxes.
aderes/u-direct.p 
Table Security
Prohibits access to sensitive tables by user ID. You can use this procedure to specify tables that users cannot access.
Executes once per 350 tables. No default processing.
aderes/u-direct.p 
Table Selection Security
Prohibits access to sensitive data by user ID. You can use this procedure to insert additional selection criteria into a WHERE clause.
Executes once prior to execution of a query in Results. No default processing.
aderes/u-where.p 

You can use integration procedures to implement your own data and feature security systems. You can also use integration procedures to instantiate variables and create other preconditions required by features.

The example integration procedure for each integration point documents the parameter definitions and other code structures required at the integration point. The examples can also serve as models for your own integration procedures. For more information about the Results Application Programming Interface, see the "Results Application Programming Interface (API)" section.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095