This
function is only supported for the Java client. |
Description
|
Loads records from any widget (list, form)
|
Input parameter
|
cpEntNam
cpTypNam
string |
Name of type ("" if no type). |
cpMasNam
string |
Name of list
- "widgetName" - Widget to open. If parameter cpAseUseCase
has a value then this widget is used to select a record. The Heterogeneous
Structure Explosion widget is then opened.
- "NOLIST" - No widget should be opened.
|
cpWdgExt
string |
List extension
- off - Use list as it is
- on - Add system fields to list (wdh_ext_lis)
|
cpWdgMod
string |
Widget mode
- list - Mask is of type list
- form - Mask is of type form
- bvb - Opened mask type depends on BVB default settings
|
cpActMod
string |
Action mode
- int - Interactive mode
- bat - Batch mode
|
cpAseUseCase
string |
Heterogeneous Structure Explosion widget data
- "" - No Heterogeneous Structure Explosion widget is
opened
- "useCaseName" - Heterogeneous Structure Explosion
widget for first selected record (parameter cpSelVal) is opened
using use case "useCaseName" (only in interactive mode)
|
cpWdgRemain
string |
Widget remain flag
- off - Close widget at the end of function
- on - Leave widget open and use it for following calls
|
cpResFlag
string |
Reservation flag
- off - All selected records are loaded
- on - Records will be reserved and loaded. If a record is already
reserved by another user, an error code is returned
- noask - Records will be reserved and loaded. Already reserved
records are loaded, too
- ask - Records will be reserved and loaded. For already reserved
records the user is asked to load the record (only in interactive
mode)
- stay - Records will be reserved and loaded. For already reserved
records the user has to select different records or terminate
the function (only in interactive mode)
|
cpaSelFld
stringlist |
Names of fields to select. |
cpaSelVal
stringlist |
Values of fields to select. If parameter "cpAseUseCase"
has a value then selection must result in one record. If no record
is found then function is canceled. If more than one record is found
then the first record is used for Heterogeneous Structure Explosion
widget. |
cpaChkFld
stringlist |
Names of fields to check. In interactive mode the check
fields are used to check the selection of the user. |
cpaChkVal
stringlist |
Values of fields to check. |
cpRetChk
string |
Return check flag:
- off - No return check is done.
- E - Checks that function returned from widget is of the same
entity or from type/relation widget with entity2 = cpEntNam.
- T - Check that function returned from widget is of the same
type.
- ET - Combination of check from E and T.
|
cpMasLimit
string |
Mask limit flag
- on - Mask limit of mask definition is valid.
- off - Increase mask limit to found records.
|
cpaRetFlds
stringlist |
Return fields (% if all fields should be returned) |
cpQuickLoad
stringlist |
Quickload parameters (four parts):
- CAX creation system name: e.g. PRO/E
- Logic type: "NORMAL" or "PROE"
- Perform structure: "Y" or "N"
- BOM function: "" or "DFM_LOCAL"
If CAX creation system name is empty ("") then no quickload
is called.
|
|
Output
parameter
|
caNum
string |
Number of selected records.
|
cpListPar
stringlist |
List parameter (from which widget it returns):
- Widget type: L, F, ASE
- Entity1 name
- Entity2 name, or "" if it is not a relation widget
- View name, or "" if it is not a relation widget
- Type name, or "" if it is not a type widget
- List name
|
cpRetNum
string |
Number of return fields. |
cpaRetFld
stringlist |
Name of return fields. |
retFldVal_1
stringlist |
Values of return fields of first record. |
...
retFldVal_n
stringlist |
Values of return fields of last record in block. |
cpQuickLoad_1
stringlist |
Quickload result for first selected record:
- Return code of xfile_loa_cax_str.
- Return code of stored procedure.
- Structure ID for entries in temporary tables.
- Number of file records.
- Number of structure records.
|
...
cpQuickLoad_n
stringlist |
Quickload result for last record in block. |
|
|
QuickLoad
is optional. |
cpQuickLoad
stringlist |
Quickload parameters (four parts):
- CAX creation system name: e.g. PRO/E
- Logic type: "NORMAL" or "PROE"
- Perform structure: "Y" or "N"
- BOM function: "" or "DFM_LOCAL"
If
the CAX creation system name is empty ("") then no quickload
is called.
|
|
For
the heterogeneous structure explosion widget the following limitation are
currently still valid:
- Only interactive mode
- DFM is not supported yet (configuration parameter EDB-DFM-ACTIVE)
- Widget remain flag is not supported yet
- Reservation flag is not supported yet
- Check fields are not supported yet
- The quickload is called only for selected document records
Sample: Open document DRW-000000 in an Heterogeneous
Structure Explosion widget and load data.
Name |
Value |
cpEntNam |
EDB-DOCUMENT |
cpTypNam |
Drawing |
cpMasNam |
EDB-DOC-DRW-TLI |
cpMasExt |
off |
cpWdgMod |
list |
cpActMod |
int |
cpAseUseCase |
ASE-USECASE-COPY-DOCUMENT |
cpWdgRemain |
off |
cpResFlag |
off |
cpaSelFld |
T_DOC_DAT.DOCUMENT_ID |
cpaSelVal |
DRW-000000 |
cpaChkFld |
|
cpaChkVal |
|
cpRetChk |
off |
cpMasLimit |
off |
cpaRetFlds |
% |
cpQuickLoad |
PRO/E |
cpQuickLoad |
PRO/E |
qpQuickLoad |
Y |
cpQuickLoad |
DFM_LOCAL |
|