CST-Stream Model

This section describes the CST-Stream model, which is used to create the stream subprogram for a model. The stream subprogram converts the contents of a model PDA between internal and streamed format.

This section covers the following topics:


Introduction

When deploying a GUI front-end for a module on a Natural Construct client, Natural Construct must be able to translate the specification data passed to the server from the client. To do this, the model requires a stream subprogram to convert the contents of the model PDA into a format that can be transmitted between the client and the server.

If your model generates modules for a Natural Construct client, generate the model PDA and then use the CST-Stream model to generate the stream subprogram. For more information about generating the model PDA, see CST-PDA Model.

Parameters for the CST-Stream Model

Use the CST-Stream model to create the stream subprogram. This model has one specification panel, Standard Parameters.

Standard Parameters Panel

 CUGTMA                      CST-Stream Subprogram                      CUGTMA0
 Jul 05                       Standard Parameters                        1 of 1
  Module ............. ________
  System ............. C821____________________________


  Title .............. Stream Subprogram .._____
  Description ........ This Stream Subprogram will convert Models:___________
                       (...model name...)_____________________________________
                       PDA between internal and streamed formats._____________
                       _______________________________________________________


  Model PDA .......... ________ *
  Generate trace code  _






Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
main  help  retrn quit                                            userX main

The input fields on the Standard Parameters panel are:

Field Description
Module Name specified on the Generation main menu. The name of the stream subprogram must be alphanumeric and no more than eight characters in length. Use the following naming convention:
CXxxT

where xx uniquely identifies your model.

System Name of the system (by default, the name of the current library).

The system name must be alphanumeric, not exceed 32 characters in length, and does not have to be associated with a Natural library ID. (The combination of the module name and system name is used as a key to access help information for the generated subprogram.)

Title Title for the generated subprogram. The title identifies the subprogram for the List Generated Modules function on the Generation main menu and is used internally for program documentation.
Description Brief description of the subprogram. The description is inserted in the banner at the beginning of the subprogram and is used internally for program documentation.
Model PDA Name of the PDA used by the model for which you are generating the stream subprogram.
Generate trace code Indicates whether extra code is generated into the stream subprogram to help trace inconsistencies between data sent by the client and data expected by the server. To generate trace code, mark this field.

User Exits for the CST-Stream Model

CSGSAMPL                      Natural Construct                         CSGSM0
Jul 05                            User Exits                            1 of 1
               User Exit              Exists    Sample   Required Conditional
    -------------------------------- -------- ---------- -------- ------------
 _  CHANGE-HISTORY                            Subprogram
 _  LOCAL-DATA
 _  ADDITIONAL-INITIALIZATIONS                 Example
 _  END-OF-PROGRAM

For information about these user exits, see Supplied User Exits. For information about using the User Exit editor, refer to User Exit Editor, Natural Construct Generation.