Functions | |
int | bvb_uti_srt_lst () |
This userexit sorts records in the list-mask. More... | |
int | dal_mdl_wdg_opn () |
Userexit to open a modal widget from LogiView. More... | |
DtvLong | dal_wdg_map_vir () |
Maps a widget that has been created in virtual mode. More... | |
int | dal_wdg_rfr_cli () |
Refreshes a widget on client side. More... | |
int | edb_ief_get_dat_men () |
This userexit reads in the data of a file according to a default format. More... | |
int | edb_ief_put_dat_men () |
This userexit writes data from a widget to a file in a predefined format. More... | |
int | mas_set_mlf_fld () |
Sets the multi-language flag of a field. More... | |
int | nsv_usx_ren_pnr () |
No-select menu userexit to set the position numbers of all records in the current list. More... | |
int | sig_sel_key () |
Writes a selection string into the given field to get all records of a matching search string. More... | |
int | xapp_upd () |
No-select menu userexit to update the cached information. More... | |
int | xase_cre_tab_vie (const char *param, const char *ignore) |
More... | |
int | xase_is_ase_wdg (const char *param, const char *ignore) |
More... | |
int | xatt_set_vis (const char *param, const char *ignore) |
More... | |
int | xcfg_get_flg (const char *param, const char *ignore) |
More... | |
int | xcfg_set_flg (const char *param, const char *ignore) |
More... | |
int | xchg_cfg_reload (const char *param, const char *ignore) |
More... | |
int | xchg_sel_ord_set (const char *param, const char *ignore) |
More... | |
int | xcls_ins_set_att (const char *param, const char *ignore) |
More... | |
int | xcps_cls_new_cmp (const char *param, const char *ignore) |
More... | |
int | xcps_prl_mdl_bom_sel (const char *param, const char *ignore) |
More... | |
int | xcps_sol_item_show (const char *param, const char *ignore) |
More... | |
int | xctx_app_mas_tit (const char *param, const char *ignore) |
More... | |
int | xedb_edit () |
Starts editor for the passed file. More... | |
int | xedb_inf_vie () |
Displays the current view in the client's message window. More... | |
int | xedb_ins_slv () |
Inserts a slave record into the structure list of the document widget. More... | |
int | xedb_iwf_frm_ent () |
No-select menu userexit. More... | |
int | xedb_set_vie () |
Sets current view of PLM. More... | |
int | xedb_usr_inf () |
No-select menu userexit. More... | |
int | xedbch_lng_mod_act () |
Dummy userexit. More... | |
int | xform_call_dlg () |
Opens the existing dialog form with a sublist. More... | |
int | xform_call_frm () |
Opens the form and displays it on the screen. More... | |
int | xgroup_lis (const char *param, const char *ignore) |
More... | |
int | xinfo_open () |
No-select menu userexit to open a list widget to display status information. More... | |
int | xknl_chg_itm_ref (const char *param, const char *ignore) |
More... | |
int | xntm_edt_os () |
Note manager userexit to edit records with an operating system specific editor. More... | |
int | xpdw_auth_pro_sel (const char *param, const char *ignore) |
More... | |
int | xpdw_auto (const char *param, const char *ignore) |
More... | |
int | xpdw_cln_vie (const char *param, const char *ignore) |
More... | |
int | xpdw_ksa_lis_agg (const char *param, const char *ignore) |
More... | |
int | xpdw_ksa_lis_ref (const char *param, const char *ignore) |
More... | |
int | xpdw_ksa_vie_dwn (const char *param, const char *ignore) |
More... | |
int | xpdw_ksa_vie_hom (const char *param, const char *ignore) |
More... | |
int | xpdw_ksa_vie_up (const char *param, const char *ignore) |
More... | |
int | xpdw_ppj_mas (const char *param, const char *ignore) |
More... | |
int | xpdw_pro_dis_mas (const char *param, const char *ignore) |
More... | |
int | xprm_reload (const char *param, const char *ignore) |
More... | |
int | xprt_sel () |
Creates printer menus. More... | |
int | xpvm_bat_exi (const char *param, const char *ignore) |
More... | |
int | xpvm_cal_emp_vie (const char *param, const char *ignore) |
More... | |
int | xpvm_cre_dat_usx (const char *param, const char *ignore) |
More... | |
int | xpvm_get_fil_cid_snap_usx (const char *param, const char *ignore) |
More... | |
int | xpvm_opn_msk (const char *param, const char *ignore) |
More... | |
int | xpvm_rld_prp_map (const char *param, const char *ignore) |
More... | |
int | xqry_cnd_loa () |
'condition mask', which were saved by the user under a logical name. More... | |
int | xqry_dat_get_rec () |
Displays the records which were stored under a logical name in the current widget. More... | |
int | xqry_str_opn_mas () |
Menu userexit to open 'EDB-QRY-STR-SLI' or user given list and write the origin mask as query criteria mask in the field T_QRY_DAT.QRY_MAS and the current user in the field T_QRY_DAT.USER. More... | |
int | xrole_get_cfg () |
Reads value of configuration parameter EDB-ROL-ACTIVE. More... | |
int | xsml_hlp_ken () |
No-select menu userexit to open the help file or the list with attributes descriptions for a classification list. More... | |
int | xsmlc_cnt_lis () |
No-select menu userexit to count entries in the classification lists for classes of type ATC. More... | |
int | xstate_ret_show_prl (const char *param, const char *ignore) |
More... | |
int | xstate_set_show_prl (const char *param, const char *ignore) |
More... | |
int | xtask_free () |
Deletes the cache of the role concept. More... | |
int | xtxt_ctg_tak_ent_men (const char *param, const char *ignore) |
More... | |
int | xtxt_whr_use_rsh_men (const char *param, const char *ignore) |
More... | |
int | xtxt_whr_use_up2_men (const char *param, const char *ignore) |
More... | |
int | xutil_dbl_sql_sbg (const char *param, const char *ignore) |
More... | |
int | xutil_del_all_wdg (const char *param, const char *ignore) |
More... | |
int | xutil_ebl_sql_sbg (const char *param, const char *ignore) |
More... | |
int | xutil_frm_lis (const char *param, const char *ignore) |
More... | |
int | xutil_rst_acc_fld (const char *param, const char *ignore) |
More... | |
int | xwfl_prc_ins_adhoc () |
Menu userexit to create an ad hoc process. More... | |
int | xwfl_prc_ins_tpl () |
Menu userexit to copy a process from a template. More... | |
int | xwfl_process_xml () |
Menu userexit that is called when a xml definition has to be executed by the workflow engine. More... | |
int | xwfl_workitem_complete_i18n () |
Menu userexit that is called when a work item is completed. More... | |
int | zag_dlg_iwf_frm_ent () |
Select menu userexit for lists to display the selected records in opened form. More... | |
int | zag_dlg_usr_inf () |
Opens form and displays information about current user. More... | |
int | zag_fli_edit () |
Starts editor for passed file. More... | |
int | zag_tst_box () |
Starts a dialog box for module traces. More... | |
int | zag_tst_ctr () |
Defines type and complexity of the test output. More... | |
int bvb_uti_srt_lst | ( | ) |
This userexit sorts records in the list-mask.
The sort criteria is the ascending or descending function parameter fields.
cp_par | Parameter string of the field names used for sorting. Syntax is: "field_a{+-} [field_b{+-}...]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int dal_mdl_wdg_opn | ( | ) |
Userexit to open a modal widget from LogiView.
The widget will become modal by calling iwf_cls_edt
and iwf_ins_elm/iwf_dup_lis/iwf_edt_lis
. It has to be closed by calling widget_close
after the modal dialog is finished.
In case of the Java or Web client, the client communication is locked and the widget is opened on server side. It will be mapped as a modal widget on client side after iwf_cls_edt
by iwf_ins_elm/dup_elm/edt_lis
.
cpArguments | Additional argument string. Syntax is: "<userexit> [/PAR=<parameter>]" With possible arguments:
|
0 | OK |
---|---|
Else | Unable to create the widget |
DtvLong dal_wdg_map_vir | ( | ) |
Maps a widget that has been created in virtual mode.
For the Java and Web client, the widget is mapped on the client and set as the current widget.
cpArguments | Argument string. Syntax is: "<widget>" With possible arguments:
|
0 | OK |
---|---|
1 | Problems on client side |
2 | Virtual mode active |
3 | Widget invalid |
int dal_wdg_rfr_cli | ( | ) |
Refreshes a widget on client side.
Instructs the client to refresh the content of a widget.
In case of the Java or Web client, a refreshWidget
callback is executed, otherwise, nothing happens.
This userexit should be used if a server side code modifies a widget, but the client does not get this modification automatically.
This can happen if, for instance, a select or no-select menu userexit modifies a widget other than the one it has been called for.
cpArguments | Additional argument string. Syntax is: "<widget> [/ROW=<val>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
EP_INT
in the current widget. When using this userexit within LogiView to refresh a parent mask it is only possible to execute it in insert or update mode. Following code example shows the syntax:
int edb_ief_get_dat_men | ( | ) |
This userexit reads in the data of a file according to a default format.
It can be called from any menu.
par | Parameter to control the behavior of this function. Syntax like: "<File symbol> <Format name> <Format version> [/<Option>=<Value>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int edb_ief_put_dat_men | ( | ) |
This userexit writes data from a widget to a file in a predefined format.
It can either be called up in the selection menu or the non-selection menu. For selection menus, the selected data records are transferred while for non-selection menus all data records of the mask are transferred.
par | Parameter to control the behavior of this function. Syntax like: "<File symbol> <Format name> <Format version> <Resolution> [/<Option>=<value>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int mas_set_mlf_fld | ( | ) |
Sets the multi-language flag of a field.
Can be used, for instance, by pre-mask userexits to set a calculatory field to multi-lingual, which is needed to support I18N content in calculatory fields.
The field name must have the suffix of the desired language, because DataView uses the last three characters of the field name to determine the language of the field.
This userexit only calls mas_ret_mas
to get the mask handle, so the mask needs to be created before calling mas_set_mlf_fld
.
cpPar | Arguments for this userexit. Syntax is: "<flag> /MASK=<mask> /FIELD=field" With possible arguments:
|
0 | OK |
---|---|
1 | Illegal arguments |
2 | Mask not found by mas_ret_mas |
3 | Field not found by mas_ret_fld |
int nsv_usx_ren_pnr | ( | ) |
No-select menu userexit to set the position numbers of all records in the current list.
This userexit is useful if further records have been added and the position numbers shall be renumbered.
cp_Arguments | Parameter to control the behavior of this function. Syntax like: "FIELD_NAME [/STEP=n]" With possible arguments:
|
0 | OK |
---|---|
1 | Position field is not present |
This userexit will not affect any records that are not in the list (e.g. the last query fills the list with the valid items only). The current order of the records in the list is determined by their position number, and not by the old value of the position number! The argument /ALL does not affect this function (it is used by nsv_usx_ren_row).
int sig_sel_key | ( | ) |
Writes a selection string into the given field to get all records of a matching search string.
cpPar | Parameter to control the behaviour of this function. Syntax like: "/USAGE=type" with possible arguments:
| |||
cpIgn | not used |
0 | on |
---|---|
1 | off |
int xapp_upd | ( | void | ) |
No-select menu userexit to update the cached information.
This userexit can be called from the no-select menu EDB-APP-SLI.
If new applications/commands are inserted into the list of external applications, this userexit is used to publish the new entries within the external application module.
0 | Table of external applications updated |
---|---|
Else | Error |
int xase_cre_tab_vie | ( | const char * | param, |
const char * | ignore | ||
) |
Creates temporary table and view for all heterogeneous structure use cases.
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_is_ase_wdg | ( | const char * | param, |
const char * | ignore | ||
) |
Checks if current widget is an heterogeneous structure widget.
usxCtx | Menu userexit context. |
param | Reserved. |
0 | Widget is no heterogeneous structure widget |
---|---|
1 | Widget is an heterogeneous structure widget |
int xatt_set_vis | ( | const char * | param, |
const char * | ignore | ||
) |
No-Sel Menu/Button userexit for classification list to control class attributes visibility in classification lists. It opens a setting list with attribute sets assigned to the class. This attribute sets can be to be set visible/invisible. If the OK button is clicked, then the new settings will be applicated immediately to the current opened classification list (the new visible/invisible attribute fields will appear/disappear in/from the classification list).
context | Userexit context. |
param | parameter of menu userexit, not used yet |
0 | OK | |
---|---|---|
Else | Error | It throws a pdm exception if classification list has no father element |
int xcfg_get_flg | ( | const char * | param, |
const char * | ignore | ||
) |
Retrieve a boolean configuration parameter.
aContext | Menu userexit context |
param | Parameter to control the behavior of this function. Syntax like: "parameterName" |
-1 | configuration parameter is not defined or invalid |
---|---|
0 | configuration parameter is false |
1 | configuration parameter is true |
int xcfg_set_flg | ( | const char * | param, |
const char * | ignore | ||
) |
Temporarily define a boolean configuration parameter.
The provided value precedes any value stored in the database.
aContext | Menu userexit context |
param | Parameter to control the behavior of this function. Syntax like: "parameterName /VALUE={true|false}" if /VALUE is invalid, the parameter is set to false. |
int xchg_cfg_reload | ( | const char * | param, |
const char * | ignore | ||
) |
Updates the Change Management configuration cache.
Reads the Change Management configuration data from the database and reloads the cache so intermediate changes for the Change Management configuration are valid.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|
int xchg_sel_ord_set | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to choose and set the default Work Order and Work Request for the next and all subsequent change operations.
This userexit is usually used for (tool-)button menus. In the interactive mode the modal dialog 'EDB-EWO-SET-SEL-SFR' is displayed and the user can interactively choose the Work Order and Work Request.
context | Context of this userexit | ||||||
param | Parameter to control the behavior of this function. Syntax like: "[/WORKSETMANDATORY][/WORKORDERMANDATORY]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xcls_ins_set_att | ( | const char * | param, |
const char * | ignore | ||
) |
No select button/menu userexit to assign class set attributes to a class. If one of the existent attribute sets is chosen, all attributes assigned to this set and not yet assigned to a class, will be inserted in the class attributes list. The mask remains in edit mode, so the user can decide all of them should be stored or some of them should be deleted.
cpArguments | Reserved userexit parameter, not yet used. |
0 | Success | Else | Error |
---|
int xcps_cls_new_cmp | ( | const char * | param, |
const char * | ignore | ||
) |
No-select menu userexit for product component - classification relation. Creates a new product component and assigns it to the current class.
This userexit can be called from the no-select menu of the relation widget between a class and a product component (usually available as folder on the combined form for classes). It opens a modal widget to create a new product component where the EDB_ID of the product component is automatically set from the number server and the name of the component is preset to the name of the class.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_prl_mdl_bom_sel | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit for parallel structure - product component widgets. Opens ModularBom for product component which is assigned to the top level parallel structure record.
context | Menu userexit context | |||
param | Parameter to control the behavior of this function. Syntax is: "[/LIST]" With possible arguments:
|
0 | OK |
---|
int xcps_sol_item_show | ( | const char * | param, |
const char * | ignore | ||
) |
No-select menu userexit for the item selector. Shows all available classified items.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xctx_app_mas_tit | ( | const char * | param, |
const char * | ignore | ||
) |
Appends the name of the context with passed ID to the current mask title.
ctx | Menu userexit context. | ||
param | Parameter to control the behavior of this function. Syntax is: "<contextId>" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xedb_edit | ( | ) |
Starts editor for the passed file.
nam | Complete name (including path) of the file to be edited. |
0 | OK |
---|---|
1 | Error |
int xedb_inf_vie | ( | ) |
Displays the current view in the client's message window.
0 | Ok |
---|
int xedb_ins_slv | ( | ) |
Inserts a slave record into the structure list of the document widget.
cp_parameter | Parameter to control the behavior of this function. Syntax is: "<entityname> [/T=<typname>][/F=<fieldname>]" With possible arguments:
|
0 | OK |
---|---|
1 | Wrong parameter syntax/value |
int xedb_iwf_frm_ent | ( | ) |
No-select menu userexit.
cp_par | Parameter to control the behavior of this function. Syntax is: "<entityname> [<formname>]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xedb_set_vie | ( | ) |
Sets current view of PLM.
Possible values:
Id | View | View filter |
---|---|---|
1 | Production | Date as set by user, current flag is not considered. |
2 | Development | Current date, current flag = "y" |
3 | Global | Independent of date and current flag |
4 | Not yet ineffective | Similar to Production, but filter will only be set to "valid until" date and preliminary flag. |
cp_Parameter | Parameter to control the behavior of this function. Syntax is: "<view> [<prod_date>]" With possible arguments:
|
0 | Ok |
---|
int xedb_usr_inf | ( | ) |
No-select menu userexit.
0 | OK |
---|
int xedbch_lng_mod_act | ( | ) |
int xform_call_dlg | ( | ) |
Opens the existing dialog form with a sublist.
Menu function which opens the existing dialog form with the passed sublists and sets the form in edit mode if option "INSERT" or "UPDATE" is passed. If the calculate field 'TEXT' does not exist in the form, this userexit will automatically add the field. The passed text (option /TEXT) will be written into this field.
cp_Arguments | Parameter to control the behavior of this function. Syntax is: "form /INSERT=list1[,list2[,...]] /UPDATE=list1[,...] /SELECT=list1[,...] /TEXT=text" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xform_call_frm | ( | ) |
Opens the form and displays it on the screen.
cp_Form | Parameter to control the behavior of this function. Syntax is: "form_name" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
-1 | Event loop has been cancelled. |
int xgroup_lis | ( | const char * | param, |
const char * | ignore | ||
) |
No select menu userexit to open the classification list for the selected classification group. The list which is used to display the records depends on if the selected classification group is a container class and it depends on the options provided in the userexit parameter. The userexit parameters are only evaluated for classification groups of type "ATT"(default type).
cpPar | Parameter to control the behavior of this function. Syntax is: "[/FRM] [/MASK=<list_or_form>] [/SUBLIS=<list>][/ABSTR_MASK=<list>] [/ABSTR_SUBLIS=<list>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error ( return code of 'iwf_typ_lis'/'iwf_frm_lis) |
public select-menu
int xinfo_open | ( | ) |
No-select menu userexit to open a list widget to display status information.
cp_List | Parameter to control the behavior of this function. Syntax like: "<listname>" With possible arguments:
|
0 | OK |
---|---|
1 | Unable to open list |
2 | List has already been opened |
int xknl_chg_itm_ref | ( | const char * | param, |
const char * | ignore | ||
) |
Opens a select widget of item master (bvb_artikel) to assign a new item master to an item revision.
cp_par | Parameter, syntax like: |
0 | OK |
---|---|
Else | Error |
int xntm_edt_os | ( | ) |
Note manager userexit to edit records with an operating system specific editor.
No-select menu userexit to write the desired column of all records of a list to a temporary file and work on them with an operating system specific editor. The parameter contains the field whose content is to be edited in a temporary file by an external editor. Moreover it could contain the optional character (flags) 'I' or 'D' to indicate whether there should be new records created or unnecessary records deleted.
cp_par | Parameter to control the behavior of this function. Syntax like: "fieldname [ '-' ['I'] ['D'] ] [/CLIENT]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xpdw_auth_pro_sel | ( | const char * | param, |
const char * | ignore | ||
) |
Called as menu selection userexit when selection in the radio button menu on the job selection form is changed. Re-Creates the job selection menu in the job selection mask. Depending on the parameter, the menu contains all jobs which are currently assigned to the user (parameter="ASSIGNED"), or only those jobs which are restricted by a principal (project or organization) which is set by the user to be displayed (parameter = "DISPLAY").
ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax is: "DISPLAY|ASSIGNED" with possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_auto | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to authorize a user to work with a certain principal (project or organizational unit).
EDB-ROLE-ACTIVE
to "3" for multi project access or to "4" for multi organization access.ctx | The userexit context. | ||||||||||||
param | Parameter to control the behavior of this userexit. Syntax is: "LOGIN|SESSION|NEWSESSION|BATCH" With possible arguments:
|
0 | OK |
---|---|
PDW_ERR_DTV | Internal error in DataView function. |
PDW_ERR_DFL | Error while storing default values. |
PDW_ERR_FRM | Form EDB-JOB-VAL-SFR or fields do not exist. |
PDW_INI_ROL | Error during initialization of role. |
PDW_NO_JOB | No jobs for user found. |
PDW_USR_ABO | User clicked on ABORT button. |
int xpdw_cln_vie | ( | const char * | param, |
const char * | ignore | ||
) |
Corrects entries in the PDW tables for all projects or organizational units. The tolerance is corrected for all objects starting from specified entity by calling PL/SQL procedure "MOA_MPA.cleanup_views".
ctx | The userexit context. | |||||||||||||||
param | Parameter to control the behavior of this userexit. Syntax: "[/ENT=<start_entity>] [/LOG_LEVEL=<log_level>]"
|
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_lis_agg | ( | const char * | param, |
const char * | ignore | ||
) |
Opens an aggregate list in global view. The global multi access rights view is activated and deactivated by calling xpdw_vie_out
and xpdw_vie_on
.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax like: "iwf_lis-parameters" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_lis_ref | ( | const char * | param, |
const char * | ignore | ||
) |
Opens a refine list in global view. The global multi access rights view is activated and deactivated by calling xpdw_vie_out
and xpdw_vie_on
.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax like: "iwf_lis-parameters" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_vie_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Limits the multi project access rights view to one sub project.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax like: "[listName]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_vie_hom | ( | const char * | param, |
const char * | ignore | ||
) |
Extends the multi project access rights view to the start project.
ctx | The userexit context. |
param | Additional userexit parameters. Currently none. |
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_vie_up | ( | const char * | param, |
const char * | ignore | ||
) |
Extends the multi project access rights view to the super project.
ctx | The userexit context. |
param | Additional userexit parameters. Currently none. |
0 | OK |
---|---|
1 | Error |
int xpdw_ppj_mas | ( | const char * | param, |
const char * | ignore | ||
) |
Opens the list of the template projects. This function may only be called for project specific jobs.
usxContext | The userexit context. | |||
param | Parameter to control the behavior of this userexit. Syntax is: "[maskName]" With possible arguments:
|
0 | OK |
---|---|
PDW_NO_PPJ_JOB (757) | No project specific job. |
int xpdw_pro_dis_mas | ( | const char * | param, |
const char * | ignore | ||
) |
Opens a mask to allow the user to choose the projects or organizations to display. Can be called as menu userexit.
ctx | The userexit context. |
param | Reserved. |
0 | OK |
---|---|
Else | Error |
int xprm_reload | ( | const char * | param, |
const char * | ignore | ||
) |
No-select-menu userexit to reload the permission manager cache.
usxCtx | The userexit context. |
param | Parameter to control the behavior of this userexit. Not currently used. |
0 | OK |
---|---|
Else | Error |
int xprt_sel | ( | ) |
int xpvm_bat_exi | ( | const char * | param, |
const char * | ignore | ||
) |
Stops the batch job. The method sets the default value "EDB-PVM-BATCH-<site>" to "STOP".
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_cal_emp_vie | ( | const char * | param, |
const char * | ignore | ||
) |
Userexit to start an Autovue viewer without any file loaded.
context | The context of the userexit |
param | Not used at the moment. |
0 | OK |
---|---|
1 | Error |
int xpvm_cre_dat_usx | ( | const char * | param, |
const char * | ignore | ||
) |
Create the viewer data for client.
context | not used |
param | input parameter, string of T_DOC_DAT.C_ID and T_FILE_DAT.CID |
int xpvm_get_fil_cid_snap_usx | ( | const char * | param, |
const char * | ignore | ||
) |
Gets snapshot base file cid.
usxContext | The userexit context. | ||||
param | Parameter to control the behavior of this function. Syntax is: "/DOC=DocCid /SNAPSHOT=SnpEDBID"
|
int xpvm_opn_msk | ( | const char * | param, |
const char * | ignore | ||
) |
Opens a mask, search a field, add the value into the field in query mode and refresh the mask. If only entity is given the default mask is opened empty. If only entity and mask is given the specified mask is opened empty. If only entity and mask and field is given the specified mask is opened empty. If all parameters are specified and no record can be found for the specified value the specified mask is opened empty. Refresh force a mask refresh even if mask, field and value is missing. The error message about missing mask, field and value parameter is supressed if refresh parameter is set.
context | The context of the userexit |
param | Parameter to control the behaviour of this function. Syntax like: "/ENTITY=<entity-name> /MASK=<mask-name> /FIELD=<field-name> /VALUE=<field-value> /REFRESH" |
0 | OK |
---|---|
1 | Error |
IllegalArgumentException | in case parameter entity is missing. |
int xpvm_rld_prp_map | ( | const char * | param, |
const char * | ignore | ||
) |
Deletes the current property mappings.
context | The context of the userexit |
param | Not used at the moment. |
0 | OK |
---|---|
1 | Error |
int xqry_cnd_loa | ( | ) |
'condition mask', which were saved by the user under a logical name.
After query conditions are saved, these can be loaded in the query form by choosing the query from a select menu.
cp_Par | Parameter to control the behavior of this userexit - (Reserved). |
0 | OK |
---|---|
Else | Error |
int xqry_dat_get_rec | ( | ) |
Displays the records which were stored under a logical name in the current widget.
If records are stored from the current widget, then the user can choose the respective logical name from a select menu with all existent logical names for this widget.
cp_Parameter | Parameter to control the behavior of this userexit - (Reserved). |
0 | OK |
---|---|
1 | Error |
int xqry_str_opn_mas | ( | ) |
Menu userexit to open 'EDB-QRY-STR-SLI' or user given list and write the origin mask as query criteria mask in the field T_QRY_DAT.QRY_MAS and the current user in the field T_QRY_DAT.USER.
cp_Parameter | Parameter used to open an user defined query list: "EDB-QUERY listname". Default value for the listname is EDB-QRY-STR-SLI. |
0 | OK |
---|---|
Else | Error |
int xrole_get_cfg | ( | ) |
Reads value of configuration parameter EDB-ROL-ACTIVE.
cpParam | Reserved. |
cpArgument | Reserved. |
0 | Roles are not activated. |
---|---|
1 | Roles are activated (all jobs are used). |
2 | Roles are activated (user has to select one job / not supported yet). |
3 | Roles are activated (project driven working/one job). |
4 | Roles are activated (organization driven working/one job). |
int xsml_hlp_ken | ( | ) |
No-select menu userexit to open the help file or the list with attributes descriptions for a classification list.
cp_par |
|
0 | OK |
---|---|
Else | Error |
int xsmlc_cnt_lis | ( | ) |
No-select menu userexit to count entries in the classification lists for classes of type ATC.
/FRM=<Form> | If this parameter is given, then the given form will be used to count the records instead of current active forms. |
/LIS=<List> | List name to be used when the userexit is called from another form or list (e.g. "EDB-ART-CFR-S" or "EDB-ART-SMLC-RLI"). If parameter /FRM or /LIS is given, then the list or form name must be specified, otherwise the userexit will return error. |
>0 | Number of found records |
---|---|
-1 | No records were found |
int xstate_ret_show_prl | ( | const char * | param, |
const char * | ignore | ||
) |
true
) or not (false
). int xstate_set_show_prl | ( | const char * | param, |
const char * | ignore | ||
) |
Sets the 'Show Preliminary' flag to true or false.
isShowing | Value to set the 'isShowing' flag to. |
int xtask_free | ( | ) |
Deletes the cache of the role concept.
cpPar | Parameter to control the behavior of this function. Syntax is: "[/FORCE]" With possible arguments:
|
0 | OK |
---|---|
1 | Cannot create menu EDB-TSK-MEN |
int xtxt_ctg_tak_ent_men | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit at the modal glossary list EDB-TXT-GLS-CTG-QRY. Clears or fills the corresponding field of the widget, which opened the modal glossary list.
ctx | Field userexit context. | ||||
param | Parameter to control the behavior of this function. Syntax is: "/CLEAR /TAKE" With possible arguments:
|
0 | Ok. |
---|---|
Else | Error |
int xtxt_whr_use_rsh_men | ( | const char * | param, |
const char * | ignore | ||
) |
Refreshes the whole content of the Where-Used list. Works only in mode ACTION_QUERY. The information about the Where-Used root element are contained in the widget buffer:
WHERUSEDTYPE | Type of the Where-Used root element. |
---|---|
WHERUSEDTYPEEDBID | The EDB-ID of the Where-Used root element. |
ctx | Userexit context |
param | Parameter to control the behavior of this function. Reserved. |
0 | OK |
---|---|
Else | Error |
int xtxt_whr_use_up2_men | ( | const char * | param, |
const char * | ignore | ||
) |
Tries to update all Where-Used objects corresponding to a root-element. It is possible to update objects through 1-3 levels. This depends on the configuration. Regarding the configuration, the fields EDB_VALUE_1 (Object 1 Update Field), EDB_VALUE_2 (Object 2 Update Field), and EDB_VALUE_3 (Object 3 Update Field) contain the field (and therefore the object/value) which should be updated.
EDB_VALUE_x (Object x Update Field) | Contain the name of the field, which should be updated on level x. Depending on the status of the object and the status configuration (for level x). The states in which the object should be updatable are defined with the fields EDB_IN_WORKx (IW), EDB_APPROVEDx (AP), EDB_RELEASEDx (RL), EDB_REVISIONINGx (RV). |
---|
In addition, the state of the updatable object has to be checked (except the parameter /IGNORE_STATE is set), therefore, the following entries in the Where-Used configuration have to be taken into account (the x stands for the level 1,2,3):
EDB_IN_WORKx (IW) | Value = 'y', is the object of level x (EDB_Value_1 (Object x Update Field)) in state "In Work" then proceed updating! |
---|---|
EDB_APPROVEDx (AP) | Value = 'y', is the object of level x (EDB_Value_1 (Object x Update Field)) in state "Approved" then proceed updating! |
EDB_RELEASEDx (RL) | Value = 'y', is the object of level x (EDB_Value_1 (Object x Update Field)) in state "Released" then proceed updating! |
EDB_REVISIONINGx (RV) | Value = 'y', is the object of level x (EDB_Value_1 (Object x Update Field)) in state "Revisioning" then proceed updating! |
If one state is set to '' the object has no state (no LEV_IND) | |
If all states are set to '' ==> the check for the state of the corresponding updatable object is ignored. | |
If all states are set to 'n' a error message "No state set for object_x -> CID:'CID of object' Table:'table name of object'" occurs! |
The lifecycle of the object is identified by the table name of the updatable object (first part of the EDB_VALUx-content) and the CHK_NAME field. The current state of the object is identified by the table name (first part of the EDB_VALUx content) and the LEV_IND field. Therefore, the updatable mechanism is able to check if the selected state in the Where-Used configuration (IW, AP, RL, RV) regarding the lifecycle name of the current object and the current state value of the object matches. If it matches, the update will proceed, otherwise, an "Object_x is NOT in correct state -> Table:'object-table' CID:'object-C_ID'" occurs and the whole transaction is rolled back.
ctx | Userexit context | ||||
param | Parameter to control the behavior of this function. Syntax is: "/IGNORE_STATE /STRICT" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xutil_dbl_sql_sbg | ( | const char * | param, |
const char * | ignore | ||
) |
Disables PL/SQL-Debug.
context | Menu userexit context | |||
cpParameter | Parameter to control the behavior of this function. Syntax like: "/DEBUGTOOL=debugToolName" With possible arguments:
|
0 | Success |
---|---|
1 | Error |
int xutil_del_all_wdg | ( | const char * | param, |
const char * | ignore | ||
) |
No-select menu userexit to close all mapped widgets.
param | Reserved |
0 | OK |
---|
int xutil_ebl_sql_sbg | ( | const char * | param, |
const char * | ignore | ||
) |
Enables PL/SQL-Debug.
context | Menu userexit context | |||||||||
cpParameter | Parameter to control the behavior of this function. Syntax like: "/HOSTORIP=hostnameOrIpAddress /PORT=listenerPort /DEBUGTOOL=debugToolName" With possible arguments:
|
0 | Success |
---|---|
1 | Error |
int xutil_frm_lis | ( | const char * | param, |
const char * | ignore | ||
) |
No select userexit for FormToList menu selection to open correspondent list to current form and show all selected records in form in the opened list. Activate this userexit by replacing the menu selection EDB-BAS-LIS List iwf_lis_ent EntityName with a new one e.g. EDB-FRM-LIS which has the user exit xutil_frm_list and parameter entityname
param | the entity name |
0 | OK |
---|
int xutil_rst_acc_fld | ( | const char * | param, |
const char * | ignore | ||
) |
Restores the field access changed by the post-field userexit xutil_acc_fld. For all mask fields in the widget it is checked whether the post-field userexit xutil_acc_fld is in the post-field userexit list. If xutil_acc_fld is found, then the field access is set to the original value it had before the post field changed it.
cpParameter | Parameter to control the behavior of this function. Syntax like: "ARG /OPT1=val1 /OPT2=val2" With possible arguments:
|
0 | Success |
---|---|
1 | Error |
int xwfl_prc_ins_adhoc | ( | ) |
Menu userexit to create an ad hoc process.
This userexit calls iwf_ins_elm().
cpPar | Default parameter (currently not used). |
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
int xwfl_prc_ins_tpl | ( | ) |
Menu userexit to copy a process from a template.
The mandatory part of the parameter is used to open a selection widget for process templates by calling iwf_lis_ent().
The parameter may contain an optional argument to specify the C_ID or the ID of the process template that shall be copied (batch call).
cpPar | Parameter to control the behavior of this function. Syntax like: "<arg> [/C_ID=<cid>] [/ACT_REF=<actref>]" With possible arguments:
| |||||||||
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
int xwfl_process_xml | ( | ) |
Menu userexit that is called when a xml definition has to be executed by the workflow engine.
The xml definition is collected via EP_WFL/processXML.
The parameter cpPar is used to extract a xml definition for the workflow engine. The syntax of this xml string is defined by EIGNER_WFL.xsd. The result is written into a second LogiView variable.
cpPar | : Specifies the xml definition and the success message. Syntax defined by EIGNER_WFL.xsd. |
cpIgn | : Second userexit parameter (ignored) |
0 | OK |
---|---|
1 | Error |
int xwfl_workitem_complete_i18n | ( | ) |
Menu userexit that is called when a work item is completed.
This method reads all fields and values in a XML structure like: <WORKITEM> <FIELDS> <FIELD name="TABLE_1.FIELD_1">VALUE_1</FIELD> <FIELD name="TABLE_2.FIELD_2">VALUE_2</FIELD> </FIELDS> </WORKITEM> and calls xwfl_workitem_complete to complete the work item.
cpPar | : Contains C_ID of current widget. |
cpIgn | : Second userexit parameter (ignored) |
0 | OK |
---|---|
1 | Error |
int zag_dlg_iwf_frm_ent | ( | ) |
Select menu userexit for lists to display the selected records in opened form.
cp_par | Parameter to control the behavior of this function. Syntax like: "<entityname> [<formname>]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int zag_dlg_usr_inf | ( | ) |
Opens form and displays information about current user.
0 | OK |
---|
int zag_fli_edit | ( | ) |
Starts editor for passed file.
No-select menu userexit to call a command procedure which starts an editor of the operating system to edit the passed file.
nam | Complete name (including path) of the file to be edited. |
0 | Success |
---|---|
1 | Error |
int zag_tst_box | ( | ) |
Starts a dialog box for module traces.
Starts a dialog box for module traces where user can select internal PDM modules that should be traced.
cpParameter | Name of menu to use (Default: EDB-BAS-ZAG-TST) |
0 | OK |
---|---|
1 | Error from zag_dlg_box. |
-1 | Dialog box creation error. |
2 | No selections for menu. |
3 | Not enough space. |
4 | Menu EDB-BAS-ZAG-TST does not exist. |
5 | No parameter for zag_tst_ctr. |
int zag_tst_ctr | ( | ) |
Defines type and complexity of the test output.
No-select menu userexit to define type and complexity of the test output which is implemented by calling the function 'zag_tst' in the program sequence. The passed parameter controls whether for example tracing is started or stopped and which module in which complexity should be traced.
cp_par | Parameter to control the behavior of this function. Syntax is: {ON/NORM | ON/CONT | /TIME | OFF | FLUSH | EPQ | INF | TESTmodul_level | DEFmodules} With possible arguments:
|
0 | OK |
---|