RUN_PRODUCT Built-in
Description
Invokes the Graphics product and specifies the name of the Graphics module
or module to be run. If Graphics is unavailable at the time of the call, Oracle Forms returns a message to the end user.
If you create a parameter list and then reference it in the call to RUN_PRODUCT,
the form can pass text and data parameters to the Graphics product that represent
values for command line parameters, bind or lexical references, and named queries.
Parameters of type DATA_PARAMETER are pointers to record groups in Oracle Forms.
You can pass DATA_PARAMETERs to Graphics, but not to Oracle Forms.
To run a report from within a form, you must use the dedicated report integration
Built-in RUN_REPORT_OBJECT .
Syntax
PROCEDURE RUN_PRODUCT
(product NUMBER,
module VARCHAR2,
commmode NUMBER,
execmode NUMBER,
location NUMBER,
paramlist_id PARAMLIST,
display VARCHAR2);
PROCEDURE RUN_PRODUCT
(product NUMBER,
module VARCHAR2,
commmode NUMBER,
execmode NUMBER,
location NUMBER,
paramlist_name VARCHAR2,
display VARCHAR2);
Built-in Type unrestricted procedure
Enter Query Mode yes
Parameters
- product
-
- Can specify GRAPHICS only.
-
- module
-
- Specifies the VARCHAR2 name of the module or module to be executed by Graphics.
Valid value is the name of a Graphics display. The application looks for the
module or module in the default paths defined for Graphics.
-
- commmode
-
- Specifies the communication mode to be used when running Graphics. Valid
numeric constants for this parameter are:
SYNCHRONOUS
- specifies that control returns to Oracle Forms only after Graphics has
been exited. The end user cannot work in the form while Graphics is running.
ASYNCHRONOUS
- specifies that control returns to the calling application immediately, even
if Graphics has not completed its display.
-
- execmode
-
- Specifies the execution mode to be used when running Graphics. Valid numeric
constants for this parameter are BATCH and RUNTIME. When you run Graphics,
execmode can be either BATCH or RUNTIME.
-
- location
-
- Specifies the location of the module or module you want Graphics to execute,
either the file system or the database. Valid constants for this property
are FILESYSTEM and DB.
-
- Paramlist_name or paramlist_ID
-
- Specifies the parameter list to be passed to Graphics. Valid values for
this parameter are the VARCHAR2 name of the parameter list, the ID of the
parameter list, or a null string (''). To specify a parameter list ID, use
a variable of type PARAMLIST.
You can pass text parameters to called products in both SYNCHRONOUS and ASYNCHRONOUS
mode. However, parameter lists that contain parameters of type DATA_PARAMETER
(pointers to record groups) can only be passed to Graphics in SYNCHRONOUS
mode. (SYNCHRONOUS mode is required when invoking Graphics to return an Graphics
display that will be displayed in a form chart item.)
Note: You can prevent Graphics from logging on by passing
a parameter list that includes a parameter with key set to LOGON
and value set to NO.
- display
-
- Specifies the VARCHAR2 name of the Oracle Forms chart item that will
contain the display (such as a pie chart, bar chart, or graph) generated by
Graphics. The name of the chart item must be specified in the format block_name.item_name.
(This parameter is only required when you are using a Graphics chart item
in a form.)