How to Generate Reports › Function Definition Reports › Function Definition Report in Hierarchical Order

Function Definition Report in Hierarchical Order

For each function and process in a model or subset, the Function Definition Report in Hierarchical Order gives the following information:

• Name
• Object ID
• Type
  (Function or Process)
• Description
• Parent
• Subordinates
  (If Any)
• Function Number

The function number identifies each process and function in the model.

The information in this report originates in the Process Hierarchy Diagram (PHD). Each page of the report contains a single function or process. By listing parents and subordinates, each entry indicates what the hierarchy contains one level above and one level below the function or process on the page.

The Function Definition Report in Hierarchical Order for a model shows all functions and processes in the model, including the root. For a subset, the report shows functions and processes, including the root, down to the lowest process within the subset.

For process definitions, the report adds two fields:

• EXPECTED EFFECTS
• PROPERTIES

Expected effects are the actions that the process is expected to produce on entity types and entity subtypes. The expected actions are:

• CREATE
• READ
• UPDATE
• DELETE

Or a combination of these.

The report organizes expected effects in two columns:

• ENTITY TYPE-The entity types and entity subtypes that the process acts on.
• EXPECTED ACTION(S)-Opposite each entity type or entity subtype, are the actions that the process is expected to produce on that entity type or entity subtype.

For example, in the following sample report, the process ACCUMULATE_EARNINGS expects to read and update the entity type Earnings. Expected actions appear in reverse order with the final action shown first.

MM/DD/YY                    FUNCTION DEFINITION REPORT                 PAGE 11
HH:MM

MODEL NAME:     TRUST AND STOCKHOLDER MANAGEMENT
SUBSET NAME:         ACCUMULATE EARNINGS

NAME:                4.2.1.4.1     ACCUMULATE_EARNINGS
OBJECT ID:           32100921
TYPE:                PROCESS

DESCRIPTION:

SUBORDINATE OF:      4.2.1.4 DET_PARTICIPATION_AND_EARNINGS

EXPECTED
EFFECTS              ENTITY TYPE                   EXPECTED ACTION(S)
                         EARNINGS                            UPDATE
                         EMPLOYEE                            READ
                         PARTICIPANT_CONTRIBUTION            UPDATE

PROPERTIES               MIN EXEC:            300
                         AVG EXEC:            310 PER YEAR
                         MAX EXEC:            350
                         GROWTH RATE:         1% PER YEAR