Functions | |
int | bvb_usx_cmb_rpl () |
Replaces the current folder in a combined mask with another folder. | |
int | bvb_usx_cns_frm_lis () |
Opens the combined mask corresponding to the passed name of the constraint. | |
int | bvb_usx_opn_agg () |
Opens the aggregate list or (combined) aggregate form. | |
int | bvb_usx_opn_ent () |
Opens the entity list or (combined) entity form. | |
int | bvb_usx_opn_ref () |
Opens the refine list or (combined) refine form. | |
int | bvb_usx_opn_typ () |
Opens the type list or (combined) type form. | |
int | bvb_usx_son_set_fat () |
Sets a selected record of the sublist as parent record of the combined mask. | |
static int | jcl_cre_url () |
This userexit creates a url to execute a pre-defined task. | |
int | sig_chg_pwd () |
Changes the password of the selected private key by using a password dialog. | |
int | sig_cre_sgn_men () |
Creates a digital signature of a data record. | |
int | sig_imp_cer () |
Imports a certificate file. | |
int | sig_imp_key () |
Imports a private key. | |
int | sig_imp_p12_cer () |
Imports a certificate from a private exchange file. | |
int | sig_imp_p12_key () |
Imports a private key from a private exchange file. | |
int | sig_loc_key () |
Locks the selected key record. | |
int | sig_set_tmp_pwd () |
Stores the temporary password of the given user into a temporary buffer. | |
int | sig_shw_cer () |
Shows the main data of a certificate in a form. | |
int | sig_shw_win_cer () |
Shows a certificate by using the Windows ActiveX component. | |
int | sig_unl_key () |
The userexit unlocks a locked key record. | |
int | sig_usr_pra () |
Selects the keys of the current user. | |
int | tol_select () |
Select-menu userexit to calculate fields of the current mask. | |
int | xartic_bom () |
Select-menu userexit to open the list containing child items for the currently selected item. | |
int | xartic_var_agg () |
Select-menu userexit to open variant list for selected item. | |
int | xase_cfg_brw (const char *param, const char *ignore) |
| |
int | xase_cfg_ent (const char *param, const char *ignore) |
| |
int | xase_cfg_fld (const char *param, const char *ignore) |
| |
int | xase_cre_tab_vie_sel (const char *param, const char *ignore) |
| |
int | xase_fil_tab (const char *param, const char *ignore) |
| |
int | xase_opn_frm (const char *param, const char *ignore) |
| |
int | xase_shw_hie (const char *param, const char *ignore) |
| |
int | xchg_asg_obj (const char *param, const char *ignore) |
| |
int | xchg_ask_nxt_sta (const char *param, const char *ignore) |
| |
int | xchg_det_aff_prd (const char *param, const char *ignore) |
| |
int | xchg_ewr_del (const char *param, const char *ignore) |
| |
int | xchg_ina_obj (const char *param, const char *ignore) |
| |
int | xchg_log_opr_und (const char *param, const char *ignore) |
| |
int | xchg_nxt_sta (const char *param, const char *ignore) |
| |
int | xchg_opn_crr_lis (const char *param, const char *ignore) |
| |
int | xchg_opr_del_obj (const char *param, const char *ignore) |
| |
int | xchg_opr_mov (const char *param, const char *ignore) |
| |
int | xchg_sel_ord (const char *param, const char *ignore) |
| |
int | xchg_set_cre_id (const char *param, const char *ignore) |
| |
int | xchg_upg_obj (const char *param, const char *ignore) |
| |
int | xcnf_ord_bom_del (const char *param, const char *ignore) |
| |
int | xcnf_ord_bom_exp (const char *param, const char *ignore) |
| |
int | xcol_cre_art_ntr (const char *param, const char *ignore) |
| |
int | xcopm_start_mmn () |
Copies elements of a path to a new revision or to a new number. | |
int | xcpa_cpy_ali (const char *param, const char *ignore) |
| |
int | xcpa_cpy_col_itm (const char *param, const char *ignore) |
| |
int | xcpa_set_default_men () |
Menu userexit to set the default (field C_DEFAULT) of the Alias IDs in the different CPA objects (for example T_CPA_ART_DAT or T_CPA_DOC_DAT). | |
int | xcps_cmp_opn_frm (const char *param, const char *ignore) |
| |
int | xcps_elm_tak (const char *param, const char *ignore) |
| |
int | xcps_flt_att_men_sel (const char *param, const char *ignore) |
| |
int | xcps_grp_cmp_rst_eff (const char *param, const char *ignore) |
| |
int | xcps_grp_cmp_set_eff (const char *param, const char *ignore) |
| |
int | xcps_grp_del_var_inf (const char *param, const char *ignore) |
| |
int | xcps_mdl_bom_shw (const char *param, const char *ignore) |
| |
int | xcps_mdl_cpy_elm (const char *param, const char *ignore) |
| |
int | xcps_mdl_dup_elm (const char *param, const char *ignore) |
| |
int | xcps_mdl_jmp_dwn (const char *param, const char *ignore) |
| |
int | xcps_mdl_jmp_up (const char *param, const char *ignore) |
| |
int | xcps_mdl_mov_dwn (const char *param, const char *ignore) |
| |
int | xcps_mdl_mov_elm (const char *param, const char *ignore) |
| |
int | xcps_mdl_mov_up (const char *param, const char *ignore) |
| |
int | xcps_ntr_bom_shw (const char *param, const char *ignore) |
| |
int | xcps_ntr_cop_str (const char *param, const char *ignore) |
| |
int | xcps_ntr_jmp_dwn (const char *param, const char *ignore) |
| |
int | xcps_ntr_jmp_up (const char *param, const char *ignore) |
| |
int | xcps_ntr_mov_dwn (const char *param, const char *ignore) |
| |
int | xcps_ntr_mov_up (const char *param, const char *ignore) |
| |
int | xcps_opn_cmp_str_brw (const char *param, const char *ignore) |
| |
int | xcps_opn_sol_brw (const char *param, const char *ignore) |
| |
int | xcps_prl_cpy_str (const char *param, const char *ignore) |
| |
int | xcps_prl_mov_dwn (const char *param, const char *ignore) |
| |
int | xcps_prl_shw_bom (const char *param, const char *ignore) |
| |
int | xcps_prl_shw_ord_bom (const char *param, const char *ignore) |
| |
int | xcps_rsl_itm (const char *param, const char *ignore) |
| |
int | xcps_rsl_ref (const char *param, const char *ignore) |
| |
int | xcps_rsl_ref_pos (const char *param, const char *ignore) |
| |
int | xcps_set_cur_prd (const char *param, const char *ignore) |
| |
int | xcps_set_man_typ (const char *param, const char *ignore) |
| |
int | xcps_sol_opn_mul (const char *param, const char *ignore) |
| |
int | xcps_vrf_bom_pos (const char *param, const char *ignore) |
| |
int | xcps_vrf_cpl_bom (const char *param, const char *ignore) |
| |
int | xcps_vrf_sgl_bom (const char *param, const char *ignore) |
| |
int | xcpy_agg (const char *param, const char *ignore) |
| |
int | xcpy_ref (const char *param, const char *ignore) |
| |
int | xcpy_str (const char *param, const char *ignore) |
| |
int | xcpy_typ (const char *param, const char *ignore) |
| |
int | xdiff_start_mmn () |
Compares two bills of materials (BOMs). | |
int | xdir_usx () |
Select menu userexit to call a function from the directory manager. | |
int | xdocty_change_typ () |
Select-menu userexit to change the type of a document. | |
int | xdocum_typ_frm () |
Opens the type form for a selected document according to its document type. | |
int | xedb_agg_ver () |
Select-menu userexit. | |
int | xedb_cop_slv () |
Copies a slave record into the structure list of a document widget. | |
int | xedb_del_ref () |
Select-menu userexit. | |
int | xedb_del_slv () |
Puts the selected slave record into the trash. | |
int | xedb_dup_ref () |
Copies the selected record and its relations (copy with structure). | |
int | xedb_hierarcy_ver (const char *param, const char *ignore) |
| |
int | xedb_iwf_lis_ref () |
Select-menu userexit. | |
int | xedb_quantity_ver (const char *param, const char *ignore) |
| |
int | xedb_ref_ver () |
Select-menu userexit. | |
int | xedb_tre_wlk () |
Menu userexit to walk recursively through a complete "tree" structure (for example a Bill of Material) and perform any action by calling a passed userexit. | |
int | xedb_usage_ver (const char *param, const char *ignore) |
| |
int | xeer_req_sel () |
Marks all selected records for EER replication. | |
int | xfile_bck_up () |
Creates a backup of the selected file. | |
int | xfile_chg_are (const char *param, const char *ignore) |
| |
int | xfile_chk_out () |
Checks out a file from a vault. | |
int | xfile_cki_dis_sec () |
Checks in a file into a distributed vault. | |
int | xfile_cki_res () |
Checks in a file and reset the document reservation. | |
int | xfile_cko_res () |
Checks out a file and reserve the document. | |
int | xfile_dis_fil () |
Distributes a file into another vault. | |
int | xfile_dis_pvm_fil () |
Distributes a file into another vault. | |
int | xfile_fil_rep () |
Distributes the current file in another vault. | |
int | xfile_get_eif_inf () |
Prints the path and filename of the crypted file within the vault of the kind 'EIF'. | |
int | xfile_mov_in () |
Moves (copy) the file from the external vault to the original vault. | |
int | xfile_mov_out () |
Moves a file from the original vault to an external vault The name of the external vault is written into the field T_FILE_DAT.EXTERNAL_AREA and the file status is changed. | |
int | xfile_ret_bck_up () |
Copies a file back from the backup vault into the original vault. | |
int | xfile_sec_are () |
Sets, gets or resets the vault for the global document-file mask. | |
int | xfile_sel_fil () |
Shows a file dialog to select a file for the document - file mask. | |
int | xfile_set_cop () |
Sets the copy mode (COPY or DUPLICATE). | |
int | xfile_set_flg () |
Sets the file status flag. | |
int | xfile_upd_fil () |
Copies a file from the current ('A'), origin ('O') or choice ('C') directory into the vault. | |
int | xfms_adm_bat_chk_are () |
Checks all files in a vault in batch mode. | |
int | xfms_adm_chk_are () |
Checks all files in a vault. | |
int | xfms_adm_chk_fil () |
Checks a file in a vault, by using the file size stored in the database. | |
int | xfms_chk_pth_acc (const char *param, const char *ignore) |
| |
int | xform_dlg_exc () |
Starts the dialog steps of selected assistant. | |
int | xhisto_get_his_all () |
Select menu userexit to create a history overview for the selected record. | |
int | xief_loa_exp_fin () |
Writes marked records to a loader file. | |
int | xief_loa_exp_rec () |
Marks selected records and related records to be exported. | |
int | xmgt_men_cnf_emb () |
Menu userexit to confirm embodiment of an item typically with a serial number) for a 'Should build' component. | |
int | xmgt_men_upd_del () |
Menu userexit to set records of the 'As built' item structure in update or delete mode. | |
int | xmtx_opn () |
Opens matrix list for selected variant placeholder (item). | |
int | xntm_opn () |
Calls the notes administration for the current record. | |
int | xntree_wlk () |
This menu userexit processes a n-dimensional tree structure. | |
int | xord_cre_ord_str () |
Select-menu userexit to create an order specific bill of material. | |
int | xord_del_ref () |
Deletes the complete structure of an order specific bill of material for the selected order. | |
int | xord_var_lis () |
Opens relation widget with order specific BOM. | |
int | xpdw_frm_acc (const char *param, const char *ignore) |
| |
int | xpdw_ksa_art_oth_pro (const char *param, const char *ignore) |
| |
int | xpdw_men_add_pro (const char *param, const char *ignore) |
| |
int | xpdw_men_chg_pro (const char *param, const char *ignore) |
| |
int | xpdw_men_cnt_lis (const char *param, const char *ignore) |
| |
int | xpdw_men_cpy_str (const char *param, const char *ignore) |
| |
int | xpdw_men_del_ass_pro (const char *param, const char *ignore) |
| |
int | xpdw_men_del_ver (const char *param, const char *ignore) |
| |
int | xpdw_men_exi_edt (const char *param, const char *ignore) |
| |
int | xpdw_men_set_res (const char *param, const char *ignore) |
| |
int | xpdw_men_vfg (const char *param, const char *ignore) |
| |
int | xpdw_pdw_chg_pro (const char *param, const char *ignore) |
| |
int | xprm_fre_lck (const char *param, const char *ignore) |
| |
int | xprm_set_pwd (const char *param, const char *ignore) |
| |
int | xprt_edt () |
Edits the RPG printer definition file (RPG_PDF_DAT) of the selected records. | |
int | xpvm_bat_doc (const char *param, const char *ignore) |
| |
int | xpvm_bat_fil (const char *param, const char *ignore) |
| |
int | xpvm_mrk_doc (const char *param, const char *ignore) |
| |
int | xpvm_mrk_doc_new (const char *param, const char *ignore) |
| |
int | xpvm_mrk_fil_new (const char *param, const char *ignore) |
| |
int | xpvm_set_act (const char *param, const char *ignore) |
| |
int | xpvm_set_not_act (const char *param, const char *ignore) |
| |
int | xqry_cnd_sav () |
Assigns the query conditions to the logical name given by the user for the query to be stored, and stores the query conditions and condition values in the table T_QRY_CND. | |
int | xqry_dat_rec_sav () |
Stores the record Id's of the records which are selected by the user in a form or list. | |
int | xqry_rnk_exc () |
Menu userexit to perform a 'Best matching'-query for the conditions given in the condition mask. | |
int | xqry_str_exc () |
Menu userexit to perform a logical query. | |
int | xqry_str_log_op () |
Menu userexit to connect several logical queries by an "AND" or "OR" operation. | |
int | xrel_mul_res () |
For each selected record (or, if the flag /SINGLE is set, just for the first record) the given reservation function is called. | |
int | xres_opn_res () |
Opens form with all information about the reservation of the selected element. | |
int | xres_rst_res () |
Resets the reservation of a record. | |
int | xres_set_res () |
Sets the reservation for a record. | |
int | xsml_frm_typ () |
Select menu userexit for a selected record to open classification or variant list if the record was assigned to a class or variant before. | |
int | xsmlc_upd_att () |
Select menu userexit to update the attribute fields in item head form and attribute folder. | |
int | xsmlc_usr_sav () |
Select menu userexit for class form to save the user specific settings for the current class. | |
int | xsmldf_cre_typ_ref () |
Select menu userexit to reorganize the class of TYP type. | |
int | xsmldf_del_sml () |
Select menu userexit to delete the class definition for the selected TYP class. | |
int | xsmldf_sml_def () |
Select menu userexit for class mask to create the type table for classes of TYP type (one type table for each class) or a classification form for ATT. | |
int | xstate_ask_nxt_sta (const char *param, const char *ignore) |
| |
int | xstate_frm_nxt_sta (const char *param, const char *ignore) |
| |
int | xstate_nxt_sta (const char *param, char *ignore) |
| |
int | xstr_ask_nxt_sta (const char *param, const char *ignore) |
| |
int | xstr_nxt_sta (const char *param, char *ignore) |
| |
int | xtxt_tmp_men_rep (const char *param, const char *ignore) |
| |
int | xtxt_whr_use_up1_men (const char *param, const char *ignore) |
| |
int | xvar_cal_mas_gen () |
Select menu userexit to start the mask generator for the variant form created for the current variant. | |
int | xvar_opn_var_prf () |
Select menu userexit to open a list with prefered variants (mask EDB-ART-VAR-PRF-RLI). | |
int | xvar_var_lis () |
Select menu, opens the variant list or variant form (for variants of type VARATT) for a selected variant. | |
int | xvardf_del_var () |
Select menu userexit to delete the attributes definition for the selected variant. | |
int | xvardf_var_def () |
Select menu userexit to create the table and mask for variants of type 'ATT' (mask EDB-ART-VAR-SLI or EDB-ART-VAR-SFR). | |
int | xver_agg_ver () |
Opens aggregate list with predecessor of selected record. | |
int | xver_cre_ver (const char *param, const char *ignore) |
| |
int | xver_del_ver (const char *param, const char *ignore) |
| |
int | xver_del_ver_pur (const char *param, const char *ignore) |
| |
int | xver_ref_ver () |
Opens refine list with successor of selected record. | |
int | xwfl_prc_abort () |
Menu userexit to cancel a process. | |
int | xwfl_prc_chg_own (const char *param, const char *ignore) |
| |
int | xwfl_prc_resume () |
Menu userexit to resume a process. | |
int | xwfl_prc_start () |
Menu userexit to start a process. | |
int | xwfl_prc_suspend () |
Menu userexit to suspend a process. | |
int | zag_dlg_iwf_lis_ref () |
Opens refine list for selected records. | |
int | zag_mas_opn_xas () |
Select menu/button userexit that opens widget for current record. | |
int | zag_men_wri () |
Writes text of selected menu selection into the current field. |
int bvb_usx_cmb_rpl | ( | ) |
Replaces the current folder in a combined mask with another folder.
The userexit provides the same features like userexit iwf_cyc_lis() with some extensions.
Field group
A field group can be one field or a set of fields. A field group is defined by a list or a range.
The field group can be used to set the fields visible or invisible.
Main form
See bvb_usx_chk_mfr() for a definition of the main form.
The /MAINFORM option indicates that the sub form is a part of the main form. A sublist is typically not part of the main form.
Folder identification
To identify the current folder, a customizable text can be defined that will be set in widget buffer.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "E>entity list [field_group] [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" "F>entity list [field_group] [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" "C>constraint list [field_group] [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" "R>entity_2 view [list] [field_group] [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" "A>entity_2 view [list] [field_group] [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" "field_group [/MAINFORM] [/DYNAMIC] [/FOLDER=TXT]" With possible arguments:
|
int bvb_usx_cns_frm_lis | ( | ) |
Opens the combined mask corresponding to the passed name of the constraint.
cp_par | Parameter, analogue to iwf_frm_lis(). |
int bvb_usx_opn_agg | ( | ) |
Opens the aggregate list or (combined) aggregate form.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "entity view [/EDB-L=edb-list [/EDB-F=edb-form[...]]] [/NO_MAINFORM] [/FORCEFORM] [@>]" With possible arguments:
|
// working example int iRc = bvb_usx_opn_agg("EDB-ARTICLE STR /EDB-L=EDB-ART-DOC-ALI /EDB-F=EDB-ART-DOC-ASR @>");
int bvb_usx_opn_ent | ( | ) |
Opens the entity list or (combined) entity form.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "entity [/EDB-L=edb-list [/EDB-F=edb-form[...]]] [/NO_MAINFORM] [/FORCEFORM] [@>]" With possible arguments:
|
// working example int iRc = bvb_usx_opn_ent("EDB-ARTICLE /EDB-L=EDB-ART-SLI /EDB-F=EDB-ART-SFR @>");
int bvb_usx_opn_ref | ( | ) |
Opens the refine list or (combined) refine form.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "entity view [/EDB-L=edb-list [/EDB-F=edb-form[...]]] [/NO_MAINFORM] [/FORCEFORM] [@>]" With possible arguments:
|
// working example int iRc = bvb_usx_opn_ref("EDB-ARTICLE STR /EDB-L=EDB-ART-DOC-ALI /EDB-F=EDB-ART-DOC-ASR @>");
int bvb_usx_opn_typ | ( | ) |
Opens the type list or (combined) type form.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "entity view [/EDB-L=edb-list [/EDB-F=edb-form[...]]] [/NO_MAINFORM] [/FORCEFORM] [@>]" With possible arguments:
|
// working example int iRc = bvb_usx_opn_typ("EDB-ARTICLE STR /EDB-L=EDB-ART-DOC-ALI /EDB-F=EDB-ART-DOC-ASR @>");
int bvb_usx_son_set_fat | ( | ) |
Sets a selected record of the sublist as parent record of the combined mask.
This record will be displayed in the header form.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "C> tab1.key1[,tab1.key2,...] tab2.key1[,tab2.key2,...]" "R> entity" "A> entity" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
static int jcl_cre_url | ( | ) | [static] |
This userexit creates a url to execute a pre-defined task.
The tasks are defined in the Privilege list. As default, there are four TASKs defined:
OPN-EDB-ARTICLE open items
OPN-EDB-DOCUMENT open documents, with which the default document mask (All Documents) will be used
OPN-EDB-PROJECT open projects
OPN-EDB-WRK-ORD open work orders
There are two configuration parameters defined for base URL: EDB-JCL-URL-INTERN and EDB-JCL-URL-EXTERN in system, which are used to set up the internal and external base URLs.
cpParameter | the parameter for userexit. Syntax: "[TASK] [/TYPE={I,E}]" With possible arguments:
| ||||||||
cpIgn | Reserved |
0 | OK |
---|---|
1 | No such task |
2 | No code base url found |
3 | Illegal arguments |
4 | Option value is invalid |
5 | Base url is invalid |
// working example int iRc = jcl_cre_url(OPN-EDB-ARTICLE /TYPE=I) ;
int sig_chg_pwd | ( | ) |
Changes the password of the selected private key by using a password dialog.
cpPar | not used |
cpIgn | not used |
0 | ok |
---|---|
1 | error |
int sig_cre_sgn_men | ( | ) |
Creates a digital signature of a data record.
The function get the private key and the certificate of the current user for the selected usage of the key. The user have to authenticate themself via password. The created digital signature will be stored into the database. The configuration data for the function is stored in the configuration table (EDB-SIG).
cpPar | Parameter to control the behaviour of this function. Syntax like: "/USAGE=type /ADDITIONAL=object /OBJ=object" with possible arguments:
| |||||||||
cpIgn | not used |
0 | on |
---|---|
1 | off |
int sig_imp_cer | ( | ) |
Imports a certificate file.
The userexit uses the configuration parameter EDB-SIG-CER-PATH to get the base path of the certificate tranfer directory.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_imp_key | ( | ) |
Imports a private key.
The useexit uses the configuration parameter EDB-SIG-KEY-PATH to get the base path of the key tranfer directory.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_imp_p12_cer | ( | ) |
Imports a certificate from a private exchange file.
The userexit uses the configuration parameter EDB-SIG-CER-PATH to get the base path of the certificate tranfer directory.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_imp_p12_key | ( | ) |
Imports a private key from a private exchange file.
The userexit uses the configuration parameter EDB-SIG-KEY-PATH to get the base path of the key tranfer directory.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_loc_key | ( | ) |
Locks the selected key record.
A locked key cannot be used to sign data.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_set_tmp_pwd | ( | ) |
Stores the temporary password of the given user into a temporary buffer.
cpPar | not used |
cpIgn | not used |
0 | ok |
---|---|
1 | error |
int sig_shw_cer | ( | ) |
Shows the main data of a certificate in a form.
cpPar | not used |
cpIgn | not used |
0 | ok |
---|---|
1 | error |
int sig_shw_win_cer | ( | ) |
Shows a certificate by using the Windows ActiveX component.
The certificate is exported to a temporary directory on client side. The userexit calls the Certificate ActiveX component with the exported certificate file.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_unl_key | ( | ) |
The userexit unlocks a locked key record.
cpPar | not used |
cpIgn | not used |
0 | OK |
---|---|
Else | Error |
int sig_usr_pra | ( | ) |
Selects the keys of the current user.
cpPar | not used |
cpIgn | not used |
0 | ok |
---|---|
1 | error |
int tol_select | ( | ) |
Select-menu userexit to calculate fields of the current mask.
cp_par | Reserved |
0 | OK |
---|---|
Else | Error |
The records of the current mask will not be written (into the database) from this function - unless a calling userexit (written by yourself) does it. Therefore it usually makes only sense to write calculatory fields of the current mask.
int xartic_bom | ( | ) |
Select-menu userexit to open the list containing child items for the currently selected item.
For variants (column TYP
has value "VAR"), the new title for the list (Message "EDB-VAR-STR-TIT") is determined. Call xctx_set_nxt
(with the set context value) to perform a pre-selection according to the context.
CpPar | Parameter to open the relation list. Syntax like: "entity2 view [/CTX=context]" |
with possible arguments
entity2 | entity name | Name of the second entity for the relation. |
---|---|---|
view | view name | Name of the view for the relation. |
CTX | context id | Specifies the context id for the child items. context can be one of the defined contexts (e.g. PRD , DSG ). To open a list with all child items ignoring the context filter, a dash '-' can be passed as context id. |
0 | OK |
---|---|
1 | No record has been selected |
else | Return code of iwf_lis_ref |
int xartic_var_agg | ( | ) |
Select-menu userexit to open variant list for selected item.
cp_Par | Parameter to open relation list. The parameter is passed to iwf_lis_ref . If no parameter is provided, the standard list and the view ATT will be used. |
0 | OK |
---|---|
else | Return code from xtyp_typ_agg |
int xase_cfg_brw | ( | const char * | param, |
const char * | ignore | ||
) |
Opens browser configuration for a single selected element in the heterogeneous structure configuration list.
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_cfg_ent | ( | const char * | param, |
const char * | ignore | ||
) |
Opens entity form for a single selected element in the heterogeneous structure configuration list.
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_cfg_fld | ( | const char * | param, |
const char * | ignore | ||
) |
Opens field mapping list for a single selected element in the heterogeneous structure configuration list.
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_cre_tab_vie_sel | ( | const char * | param, |
const char * | ignore | ||
) |
Creates temporary table and view for selected heterogeneous structure use cases.
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_fil_tab | ( | const char * | param, |
const char * | ignore | ||
) |
Fills temporary heterogeneous structure table for usecase.
The data is read from the browser configuration (entry with same name as usecase).
usxCtx | Menu userexit context. |
cp_par | Reserved. |
0 | OK |
---|
int xase_opn_frm | ( | const char * | param, |
const char * | ignore | ||
) |
Opens the corresponding form for selected record.
usxCtx | Menu userexit context. |
param | Reserved. |
0 | No error |
---|
int xase_shw_hie | ( | const char * | param, |
const char * | ignore | ||
) |
Opens heterogeneous structure explosion list for a single selected element.
The heterogeneous structure configuration for use case "/USE" is used. If "/NO_ROOT" option is set then the top element is not included in the structure explosion list. If "/NO_MASKLIMIT" option is set then the whole structure explosion list will be shown even if the record number exceeds the mask limit.
usxCtx | Menu userexit context. |
param | /USE=<useCaseName> [/NO_ROOT] [/NO_MASKLIMIT] |
0 | OK |
---|---|
1 | Use case not found. |
int xchg_asg_obj | ( | const char * | param, |
const char * | ignore | ||
) |
Assigns selected objects to a Work Set.
If one of the objects is already assigned to a Work Set, an error message is printed and nothing is changed.
Otherwise, a dialog allows the user to select the new Work Order/Work Set combination. A new change operation of the type ASSIGN
is created, and all selected objects will refer to this change operation via their FROM link.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
IllegalArgumentException | The object is not controlled by the Change Management |
int xchg_ask_nxt_sta | ( | const char * | param, |
const char * | ignore | ||
) |
Displays possible next states for an object.
Menu userexit which calls the appropriate userexit of the Release Management to show the possible next states of an object.
This userexit can be attached to any entity or relation.
Depending on the change management settings and the type of the object, it calls either:
If the object is an entity | xstate_ask_nxt_sta() or xstr_ask_nxt_sta() |
---|---|
If the object is a relation | xstate_ask_nxt_sta() |
Further the Change Management configuration is checked:
xstate_ask_nxt_sta()
is called to query the possible next states of the child object. LEV_IND
from the structure table is available in the mask. xstate_ask_nxt_sta()
is called. xstr_ask_nxt_sta()
is called to query the possible next states of the relation. context | The userexit context. |
param | The userexit parameters. This parameter is simply passed to xstate_ask_nxt_sta()/xstr_ask_nxt_sta(). |
int xchg_det_aff_prd | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to determine affected products of a Work Set.
This menu trigger performs the Change Impact Analysis (CIA). The context may contain several selected Work Sets. The CIA is called for each selected Work Set and the impact-analysis date as well as the impact-analysis-required attribute is refreshed.
context | The context of this trigger. |
param | Reserved |
0 | OK |
---|---|
else | Error |
The following scenarios shall be covered at least:
int xchg_ewr_del | ( | const char * | param, |
const char * | ignore | ||
) |
Deletes the currently selected Work Request(s).
DataView's trashbasket must be empty. Otherwise the user will get an appropriate error message and the userexit is aborted.
If the Change Management is not activated this userexit simply calls DataView's iwf_del_lis(). Otherwise the deletion of the initially assigned preliminary Work Order is triggered.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xchg_ina_obj | ( | const char * | param, |
const char * | ignore | ||
) |
Inactivate selected objects.
If the first selected object is a relation record, the action is handled by Change Management's high sophisticated combined form (so called monster form).
If this is not the case and one of the master records is already assigned to a Work Set, an error message is printed and nothing is changed.
Otherwise, a dialog allows the user to select the new Work Order/Work Set combination. A new change operation of type INACTIVATE
is created, and all selected master records will refer to this change operation via their UNTIL link.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xchg_log_opr_und | ( | const char * | param, |
const char * | ignore | ||
) |
Undo the currently selected change operation.
Exactly one change operation must be selected to call this userexit and DataView's trashbasket must be empty. Otherwise the user will get an appropriate error message and the userexit is canceled.
If all prerequisites are fulfilled, all changes that are caused by the selected change operation are undone.
context | The context of the userexit | ||||||
param | Parameter to control the behavior of this function. Syntax like: "[/CONFIRMATION]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xchg_nxt_sta | ( | const char * | param, |
const char * | ignore | ||
) |
Change the state of an object.
Menu userexit which calls the userexit of the Release Management to change the state of an object.
This userexit can be attached to any entity or relation.
Depending on the Change Management settings and the type of the object it is attached to, it calls either xstate_nxt_sta()
or xstr_nxt_sta()
:
xstate_nxt_sta()
is called. xstate_nxt_sta()
is called to change the state of the child object. LEV_IND
from the structure table is available in the mask. xstate_nxt_sta()
is called. xstr_nxt_sta()
is called to transfer the state of the relation. context | The userexit context. |
param | The userexit parameters. This parameter is simply passed to xstate_nxt_sta() / xstr_nxt_sta(). |
int xchg_opn_crr_lis | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to open the correction list of the selected change operation.
This select-menu userexit opens the constraint list to show the corrections of a selected change operation.
The userexit executes the following checks:
context | The context of the userexit |
param | The information to open the constraint list (iwf_cns_lis). |
0 | OK |
---|---|
1 | More than one record selected |
int iRc = xchg_opn_crr_lis("<EDB-CHG-LOG-EWR-CRC EDB-CHG-OPR-CRC-SLI");
int xchg_opr_del_obj | ( | const char * | param, |
const char * | ignore | ||
) |
Deletes the currently selected object(s) as provided by the context object.
This userexit is the default delete userexit called if a change operation is undone. It simply removes all records from the database that are provided as selected rows by the passed context object.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xchg_opr_mov | ( | const char * | param, |
const char * | ignore | ||
) |
Moves one or more selected change operations to another Work Set.
Opens a form to select the Work Set and reassign the selected change operations to this set.
If a selected operation has a parent operation, the user is asked to confirm the operation.
Add the option /SEL_EWO to allow the user to select a new Work Order, too. If this option is omitted, the Work Order is fixed.
Caution: Changing the Work Order is considered to be a manager functionality, so it should not be presented to a standard end user.
context | The menu userexit context |
param | Parameter to control the behavior of this function. Syntax like: "[/SEL_EWO|/NO_CONFIRMATION]" If the option /SEL_EWO is specified, the user may choose a new Work Order. If the option /NO_CONFIRMATION is specified, the confirmation dialog is not displayed when related change operations are moved. |
0 | OK |
---|---|
Else | Error (no record selected) |
int iRc = dal_usx_cal_typ(NULL, "xchg_opr_mov", "/SEL_EWO", dal_USXTYPE_MENUSELECTION);
int xchg_sel_ord | ( | const char * | param, |
const char * | ignore | ||
) |
Open a selection widget to search and select the default EWO.
This userexit is usually used for select menus. It opens the modal selection dialog 'EDB-EWO-ORD-SEL-SLI' and copies the current values of alias id, organization id and alias version to the query buffer. Then the dialog is refreshed and displayed in selection mode.
The context may contain several selected rows, but only the first selected row is used to read the alias and organization values.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xchg_set_cre_id | ( | const char * | param, |
const char * | ignore | ||
) |
Userexit that calls the "Create persistent ID" userexit for all preliminary objects assigned to a Work Set.
Exactly one Work Set must be selected as otherwise the user will get an error message and the execution of this userexit is aborted.
The default implementation removes the preliminary flag of the assigned objects and corrects the current flag of the predecessor (see CRM ). A specific implementation may be defined by the customizer to control the creation of persistent IDs. In this case the default implementation does nothing except managing the preliminary and the current flag.
context | The context of the userexit |
param | [/NO_CURFLAG] if /NO_CURFLAG option is set then the correction of the current flag of the predecessor is not done (not recommended!). |
0 | OK |
---|---|
Else | Error |
int xchg_upg_obj | ( | const char * | param, |
const char * | ignore | ||
) |
Upgrades legacy data for the Change Management.
If one of the objects is already assigned to a Work Set, an error message is printed and nothing is changed.
Otherwise, a dialog allows the user to select the new Work Order/Work Set combination. A new change operation of the type UPGRADE
is created, and all selected objects will refer to this change operation via their FROM link.
context | The context of the userexit |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcnf_ord_bom_del | ( | const char * | param, |
const char * | ignore | ||
) |
Select-Menu userexit to delete an order BOM.
param | Parameter to control the behavior of this function. Syntax is: "[/NOASK]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xcnf_ord_bom_exp | ( | const char * | param, |
const char * | ignore | ||
) |
Select-Menu userexit for exploding the order BOM from the order widget.
If parameter is empty then following string is used to open the order BOM explosion "EDB-CPS-ELEMENT EDB-ORD-ELM-HIE-CFR E>EDB-CPS-ELM-HIE EDB-EFF-ELM-HIE-SLIC". The order BOM explosion is executed by stored procedure EPQ_EDB_EFF_ELM_BOM.
param | Parameter to control the behavior of this function. Syntax is: "[/HIER=openString][/BOM=bomFlagValue]" With possible arguments:
|
int xcol_cre_art_ntr | ( | const char * | param, |
const char * | ignore | ||
) |
Create a neutral item from an item master by retrieving a unique number from the number server and set the field TYP to VARATT.
context | the current context of the trigger |
param | addition paramaters (none at this time) |
int xcopm_start_mmn | ( | ) |
Copies elements of a path to a new revision or to a new number.
The beginning and end of the path will be defined interactively by listing the top elements of a selected record. With the parameter /STOP it is possible to define some cancel conditions. If an element in the path matches the cancel condition this element will be the end of the path to be copied. By default, the whole path is copied. The parameter /CPAR controls the behavior of the functions which copies the path elements to new versions or numbers. The parameter /UPAR controls the behavior of the function which lists the parents of an element.
cpParameter | Parameter to control the behavior of this function. Syntax like: "/MOD={N|V} [/STOP=<lgv>] /CPAR=<def> /UPAR=<def>" With possible arguments:
|
0 | OK |
---|---|
-1 | User cancelled |
1 | No selected record found |
2 | More than one record selected |
3 | Required parameter /MOD not found |
4 | Required parameter /CPAR not found |
5 | Default-entry not found for parameter /CPAR |
6 | Required parameter /UPAR not found |
7 | Default entry not found for parameter /UPAR |
9 | Error creating path of the elements to be copied |
10 | Error checking path elements for cancel condition |
11 | First element of path matches cancel condition |
12 | Error during 'copy modify' of path |
13 | No authorization to copy elements |
int xcpa_cpy_ali | ( | const char * | param, |
const char * | ignore | ||
) |
Copies the Alias IDs for an object if a new revision is created.
This userexit is intended to be used in the object specific Logic Model procedure <object name>="">_VerPost from the Logic Model EP_CPY. These procedures are called after creating a new revision of a record.
parameter |
|
30 if (EP_CPY_CID_DUP>0) 40 RES = @xcpa_cpy_ali(strcat("/OBJ_ENT=EDB-ARTICLE /ALI_ENT=EDB-CPA-ARTICLE /ORI_CID=",strprint("%i",EP_CPY_CID_ORG)," /DUP_CID=",strprint("%i",EP_CPY_CID_DUP))) 50 CheckResult() 60 endif
0 | OK |
---|---|
Else | Error |
int xcpa_cpy_col_itm | ( | const char * | param, |
const char * | ignore | ||
) |
Special copy function for items, copies an Item and additionally the value of the default Alias ID.
This userexit could only be used for objects that support Alias IDs.
0 | OK |
---|---|
Else | Error |
cpParameter | Standard menu parameter (reserved) |
int xcpa_set_default_men | ( | ) |
Menu userexit to set the default (field C_DEFAULT) of the Alias IDs in the different CPA objects (for example T_CPA_ART_DAT or T_CPA_DOC_DAT).
param | Additional argument string (reserved). |
0 | OK. |
---|---|
1 | Error from epq. |
2 | Field not found. |
3 | No record selected. |
4 | No record selected. |
5 | Too many records selected. |
6 | No widget is active. |
Menu userexit to set the default Alias ID.
int xcps_cmp_opn_frm | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for product structure element forms.
Opens a neutral or modular product component form. If a product structure element was created for a modular BOM the modular BOM form will be used to display the product component else the neutral BOM form. The function to open the form and the forms itself are configurable.
context | Menu userexit context | |||||||||
param | Parameter to control the behavior of this function. Syntax like: "/USX=<opn_usx> /NTR=<ntr_form> /MDL=<mdl_form>" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xcps_elm_tak | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the modular BOM product structure element selector.
The userexit implements the "Take entry" functionality for the product structure element selector. The userexit uses the selected element to execute the current move or copy operation of the element selector.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_flt_att_men_sel | ( | const char * | param, |
const char * | ignore | ||
) |
Choose menu userexit for filter masks.
Writes the attribute data of the choosen attribute into the filter record and updates the temporary field values.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_grp_cmp_rst_eff | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for classification - product component relation masks.
The userexit sets the selected record ineffective.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_grp_cmp_set_eff | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for classification - product component relation masks.
This userexit sets the selected record effective.
context | Menu userexit context | |||||||||
param | Parameter to control the behavior of this function. Syntax is: "/MASK=list /CHK_RLS=[0|1]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xcps_grp_del_var_inf | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for product family masks.
Removes the variant information of the assigned product components from the variant cache. The product variant cache is used to optimize the creation of the product variant select-menu in the variant sub lists of the modular BOM.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_mdl_bom_shw | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for product component / product structure element masks.
Opens the multilevel modular structure for a product component (similar to the structure explosion but now for constraints).
context | Menu userexit context | |||||||||
param | Parameter to control the behavior of this function. Syntax is: "[/ALL][/EDB_ID=<edbid>][/LIST]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xcps_mdl_cpy_elm | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the product element structure list.
Copies the element to another position within the CPS. The element selector is used to detemine the destination position.
The element, all sub elements and the solutions will be copied.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_mdl_dup_elm | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the product element structure list.
Copies the element to another position within another CPS. The element selector is used to detemine the destination position.
The element and all sub elements will be copied.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_mdl_jmp_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the modular product component sublist "Where Used".
Puts the selected record to the main form of the combined modular product component widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
EDB_CPS_NO_FIELD | Field EDB_IS_MODULARBOM is missing in widget |
EDB_CPS_ERR_PAR | Wrong syntax in parameter |
int xcps_mdl_jmp_up | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the modular product component sublist "Structure".
It puts the selected record to the main form of the combined product component widget.
context | Menu userexit context | ||||||
param | Parameter to control the behavior of this function. Syntax is: "/ENT=<ent_nam> /MASK=<usx_par>" With possible arguments:
|
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
EDB_CPS_NO_FIELD | Field EDB_IS_MODULARBOM is missing in widget |
EDB_CPS_ERR_PAR | Wrong syntax in parameter |
/ENT=EDB-CPS-ELEMENT /MASK="EDB-CPS-MDL-CFR @> /FORCEFORM"
int xcps_mdl_mov_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the combined module structure widget.
Moves the parent record to the main record module widget. By providing a parameter this userexit can handle other structures (e.g. Parallel structures), too.
context | Menu userexit context | |||||||||
param | Parameter to control the behavior of this function. Syntax is: "[/SRC=<src_fld> /POS=<pos_fld> /TAR=<trg_fld>]" With possible arguments:
|
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
EDB_CPS_NO_FIELD | Field EDB_IS_MODULARBOM is missing in widget |
EDB_CPS_ERR_PAR | Wrong syntax in parameter |
int xcps_mdl_mov_elm | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the product element structure list.
Moves the element to another position within a CPS. The element selector is used to detemine the destination position.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_mdl_mov_up | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the modular product component sublist "Structure".
Puts the selected record to the main form of the module element widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
EDB_CPS_NO_FIELD | Field EDB_IS_MODULARBOM is missing in widget |
EDB_CPS_ERR_PAR | Wrong syntax in parameter |
int xcps_ntr_bom_shw | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to show the hierarchy of a neutral product component.
Opens a multi-level structure explosion widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
1 | Error |
int xcps_ntr_cop_str | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to copy the product structure element with its relations.
The product structure element itself and its relations to document and filter objects are copied.
If "sel" is given then a dialog is opened where the user can select which relations should be copied.
context | Menu userexit context | ||||
cpArguments | Parameter to control the behavior of this function. Syntax like: "{sel | all}" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xcps_ntr_jmp_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for neutral product component sublist "Where Used".
Puts the selected record to the main form of the combined neutral product component widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
int xcps_ntr_jmp_up | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for neutral product component sublist "Structure".
Puts the selected record to the main form of the combined product component - neutral widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
int xcps_ntr_mov_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for combined neutral product structure element form.
Moves the parent record to main record product structure element widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
int xcps_ntr_mov_up | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the sublist "Structure" of a combined product structure element form.
Puts the selected record to the main form of the combined product structure element widget.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
EDB_CPS_INTERNAL | No widget |
EDB_CPS_NO_ACT_ROW | No current row |
int xcps_opn_cmp_str_brw | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the browser mask.
Gets the EDB_ID of the product structure element and writes it as query criteria in the product structure element list (field T_CPS_ELM_DAT.EDB_STR_REF).
This userexit is used in the browser mask (EDB-CPS-MLD-STR) to get the product structure elements for a product component.
context | Menu userexit context | ||
param | Parameter to control the behavior of this function. Syntax like: "usx_par" With possible arguments:
|
0 | Ok |
---|---|
Else | Error |
int xcps_opn_sol_brw | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to open the browser mask for solution space for a product structure element.
The userexit gets product component EDB_ID of field V_CPS_ELM_ITM.EDB_CMP_REF for selected browser element, opens the browser list passed as parameter by iwf_lis_ent and writes the product component EDB_ID in the constraint field T_CPS_ELM_DAT.EDB_CMP_REF.
context | Action userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_prl_cpy_str | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to copy complete assigned parallel structure.
Copies the constraint product component - parallel structure and copies sub-structure of the parallel structure and its module relations. The method calls "xcpy_str" to copy the parallel structure node element and then copies the sub-elements with their assigned modules. To copy the parallel structure node relations the form provided by "/NOD" parameter is used (in the standard dump the value is "/NOD=EDB-CPS-PRL-TOP-STR"). If "all" parameter is passed then the relations to modules are copied. If "sel" parameter is passed then the user is asked if the relations to the module should be copied, too. To store the user decision, the LGV system variable EP_PRL_NOD_ELM is used.
context | Menu userexit context | |||||||||
cpParameter | Parameter to control the behavior of this function. Syntax is: "[all|sel] /NOD=name_of_node_widget" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xcps_prl_mov_dwn | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit for parallel structure node widgets.
Navigates upwards the parallel structure node hierarchy. If the top level is reached, the userexit opens the parallel structure form for the top element.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|
int xcps_prl_shw_bom | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit for parallel structure widgets.
Opens structure explosion widget for parallel structure.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|
int xcps_prl_shw_ord_bom | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit for order BOM parallel structure widgets.
Opens the structure explosion widget for order specific parallel structure.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|
int xcps_rsl_itm | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to resolve items within the modular BOM overview.
The userexit resolves item master entries to the current item revision entry.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_rsl_ref | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu trigger to resolve the references of a conceptual product structure.
Resolves the full multi-level structure of a modular BOM and displays the data in a multi-level BOM form.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_rsl_ref_pos | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu trigger to resolve the references of a CPS position.
Resolves the full multi-level structure of a modular structure element and displays the data in a multi-level BOM form.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_set_cur_prd | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for classification list to set the default EDB-CPS-SOL-PRD.
Sets the PART_ID of the current item to the default value EDB-CPS-SOL-PRD.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_set_man_typ | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to toggle the value for the mandatory flag.
The userexit is used in the sub-list "Structure" of product component widget (Neutral) to toggle the value of mandatory flag.
context | Menu userexit context |
param | Reserved |
0 | OK |
---|---|
1 | Error |
int xcps_sol_opn_mul | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for multi-edit solution list.
The userexit opens the multi-edit solution list and writes the EDB-ID of the selected product structure element into the widget buffer.
context | Mask userexit context |
param | Reserved |
0 | OK |
---|---|
Else | Error |
int xcps_vrf_bom_pos | ( | const char * | param, |
const char * | ignore | ||
) |
Pre-transition userexit for BOM position.
If the item structure is verified, the BOM position will be verified against the effective conceptual product structures for the parent item.
The userexit supports the following view scopes:
Production view (PRD) | In production view the product component, product structure element, classification and the relation between them have to be released or set effective to be considered in the verification process. If the flag /SOFT is set, BOM positions that are not released yet are also considered. The objects which will be released are also considered and the effectivity of the assigned work sets is used. |
---|---|
Development view (DEV) | Same as the production view, but product strucure elements of the conceptual product structure that are not released yet are also considered during the verification. |
context | Action userexit context | ||||||||||||||||
param | Parameter to control the behavior of this function. Syntax is: "/PRD|/DEV [/SOFT] [/STRICT][/SILENT][/SHORTMSG][/ALT={ALL|DETECT}][/ANALYSE]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xcps_vrf_cpl_bom | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to verify an item with its complete BOM.
Checks if the item has the verify structure flag set. In this case the BOM will be verified against the conceptual product structure of the item.
The userexit supports the following view scopes:
Production view (PRD) | In production view the product component, product structure element, classification and the relation between them have to be released or set effective to be considered in the verification process. If the flag /SOFT is set, BOM positions that are not released yet are also considered. The objects which will be released are also considered and the effectivity of the assigned work sets is used. |
---|---|
Development view (DEV) | Same as the production view, but product strucure elements of the conceptual product structure that are not released yet are also considered during the verification. |
context | Menu userexit context | |||||||||||||
param | Parameter to control the behavior of this function. Syntax is: "/PRD|/DEV [/SOFT][/STRICT][/SILENT][/ANALYSE]" With possible arguments:
|
0 | OK |
---|---|
1 | Verification failed (only if option /STRICT is set) |
int xcps_vrf_sgl_bom | ( | const char * | param, |
const char * | ignore | ||
) |
Pre-transition userexit for items.
If the structure of an item is verified the BOM positions will be verified against the effective conceptual product structures for the item.
The userexit supports the following view scopes:
Production view (PRD) | In production view the product component, product structure element, classification and the relation between them have to be released or set effective to be considered in the verification process. If the flag /SOFT is set, BOM positions that are not released yet are also considered. The objects which will be released are also considered and the effectivity of the assigned work sets is used. |
---|---|
Development view (DEV) | Same as the production view, but product strucure elements of the conceptual product structure that are not released yet are also considered during the verification. |
context | Transition userexit context | |||||||||||||
param | Parameter to control the behavior of this function. Syntax is: "/PRD|/DEV [/SOFT][/STRICT][/SILENT][/ANALYSE]" With possible arguments:
|
0 | OK |
---|---|
1 | Verification failed (only if option /STRICT is set) |
int xcpy_agg | ( | const char * | param, |
const char * | ignore | ||
) |
Copies all aggregate relations defined by a surrounding xcpy_str call.
Copying is either done via direct EPQ access (using the function xedb_dup_rel
), or relation records are copied in the standard refine relation widget.
Using widgets might be a little bit slower than copying with xedb_dup_rel
, but the widget copy uses the current view and context settings, calls the appropriate mask triggers, and it is needed to support the e6 Change Management.
The standard LogiView aggregate triggers check if the relation is under Change Management control. If so, the option /USEWIDGET is passed to this method.
This method does not use the aggregate widget to copy records, because normally records cannot be inserted in the standard aggregate list. In addition, most functionality - like Change Management checks and fields - is only available in the relation list.
To copy an aggregate relation, the code opens the refine relation list of the parent record and duplicates the corresponding refine relation record.
[in] | context | userexit context | |||||||||||||||||||||||||||
[in] | param | userexit parameter. Syntax is "<view-name> /FAT_ACCESS={0|1|2} /BOM_AGG={0|1} /USEWIDGET" with:
|
0 | OK | |
---|---|---|
9 | ERR_XCPY_ILL_PARAM | illegal argument passed |
12 | ERR_XCPY_ILL_HANDLE | must be called within a xcpy_str call |
99 | ERR_XCPY_INTERNAL | Something unexpected happened |
xedb_dup_rel
. int xcpy_ref | ( | const char * | param, |
const char * | ignore | ||
) |
Copies all refine relations defined by a surrounding xcpy_str call.
In copy reference mode - which is the mode most often used - copying is either done via direct EPQ access (function xedb_dup_rel
), or relation records are copied in the standard refine relation widget.
Using widgets might be a little bit slower than copying with xedb_dup_rel
, but the widget copy uses the current view and context settings, calls the appropriate mask triggers, and it is needed to support the e6 Change Management.
The standard LogiView refine triggers check if the relation is under Change Management control. If so, the option /USEWIDGET is passed to this method.
In copy element or copy tree mode, copying is always done using a widget. If the standard refine widget is not suitable, the userexit and the pre/post mask triggers can be specified.
All arguments in this mode are passed to xedb_cop_tre
.
[in] | context | userexit context | ||||||||||||||||||||||||||||||||||||||||||
[in] | param | userexit parameter. Syntax is: "<view-name> /MODE={R|E|T} /PRE=<usx> /POST=<usx> /BUF=<text> /OPN_USX=<usx> /BOM_AGG={0|1} /USEWIDGET" with:
|
0 | OK | |
---|---|---|
9 | ERR_XCPY_ILL_PARAM | Illegal argument passed |
12 | ERR_XCPY_ILL_HANDLE | Must be called within a xcpy_str call |
99 | ERR_XCPY_INTERNAL | Something unexpected happened |
xedb_cop_ret_val
can be used to get the internal ID (C_ID) of the copied elements.xedb_cop_tre
and xedb_dup_rel
.int xcpy_str | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to copy the selected element and its relations (copy with structure).
The configuration rubric 'Entity1'-REL stores all relations that can be duplicated within this userexit - for instance EDB-ARTICLE-REL
for items.
This default definition may be changed by either specifying another configuration rubric using the parameter SEL_FROM
, or by modifying the LogiView system variable EP_CPY_SEL_FROM
during the Pre-Trigger (see below).
If this is a selective copy (parameter mode
is sel
), the user may choose from the specified set of relations.
The following LogiView functions of the EP_CPY
logic model are called with 'Ent' as the name of the entity and 'Mode' as either Num
for copy to new number or Ver
for versionizing:
actual
is set to the original C_ID. actual
is set to the new C_ID. If one of these two triggers does not exist or terminates with an exit
, the whole process is aborted and a database rollback is performed.
For each type of relation (Aggregate/Refine/Type), the following respective LogiView functions of the logic model EP_CPY
are called with the specified system variables set to these respective values:
'Ent'_'Mode'Agg: The Aggregate trigger
The default aggregate trigger calls xcpy_agg
.
'Ent'_'Mode'Ref: The Refine trigger
The default refine trigger calls xcpy_ref
xcpy_typ
. EDB-ARTICLE
in EP_CPY
are: Copy with structure | EDB-ARTICLE_NumPre | Pre-trigger |
---|---|---|
EDB-ARTICLE_NumPost | Post-trigger | |
EDB-ARTICLE_NumRef | Refine-trigger | |
EDB-ARTICLE_NumAgg | Aggregate-trigger | |
EDB-ARTICLE_NumTyp | Type-trigger | |
Version with structure | EDB-ARTICLE_VerPre | Pre-trigger |
EDB-ARTICLE_VerPost | Post-trigger | |
EDB-ARTICLE_VerRef | Refine-trigger | |
EDB-ARTICLE_VerAgg | Aggregate-trigger | |
EDB-ARTICLE_VerTyp | Type-trigger |
If a trigger does not exist, the copy operation is aborted. The Ref/Agg/Type-triggers are responsible for calling the respective sub-function xcpy_agg
, xcpy_ref
or xcpy_typ
. Otherwise, no structures will be copied at all.
[in] | context | userexit context | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[in] | param | Parameter to control this function. Syntax is: "<mode> /BATCH=<lgv> /TPR /VER /SEL_FROM=<cfgRubric> /OPR=<oprType>" "/NAME={...} /FIELD_TYPE={...} /NO_DEFAULT=<field> /NO_CHK_RES /ALLOW_GLOBAL" with possible argument:
|
0 | OK | |
---|---|---|
1 | ERR_XCPY_ONE_ROW | No row selected |
2 | ERR_XCPY_ONE_ELEM | None or more than one element selected |
3 | ERR_XCPY_LGV_INI | LogiView init failed |
4 | ERR_XCPY_DB_ERROR | Internal database error |
6 | ERR_XCPY_DUP_FAILED | Element could not be duplicated |
8 | ERR_XCPY_ILL_MODE | Mode 'sel' not allowed in batch mode |
9 | ERR_XCPY_ILL_PARAM | Illegal parameter |
10 | ERR_XCPY_NO_MEM | Not enough memory |
11 | ERR_XCPY_FLD_DEF | Illegal field definition |
14 | ERR_XCPY_ILL_STATE | Element has wrong state |
15 | ERR_XCPY_ONE_VER | Element is versionized already |
16 | ERR_XCPY_ELEM_LOCKED | Element is locked by someone else |
17 | ERR_XCPY_ABORT | Aborted by user or transaction |
99 | ERR_XCPY_INTERNAL | Something unexpected happened |
If the top element is controlled by the e6 Change Management, all new objects created by this method - if they are under control themselves - will be assigned to the work order and set as selected by the user.
In case of a non-interactive copy, the current work order and set are used.
Copying in global view is not allowed (unless option /ALLOW_GLOBAL is passed).
Preliminary relation records are never copied.
For instance, a Copy with Structure operation of an item with two BOMs will result in the following Change Log entry of the work order:
>> | Effectivity | Change Operation | Type | ... |
---|---|---|---|---|
1 | |> | Copy with structure | Item | |
.2 | |> | Add | Item | |
.2 | |> | Add | Item |
If a new version is created, the only difference is the top-level change operation:
>> | Effectivity | Change Operation | Type | ... |
---|---|---|---|---|
1 | |> | Version with structure | Item | |
.2 | |> | Add | Item | |
.2 | |> | Add | Item |
Different top-level operations are used to indicate whether the user performed a selective copy (e.g. Copy with Structure), or if all or no relations have been copied (Copy all Structures or Copy w/o Structure).
The same pattern applies when creating a new version.
xedb_cop_ret_val
may be used to get the internal ID (C_ID) of the copied elements.If the element is versionized, the file relations are copied regardless of the parameter 'mode'!
Note that copying references only, or references and referenced elements, can be customized with the corresponding LogiView trigger.
For example, the default for EP_CPY/EDB-DOCUMENT_VerRef
is
10 RES = @xcpy_ref( strprint( "%s /MODE=R /BOM_AGG=1", EP_CPY_VIEW_NAME ) ) 20 CheckResult()
which has the effect that only references are copied for all related entities. This can be changed, for instance, so that for related documents, the related entities themselves are also copied.
This LogiView procedure can be used to achieve that:
10 RES = scan(EP_CPY_VIEW_NAME,"%s",MY_CPY_ENTITY) 20 if (MY_CPY_ENTITY == "EDB-DOCUMENT") 30 RES = @xcpy_ref(strprint("%s /MODE=E /PRE=xslv_cop_xba /POST=xslv_ver_xaa /BUF=T_DOC_DAT.DOC_VERSION",EP_CPY_VIEW_NAME)) 40 else 50 RES = @xcpy_ref( strprint( "%s /MODE=R /BOM_AGG=1", EP_CPY_VIEW_NAME ) ) 60 endif 70 CheckResult()
If the reference to be copied points to an EDB-DOCUMENT
, xcpy_ref
is called with /MODE=E
, and the specified pre- and post- triggers are executed before/after the element has been copied. For all other entities, xcpy_ref
is called with /MODE=R
to copy references only.
int xcpy_typ | ( | const char * | param, |
const char * | ignore | ||
) |
Copies all type relations defined by a surrounding xcpy_str call.
This method copies type relations (like classification, variants and DataView types). It just calls xedb_dup_typ
, which uses direct EPQ programming to duplicate the relation.
[in] | context | userexit context |
[in] | param | userexit parameter with syntax like "type-name" |
0 | OK | |
---|---|---|
9 | ERR_XCPY_ILL_PARAM | Illegal argument passed |
12 | ERR_XCPY_ILL_HANDLE | Must be called within a xcpy_str call |
99 | ERR_XCPY_INTERNAL | Something unexpected happened |
xedb_dup_typ
.int xdiff_start_mmn | ( | ) |
Compares two bills of materials (BOMs).
Select menu userexit to compare two bills of materials. The result of the comparison is written into a temporary file and is displayed in the file widget "EDB-LISTING".
cpPar | Parameter to control the behavior of this function. Syntax is: "relpar|<key1> [/SILENT] [/OUT={FILE|TABLE}] [/DEP=<num>] /ET={<dtname>|<key2>} /VIE={<view>|<key3>} [/WDG={respar|<key4>}] [/NOKEYF] [/CKEY=<fld>] [/CNTFNC={R|L}] [/SIGFNC={W|X}] [/LENCMP=<len>] [/CMPWRP=>num>] /SIE" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xdir_usx | ( | ) |
Select menu userexit to call a function from the directory manager.
cp_par | Parameter to control the behavior of this function. Syntax is: "{O <dir> <ent> | C | N <ent> | S <wdg> | E | P | X | /DYN}" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xdocty_change_typ | ( | ) |
Select-menu userexit to change the type of a document.
The document may not be reserved and the current user must have delete access on the (type) record.
cp_par | Parameter to control behaviour of this userexit. Syntax like: "[doc_type] /NOCONFIRM /CLOSE"
|
0 | OK |
---|---|
1 | Unable to change document type. |
int xdocum_typ_frm | ( | ) |
Opens the type form for a selected document according to its document type.
A default can be used to define the name of the form to open a specific document type. The name of the default must be the same as the document type. The value for the default is either "0", which means that the default form is opened, or it has to contain the name of the form to open.
DRAWING | 0 | The system will use the default form. |
---|---|---|
DRAWING | EDB-OWNER-FORM | The system will use the form EDB-OWNER-FORM as type form for the document type DRAWING. |
cpPar | Parameter to control the behavior of this function. Syntax like: "[/VIR]" With possible arguments:
|
0 | OK |
---|---|
else | Unable to open the form |
int xedb_agg_ver | ( | ) |
Select-menu userexit.
par_str | Parameter to open aggregate list. Syntax like: "<entity2> <view> [<list>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error code from 'iwf_lis_agg' |
int xedb_cop_slv | ( | ) |
Copies a slave record into the structure list of a document widget.
cp_parameter | Parameter to control the behavior of this function. Syntax is: "<entityname> [/T=<typname>][/F=<fieldname>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xedb_del_ref | ( | ) |
int xedb_del_slv | ( | ) |
Puts the selected slave record into the trash.
If the selected record (in structure widget of document) has a slave lifecycle (lifecycle starts with "SLV_"), the document record itself and the relation record are moved into the trash. Records without a slave lifecycle are ignored. It is not checked if the slave lifecycle corresponds to the parent.
cp_entNam | Parameter to control the behavior of this function. Syntax is: "<entityname>" With possible arguments:
|
0 | OK |
---|---|
1 | Field CHK_NAME does not exist |
int xedb_dup_ref | ( | ) |
Copies the selected record and its relations (copy with structure).
cp_par | Parameter to control the behavior of this function. Syntax like: "/MODE={R|E|T} /ALL={R|A} /BATCH=<lgv> /N=<fld> /PRE=<usx> /POST=<usx> /BUF=<text> /TPR" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xedb_hierarcy_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Creates an "element structure explosion" for a single selected element.
usxCtx | Menu userexit context. | |||||||||||||||||||||
cp_par | Parameter to control the behavior of this function. Syntax is: "<entity> <list> <table> [/IN_FORM=<form>] [/CTX=<context>] [/CUR_REL={<ENT> | <REL>}]" With possible arguments:
|
0 | OK |
---|---|
-1 | Database error. |
2 | Element has no structure or user canceled this function. |
3 | Element has a recursive structure. |
Else | Error. |
int xedb_iwf_lis_ref | ( | ) |
Select-menu userexit.
cp_name | Parameter to control the behavior of this function. Syntax is: "<entity2> <view> [<listname>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error code from iwf_lis_ref |
int xedb_quantity_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Creates a "element quantity overview" for a single selected element.
usxCtx | Menu userexit context. | |||||||||||||||||||||
cp_par | Parameter to control the behavior of this function. Syntax is: "<entity> <list> <table> [/IN_FORM=<form>] [/CTX=<context>] [/CUR_REL={<ENT> | <REL>}]" With possible arguments:
|
0 | OK |
---|---|
-1 | Database error. |
2 | Element has no structure or user canceled this function. |
Else | Error. |
int xedb_ref_ver | ( | ) |
Select-menu userexit.
par_str | Parameter to open refine list. Syntax is: "<entity2> <view> [<list>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error code from 'iwf_lis_ref' |
int xedb_tre_wlk | ( | ) |
Menu userexit to walk recursively through a complete "tree" structure (for example a Bill of Material) and perform any action by calling a passed userexit.
This userexit will walk through the structure of all selected records.
The complete function will be performed using virtual (relation-)widgets. To open the relation widget, it is not necessary to pass the name of the first (parent) entity, since the parent record will be selected / marked before the userexit to open the relation widget will be called.
cp_Parameter | Parameter to control the behavior of this function. Syntax is: "<relation> /OPN_USX=<usx> /PRM_USX=<usx>[(<param>)] /CALL=<usx>[(<param>)] /CLOSE=<usx>[(<param>)]" With possible arguments:
|
0 | OK |
---|---|
1 | Unable to open relation widget |
// working example int iRc = xedb_tre_wlk("EDB-QUERY STR EDB-QRY-USR-SLI /CALL=xqry_str_exc_call /CLOSE=xqry_str_exc_cls");
int xedb_usage_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Creates an "element usage explosion" for a single selected element.
usxCtx | Menu userexit context. | |||||||||||||||||||||
cp_par | Parameter to control the behavior of this function. Syntax is: "<entity> <list> <table> [/IN_FORM=<form>] [/CTX=<context>] [/TOP] [/CIA]" with possible arguments:
|
0 | OK |
---|---|
-1 | Database error. |
2 | Element has no structure or user canceled this function. |
3 | Element has a recursive structure. |
Else | Error. |
int xeer_req_sel | ( | ) |
Marks all selected records for EER replication.
The selected records are stored in the "SEND_TO" table and the request flag 'W' (wait for replication) is set. The following fields are filled:
Attribute | Value |
---|---|
EDB_ID | The internal ID of the record |
VERSION | The internal version of the record |
TABLE_NAME | The table of the record |
STATE | The state of the record |
DISPATCH_TYPE | The type of the distribution |
MASTER_FLAG | 'y' = Record is a replication master record |
SEND_UID | UIC of the user that created the request |
cp_Parameter | Parameter to control the behavior of this function. Syntax like: "[/DISPATCH=<DispatchType> [/VERSION=<DispatchVersion> | /USE={V|F}]]" with possible arguments:
|
EER_REQ_NO_ERROR | OK |
---|---|
EER_REQ_NO_WIDGET_OPEN | No mask is open |
EER_REQ_MASK_OPEN_ERROR | Can't open default form of T_EER_DIS |
int xfile_bck_up | ( | ) |
Creates a backup of the selected file.
The userexit creates a backup (copy) of the current file in the vault to the backup vault. The backup vault must be of the vault type "BCK" other vault types are permitted.
cp_Parameter | Parameter to control the behaviour of this userexit. Syntax is: "[name of backup vault]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_bck_up("backupVault");
int xfile_chg_are | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit for the file - vault relation mask.
The userexit transfers the selected file from the source vault into the target vault. The target vault name can be passed as parameter.
If there is no target vault passed the user can select the target vault via select widget.
If the file already exists in the target vault, the old file version will be deleted and the current version checked in.
The vault kind of source and target vault must be the same (FMS->FMS, EIF->EIF, PUB->PUB).
The relation would be checked, when the file was distributed before:
State of the source file | State of the target file | Result |
---|---|---|
'A' (current) | 'A' (current) | Change the vault |
'A' (current) | 'N' (not current) | Change the vault |
'N' (not current) | 'N' (not current) | Change the vault |
'N' (not current) | 'A' (current) | Do not change the vault |
context | the trigger context |
param | reserved |
0 | OK |
---|---|
Else | Error |
int xfile_chk_out | ( | ) |
Checks out a file from a vault.
This userexit can be used to check-out a file from a vault.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "<A | O | C | B> [/SERVER=#SERVER] [/DISCPATH=<disc+path>] [/FILE=<filename>]" With possible arguments:
|
0 | OK |
---|---|
1 | Internal error |
10 | Wrong disc+path target to check the file out (in virtual mode) |
16109 | No record selected |
// working example int iRc = xfile_chk_out("C /SERVER=#SERVER /DISCPATH=/tmp/test /FILE=checkout.dat");
int xfile_cki_dis_sec | ( | ) |
Checks in a file into a distributed vault.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "/SEC_AREA=vault /ORG_VERSION=originalVersion /DISCPATH=disc+path /FILE=filename" With possible arguments:
|
0 | OK |
---|---|
1 | Internal error |
2 | Missing option |
3 | Only one selection allowed |
4 | Check-in in the original vault is not allowed |
5 | Vault is not distributed before |
6 | Vault not found |
-10 | Configuration parameter EDB-FIL-OFFLINE-TRANSFER not active |
-11 | Check-in no older version (config parameter EDB-FIL-CKI-OLDVERSION) |
-12 | Check-in version is higher than the original version of the file |
// working example int iRc = xfile_cki_dis_sec("/SEC_AREA=TESTVAULT /ORG_VERSION=1 /DISCPATH=/tmp/test /FILE=checkin.dat");
int xfile_cki_res | ( | ) |
Checks in a file and reset the document reservation.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "[/UNRESERVE] [/DISCPATH=disc+path] [/FILE=filename]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_cki_res("/UNRESERVE /DISCPATH=/tmp/test /FILE=checkin.dat");
int xfile_cko_res | ( | ) |
Checks out a file and reserve the document.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "[/ROC] [/DISCPATH=disc+path] [/FILE=filename]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example // get a read-only copy of the file (the document is not reserved) int iRc = xfile_cko_res("/ROC /DISCPATH=/tmp/test /FILE=checkin.dat"); // get a copy of the file (the document is reserved) int iRc = xfile_cko_res("/DISCPATH=/tmp/test /FILE=checkin.dat");
int xfile_dis_fil | ( | ) |
Distributes a file into another vault.
Multi selection is supported to distribute as set of files.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "[/SOURCE=vault] [/TARGET=vault] [/FILE={Y|N}]" With possible arguments:
|
0 | OK |
---|---|
16101 | Document is not reserved |
16102 | Field not found |
16110 | No current widget |
16112 | Vault not found |
16114 | Wrong parameter format |
// working example int iRc = xfile_dis_fil("/SOURCE=vault1 /TARGET=vault2 /FILE=test.dat");
int xfile_dis_pvm_fil | ( | ) |
Distributes a file into another vault.
Multi selection is supported to distribute as set of files.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "[/SOURCE=vault] [/TARGET=vault] [/FILE={Y|N}]" With possible arguments:
|
0 | OK |
---|---|
16101 | Document is not reserved |
16102 | Field not found |
16110 | No current widget |
16112 | Vault not found |
16114 | Wrong parameter format |
// working example int iRc = xfile_dis_fil("/SOURCE=vault1 /TARGET=vault2 /FILE=test.dat");
int xfile_fil_rep | ( | ) |
Distributes the current file in another vault.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "/MODE={GET|PUT} [/SOURCE=vault] [/TARGET=vault] [/FILE={Y|N}]" With possible arguments:
|
0 | OK |
---|---|
2 | Field STORAGE_AREA or ORG_NAME not found in mask |
3 | Current record is in status 'A', 'E' or 'I' (FILE_STATUS) |
4 | No storage area set |
5 | Different kinds between the storage areas (STORE_KIND) |
99 | Error from file server |
16101 | Document is not reserved |
16102 | Field not found |
16110 | No current widget |
16111 | Parameter not set |
16112 | Vault not found |
16114 | Wrong parameter format |
-1 | File would not be copied, it is actual in distributed vault |
// working example int iRc = xfile_fil_rep("/MODE=GET /SOURCE=vault1 /TARGET=vault2 /FILE=test.dat");
int xfile_get_eif_inf | ( | ) |
Prints the path and filename of the crypted file within the vault of the kind 'EIF'.
The information about the EIF file is shown in the message window.
cp_Parameter | not used |
0 | Ok |
---|---|
1 | Error |
10 | No manager privileges |
11 | Field in mask not found |
12 | Vault not found in definition mask of vaults |
13 | Infos of the file not found (structure) |
14 | Error from the file server call |
99 | No current widget (check virtual mode) |
-10 | Vault is not from the kind EIF |
// working example int iRc = xfile_get_eif_inf("");
int xfile_mov_in | ( | ) |
Moves (copy) the file from the external vault to the original vault.
The userexit resets the file status.
cp_Parameter | not used |
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_mov_in("");
int xfile_mov_out | ( | ) |
Moves a file from the original vault to an external vault The name of the external vault is written into the field T_FILE_DAT.EXTERNAL_AREA and the file status is changed.
To move the file from the original vault in an external vault. This is allowed if the ind of the vaults are equal (FMS->FMS, EIF->EIF, PUB->PUB) only.
If the file is distributed in more than one vaults, it is not moved out in the external vault, the distributed files must be deleted first, unless the files were from the type "BCK".
cp_Parameter | vault name to move the file in [or empty] |
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_mov_out("vault1");
int xfile_ret_bck_up | ( | ) |
Copies a file back from the backup vault into the original vault.
If the backup vault is not passed, the system shows a menu to select a backup vault. The backup vault and the original vault must be from the same vault kind (FMS->FMS, EIF->EIF, PUB->PUB).
cp_Parameter | backup vault to copy the file from it [or empty] |
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_ret_bck_up("vault1");
int xfile_sec_are | ( | ) |
Sets, gets or resets the vault for the global document-file mask.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "/STATUS={G|R|S} /STORE_AREA=vault /USX" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_sec_are("/STATUS=S /STORE_AREA=vault");
int xfile_sel_fil | ( | ) |
Shows a file dialog to select a file for the document - file mask.
cp_Parameter | not used |
0 | OK |
---|---|
1 | Error |
2 | Disc+path+filename to long |
int xfile_set_cop | ( | ) |
Sets the copy mode (COPY or DUPLICATE).
The userexit sets the value "/FILE_MODE={COPY|DUPLICATE}" in the widget buffer of the current widget and calls the function dal_iwf_dup_elm() to duplicate the current record.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "/FILE_MODE={COPY|DUPLICATE}" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_set_cop("/FILE_MODE=COPY");
int xfile_set_flg | ( | ) |
Sets the file status flag.
Sets the status 'A' for moving the file out of the vault.
Sets the status 'E' for moving the file in the vault.
Or resets the file state.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax like: "/CHECK=<OUT|IN> /REQUEST=<Y|N><" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfile_set_flg("/CHECK=OUT /REQUEST=Y");
int xfile_upd_fil | ( | ) |
Copies a file from the current ('A'), origin ('O') or choice ('C') directory into the vault.
The option ('C') allows to set the options DISCPATH and FILE.
The configuration parameter EDB-FIL-CPY-DIS-REF can be used to control the behavior of the userexit during the creation of a new revision of a document.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax: "<A | O | C | B> [/NORESCHECK] [/DISCPATH=<disc+path>] [/FILE=<filename>]" With possible arguments:
|
0 | OK |
---|---|
Else | error |
// working example int iRc = xfile_upd_fil("C /NORESCHECK /DISCPATH=/tmp/test /FILE=checkout.dat");
int xfms_adm_bat_chk_are | ( | ) |
Checks all files in a vault in batch mode.
The select-menu userexit uses the file size stored in the database to validate the checked-in file. The Log file is created in the temp directory of the application (axalant_tmp) with the pre fix "fms_check".
cpPar | not used |
cpIgn | ignored |
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfms_adm_bat_chk_are("");
int xfms_adm_chk_are | ( | ) |
Checks all files in a vault.
The userexit uses the file size stored in the database to validate the checked-in file.
cpPar | not used |
cpIgn | ignored |
0 | OK |
---|---|
Else | error |
// working example int iRc = xfms_adm_chk_are("");
int xfms_adm_chk_fil | ( | ) |
Checks a file in a vault, by using the file size stored in the database.
cpPar | not used |
cpIgn | ignored |
0 | OK |
---|---|
Else | Error |
// working example int iRc = xfms_adm_chk_fil("");
int xfms_chk_pth_acc | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to check if path is allowed.
The directories which are allowed for file transfers are defined in configuration rubric "EDB-FMS-ALLOWED-PATHS". This userexit checks wether the provided path is defined in the configuration list.
context | The trigger context |
param | The absolute path name with terminating "/" (UNIX) or "\" (MS Windows) |
0 | Directory not allowed |
---|---|
1 | Directory allowed |
int xform_dlg_exc | ( | ) |
Starts the dialog steps of selected assistant.
cp_Parameter | Reserved. |
0 | OK |
---|---|
1 | Error |
int xhisto_get_his_all | ( | ) |
Select menu userexit to create a history overview for the selected record.
par_str | Parameter to control the behavior of this function. Syntax is: "listname" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xief_loa_exp_fin | ( | ) |
Writes marked records to a loader file.
All environment variables contained in the filename are substituted with real values. The export is initialized using xloa_exp_ini() with the session id created in xief_loa_exp_rec(). The query part of the loader file will be created without passing a special user / group name or creation / modification date.
This trigger determines the name of all tables with marked records using the following SQL statement (the timestamp is created during the first call of xief_loa_exp_rec()):
select distinct T_REC_DAT.REC_TABLE from T_REC_DAT where T_REC_DAT.USERIDD = <session id> and T_REC_DAT.APPL_KEY = 'XIEF' and T_REC_DAT.INT_VAL = <timestamp>;
Then a loop over all table names is performed and the table description part is created by calling xief_loa_gen_dsc() until the user enters a correct or an empty filename or an error occurs.
The export is finished by calling xloa_exp_fin(). This function does the "real" work and writes the data part to the loader file. Finally the timestamp is reset for the next export order.
cpArguments | Parameter to control the behavior of this function. Syntax like: "[<filename>][/SET_ACCESS_OGW]{/<field>=<value>}*" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
2 | Export has been aborted |
int iRc = xief_loa_exp_fin("/tmp/MyLoaderFile.dat"); // or int iRc = xief_loa_exp_fin("");
int xief_loa_exp_rec | ( | ) |
Marks selected records and related records to be exported.
References to the selected records are stored in the table T_REC_DAT. Before a record can be inserted into T_REC_DAT, a session id has to be generated by calling xrec_get_idd() and a timestamp is created to identify related export orders.
You can call this trigger several times - even for different widgets - and all selected records will belong to the same export order as long as xief_loa_exp_fin() is not executed (calling xief_loa_exp_fin() will reset the timestamp).
The name of the origin and join table is retrieved from the current widget using wdg_ret_tbo() and wdg_ret_tbj() and the corresponding origin and join C_ID is read. This trigger will then perform a loop over all selected rows and will insert records into T_REC_DAT as follows (depending on the present keyword(s)):
Keyword | Action |
---|---|
_ENTITY | If origin table == 'T_ENTIY'
|
_TABLE | If origin table == 'T_TABLE'
|
_MASK | If origin table == 'T_MASK'
|
_MENU | If origin table == 'T_MENU'
|
_ORIGIN |
|
_JOIN |
|
cpArguments | Parameter to control the behavior of this function. Syntax like: "{<ief-format> | (<keyword> )*}" With possible arguments:
|
0 | OK |
---|---|
1 | A C_ID of any selected record is 0 |
2 | IEF format is not yet supported |
3 | Could not activate the widget |
Any other value | EPQ error |
int iRc = xief_loa_exp_rec("_ENTITY _TABLE _MASK _MENU"); // or int iRc = xief_loa_exp_rec("_ORIGIN _JOIN"); // etc., any combination of keywords is allowed ...
int xmgt_men_cnf_emb | ( | ) |
Menu userexit to confirm embodiment of an item typically with a serial number) for a 'Should build' component.
cp_Parameter | Reserved. |
0 | OK |
---|---|
1 | Error |
int xmgt_men_upd_del | ( | ) |
Menu userexit to set records of the 'As built' item structure in update or delete mode.
If the item has an embodiment, the userexit calls the standard update and delete functions. Otherwise it displays an error message.
cp_Parameter | Parameter to control the behavior of this function. Syntax is: "<mode>" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xmtx_opn | ( | ) |
Opens matrix list for selected variant placeholder (item).
cp_Parameter | Parameter to open the matrix list. Syntax like: "<entity_list> [/CID=<parent_cid>]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xntm_opn | ( | ) |
Calls the notes administration for the current record.
cp_par | Parameter to open notes widget. Syntax like: "EDB-NTM <name of notes widget>" |
0 | OK |
---|---|
1 | Error |
int xntree_wlk | ( | ) |
This menu userexit processes a n-dimensional tree structure.
This function may be called as a menu userexit for one or more selected records (in a list/form widget). If no structure is specified the name of the current mask is used as selection criteria to find all possible n-tree structures. The user is then asked to select one of the found structures. The definition of the n-tree structure is loaded into memory. It is necessary to clone the current widget because it is not possible to open a virtual relation widget for a selected master record of an interactive widget. Now the C_ID of each marked record is determined, is saved in a local array and the start-userexit is executed.
Then each marked record is processed:
Finally before removing the cloned virtual widget the end-userexit will be executed (if defined).
cpParameter | Parameter to control the behavior of this function. Syntax like: "[structure [version]] [/PROGRESS /ABORTABLE /NOMSG]" with possible arguments:
| |||||||||||||||
cpIgnore | Default parameter provided by DataView (reserved) |
0 | OK |
---|---|
-3 | User aborted (XNTREE_USER_ABORTED) |
Else | Error |
int xord_cre_ord_str | ( | ) |
Select-menu userexit to create an order specific bill of material.
The selected item is already related to an existing order.
cpParameter | Parameter to control the behavior of this function. Syntax is: "<entity2> {<str_view> | <var_view>} [/VIEW={1|2|3} /DEPTH=depth]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xord_del_ref | ( | ) |
Deletes the complete structure of an order specific bill of material for the selected order.
cp_par | Parameter to control the behavior of this function. Syntax is: "<entity1> <entity2> <view> [<listname>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xord_var_lis | ( | ) |
Opens relation widget with order specific BOM.
cp_par | Parameter to control the behavior of this function. Syntax is: "<entity2> <view>" With possible arguments:
|
0 | OK |
---|---|
1 | Could not get order key. |
int xpdw_frm_acc | ( | const char * | param, |
const char * | ignore | ||
) |
Displays the object access mask.
The object access mask shows the privileges granted to the current object through multi project or multi organization access rights. If the current object is not an entity which is under control of multi project or multi organization access rights (or neither multi project nor multi organization access rights is enabled), the usual DataView access mask is shown. Therefore, this userexit can be used as a drop-in replacement for iwf_frm_acc
.
ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax like: "[/HIGHEST_ONLY][/NO_COLLAPSE_VIEW_ALL]" With possible arguments:
|
0 | OK |
---|---|
1 | Error |
int xpdw_ksa_art_oth_pro | ( | const char * | param, |
const char * | ignore | ||
) |
Assigns an item including its structure and assigned documents to another project or organizational unit.
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_men_add_pro | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to assign an object to an additional principal (project or organizational unit).
The additional principal can either be defined by passing its PROJ_ID
(for projects) or EDB_ID
(for organizational units) as parameter, or it can interactively be selected from a list.
PDW_ASSIGN
relationship. The old principal assignment is unchanged.ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax is: "[principalCid|maskName]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_chg_pro | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to change the generated project of an object.
This userexit changes the PDW_GENERATE
assignment of an object to a project or organizational unit.
ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax like: "[principalCid|maskName]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_cnt_lis | ( | const char * | param, |
const char * | ignore | ||
) |
Wrapper for the userexit wdh_cnt_lis
in a multi access rights environment.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax like: "[/FORCE]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_cpy_str | ( | const char * | param, |
const char * | ignore | ||
) |
Wrapper function for "copy with structure" in a multi access rights environment.
The standard function "Copy with structure" (userexit xcpy_str
) is replaced by this menu userexit when working with multi access rights to take care of the multi access rights views.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax like: "xcpy_str-parameters" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_del_ass_pro | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to delete an assignment from a project or organizational unit of an object.
The assignment with i_Status = PDW_ASSIGN
is deleted from the multi access rights view table.
If no principal-ID is passed, an interactive list is opened to let the user select the project or organizational unit. The list displays all projects or organizational units that are assigned to the object through a PDW_ASSIGN
relationship.
ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax is: "[principal-ID|/ALL]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_del_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Wrapper to call the userexit to delete an object version (xver_del_ver
) in a multi access rights environment.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax is: "xver_del_ver-parameters" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_exi_edt | ( | const char * | param, |
const char * | ignore | ||
) |
Wrapper userexit for the userexit iwf_exi_edt
in a multi access rights environment.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax is: "iwf_exi_edt-parameters" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_men_set_res | ( | const char * | param, |
const char * | ignore | ||
) |
Wrapper userexit to reserve an element in a multi access rights environment.
Checks if access to the record is granted and then calls the userexit xres_set_res
to reserve the element.
usxContext | The userexit context. |
param | Additional userexit parameters. Currently none. |
0 | OK |
---|---|
Else | Error |
int xpdw_men_vfg | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to set or reset the global visibility of an object.
The VIEW_ALL
flag of the selected objects is set or reset. If the VIEW_ALL
flag is set for an object, the object is visible to all users, even if access to the object is not granted through multi access rights.
ctx | The userexit context | |||
param | Parameter to control the behavior of this userexit. Syntax is: "/DO={SET|RESET}" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xpdw_pdw_chg_pro | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to change the explicit assignment of an object to a project or organizational unit.
This userexit changes assignments of the type PDW_ASSIGN
so that the object is explicitly assigned to another project or organizational unit.
ctx | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax is: "[principalCid|maskName]" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xprm_fre_lck | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to unlock the selected users in the user list.
ctx | The userexit context. |
param | Reserved. |
0 | OK |
Else | Error |
int xprm_set_pwd | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to set the password for the selected users in the DataView user list.
ctx | The userexit context. |
param | Parameter to control the behavior of this userexit. Currently none. |
0 | OK |
Else | Error |
int xprt_edt | ( | ) |
Edits the RPG printer definition file (RPG_PDF_DAT) of the selected records.
0 | OK |
---|
int xpvm_bat_doc | ( | const char * | param, |
const char * | ignore | ||
) |
Adds a new document batch job.
The method adds all files of the document, which are viewable with AutoVue to the batch job.
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_bat_fil | ( | const char * | param, |
const char * | ignore | ||
) |
Adds a new file batch job.
The method adds the selected file of the document, which is viewable with AutoVue to the batch job.
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_mrk_doc | ( | const char * | param, |
const char * | ignore | ||
) |
Loads a markup with the assigned base file into the viewer.
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_mrk_doc_new | ( | const char * | param, |
const char * | ignore | ||
) |
Loads the document into the viewer and switch the viewer into markup mode.
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_mrk_fil_new | ( | const char * | param, |
const char * | ignore | ||
) |
Loads the file into the viewer and switch the viewer into markup mode.
context | The context of the userexit |
param | not used |
0 | OK |
---|---|
1 | Error |
int xpvm_set_act | ( | const char * | param, |
const char * | ignore | ||
) |
Select menu userexit to activate a property mapping (is used flag of current property = y, other properties with the same name are set inactive).
context | The context of the userexit |
param | Not used at the moment. |
0 | OK |
---|---|
1 | Error |
int xpvm_set_not_act | ( | const char * | param, |
const char * | ignore | ||
) |
Select menu userexit to inactivate a property mapping (is used flag = n).
context | The context of the userexit |
param | Not used at the moment. |
0 | OK |
---|---|
1 | Error |
int xqry_cnd_sav | ( | ) |
Assigns the query conditions to the logical name given by the user for the query to be stored, and stores the query conditions and condition values in the table T_QRY_CND.
cp_Par | Parameter to control if a 'SAVE' or a 'SAVE AS' option should be performed. The default option is 'SAVE'. Syntax like:
|
0 | OK |
---|---|
1 | Error |
int xqry_dat_rec_sav | ( | ) |
Stores the record Id's of the records which are selected by the user in a form or list.
The record Id's are stored in the table T_REC_DAT and assigned to a logical name entered by the user. The logical name is stored in the table T_QRY_DAT with the type "DAT". (Stored records (type "DAT"), query conditions (type "CND"), or results of a logical connection between more queries (type "STR") can be stored under a logical name). These stored records are accessible later through the correspondent logical name.
cp_Parameter | Syntax like: /SAVE_AS /SILENT /MODE /CURRENT_ONLY
|
0 | OK |
---|---|
1 | Error |
int xqry_rnk_exc | ( | ) |
Menu userexit to perform a 'Best matching'-query for the conditions given in the condition mask.
The query is performed in the initial mask, so that the user can concurrently see the matching records (in the initial mask) and the query conditions (in the condition mask).
cp_Parameter | Parameter to control the behavior of this userexit - reserved. |
lp_Fields | Long array with fields Id of the first condition fields in the condition line. |
0 | OK |
---|---|
1 | Error |
int xqry_str_exc | ( | ) |
Menu userexit to perform a logical query.
(A logical query can have the type "DAT", "CND", "RNK", "AND" or "OR".) If query type is "AND" or "OR" then this logical query is a complex query, that means it has a tree structure of logical connections.
cp_Parameter | Parameter to control the behavior of this userexit, not used yet. |
0 or 2 | OK |
---|---|
1 | Error |
int xqry_str_log_op | ( | ) |
Menu userexit to connect several logical queries by an "AND" or "OR" operation.
The user has to select more then one logical names and choose from the select menu the logical operation to be performed for the selected logical names.
cp_Parameter | Parameter to determine the logical operation to be performed. Syntax like: AND - if a logical "AND" should be performed. OR - if a logical "OR" should be performed. |
0 | OK |
---|---|
1 | Error |
int xrel_mul_res | ( | ) |
For each selected record (or, if the flag /SINGLE is set, just for the first record) the given reservation function is called.
At the beginning, the field-discriptor of the second field of the list (join-C_ID) is set to the current entity name because the multi list can contain more than one different entity.
cp_Parameter | Parameter to control the behavior of this userexit. Syntax like: "/FNC=res_func [/PAR=param] [/SINGLE]" |
With possible arguments:
FNC | functionName | Defines the name of the reservation function. |
---|---|---|
PAR | param | Optional parameter to set parameters for the reservation function. |
SINGLE | Optional flag to call reservation function for first selected record only. |
0 | OK |
1 | Error, name of reservation function is missing |
int xres_opn_res | ( | ) |
Opens form with all information about the reservation of the selected element.
cp_Parameter | Reserved. |
0 | OK |
---|---|
1 | Unable to display reservation information. |
int xres_rst_res | ( | ) |
Resets the reservation of a record.
cp_Parameter | Parameter to control the behavior of this function. Syntax is: "[/FORCE]" With possible arguments:
|
0 | Reset of reservation succeeded, or object was not reserved. |
---|---|
1 | Unable to open reservation widget. |
2 | Reserved by another user. |
3 | Error during reservation. |
4 | No unreservation from document master allowed. |
5 | Document type does not exist. |
int xres_set_res | ( | ) |
Sets the reservation for a record.
cp_Parameter | Parameter to control the behavior of this function. Syntax like: "[/RCODE]" With possible arguments:
|
0 | Reservation was successful. |
---|---|
1 | Record is locked. |
2 | No write access to record. |
3 | Element reserved by another user. |
4 | Element is marked for reservation or number cycle EDB-RES creates negative numbers. |
5 | Error during reservation. |
6 | Unable to open reservation widget. |
7 | No reservation from document master allowed. |
8 | Document type does not exist. |
int xsml_frm_typ | ( | ) |
Select menu userexit for a selected record to open classification or variant list if the record was assigned to a class or variant before.
If the record is assigned to more than one class or variant, then a menu with all correspondent classes or variants is created and the user has to choose one class or variant to be opened.
For the classes of old type (type table) the list is opened, even if option /FRM is given.
cp_Par | Parameter used to open the relation widget (iwf_lis_ref) |
e.g. | for sml: EDB-GROUP EDB-ARTICLE ATT EDB-GRP-ART-RLI |
for | variants: EDB-ARTICLE EDB-ARTICLE ATT EDB-ART-ATT-RLI |
NULL | The standard list and the view ATT is used. |
/FRM | The classification form is opened instead of the list |
0 | OK | |
---|---|---|
1 | No selected record | |
2 | Database error by opening classification list | |
3 | The record is not assigned to any class | |
4 | User has no read access for the classification list | |
5 | The record is assigned to more than one classification list and the user canceled the selection from the class menu | |
6 | No classification form was created for the selected record | |
Else | Other error |
int xsmlc_upd_att | ( | ) |
Select menu userexit to update the attribute fields in item head form and attribute folder.
Is used by LogiView when the class attributes folder becomes active.
cp_Arguments | Userexit parameter, syntax like: "/FATWDG=WdgId /CLASSID=ClassId /UPDSON" With possible arguments:
|
0 | OK | |
---|---|---|
1 | No FATWDG=Id option | |
2 | No CLASSID=Id option | |
3 | Error by updating attributes in form | |
4 | Error by updating attributes in sublist | |
Else | Other errors |
int xsmlc_usr_sav | ( | ) |
Select menu userexit for class form to save the user specific settings for the current class.
cp_Parameter | Userexit parameter, reserved. |
0 | OK |
---|---|
Else | Error |
int xsmldf_cre_typ_ref | ( | ) |
Select menu userexit to reorganize the class of TYP type.
For all selected TYP classes creates the type table.
0 | OK |
---|---|
Else | Error |
int xsmldf_del_sml | ( | ) |
Select menu userexit to delete the class definition for the selected TYP class.
par | Userexit parameter, syntax like:
|
0 | OK |
---|---|
Else | Error |
int xsmldf_sml_def | ( | ) |
Select menu userexit for class mask to create the type table for classes of TYP type (one type table for each class) or a classification form for ATT.
The template for the class form (ATT classes) is defined by the configuration parameter EDB-GTM-SUB-<entity_name>. A further configuration parameter EDB-GTM-ONE-PER-ROW decides if each attribute will be positioned in a new line in the form (parameter has the value ON) or consecutively (value is OFF and if not enough space is available, then the attribute is positioned in the next line). The default value for EDB-GTM-ONE-PER-ROW is OFF. If the configuration parameter EDB-GTM-TIT has the value 1 or 'on', then the attribute name is used as attribute title (otherwise the attribute letter will be displayed as attribute title).
cp_Parameter | Userexit parameter, syntax like:
|
0 | OK |
---|---|
Else | Error |
int xstate_ask_nxt_sta | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to display the possible next release steps for an object.
The possible next states for members of the current group are displayed in the client's message window.
usxContext | The userexit context. |
param | Reserved. |
0 | OK |
---|---|
Else | Error occurred. |
int xstate_frm_nxt_sta | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to open the state form instead of the state menu.
The state form contains the main record fields and buttons to change the state into a new one. This userexit can be called instead of xstate_nxt_sta.
/USX = iwf_frm_lis /PAR= EDB-ARTICLE EDB-CHK-ART-CFR F>EDB-STA-SBF-GE
usxContext | The userexit context. | ||||||
param | Parameter to control the behavior of this userexit. Syntax like: "/USX=usxName /PAR=usxParam" with possible arguments:
|
0 | OK |
---|---|
1 | Error occurred. |
int xstate_nxt_sta | ( | const char * | param, |
char * | ignore | ||
) |
Menu userexit that performs a lifecycle transition for selected elements.
This userexit implements the execution of lifecycle transitions to transfer elements from one state into another.
Processing of slave transitions:
xstate_get_nxt_sta
) for slave release procedures (controlled by flag i_slave). Due to the static definition of the variables, the data necessary to process the master release procedure is already known. This mechanism prevents the userexit from querying the next state again if branches are used. "/LEV=<new_progress_indicator> /OWN=<new_owner_uic> /GRP=<new_group_gic> /AOW=<access_owner> /AGR=<access_group> /AWO=<access_world> /PRE=<pre_action> /POS=<post_action> /DID=<distribute_id> /DCA=<distributor_id> /SIG=<signi_str> /PAR=<task_id> /PRL=<new_dev_sta> /NRS=<new_rel_sta> [/SYS]" /SYS indicates if the system flag is set.
This userexit cannot be used for refine elements. Please refer to the userexit xstr_nxt_sta
!
usxContext | The userexit context. | ||||||||||||||||||
param | Parameter to control the behavior of this userexit. Syntax like: "level /PAR=task-id /SYSTEM [/NO_HIST] [/FROM=ValFrom] [/UNTIL=ValUntil]" with possible arguments:
|
xstate_nxt_sta (220 /SYSTEM) system transition to state 220 xstate_nxt_sta (120 /PAR=2) confirm task 2 of current state xstate_nxt_sta (230) transition to state 230 xstate_nxt_sta () use menu
0 | OK |
---|---|
25 | Record missing in action. |
Else | Error occurred. |
int xstr_ask_nxt_sta | ( | const char * | param, |
const char * | ignore | ||
) |
Menu userexit to print out information about the possible next release steps for members of the current group when releasing a relation record.
usxContext | The userexit context. |
param | Reserved. |
0 | OK |
---|---|
Else | Error occurred. |
int xstr_nxt_sta | ( | const char * | param, |
char * | ignore | ||
) |
Menu userexit to change the state of a relation record.
It will be checked if the current group has the permission to execute this function. If the release step has been successful, the new status will be set. If enabled in the configuration settings, a mail will be sent to the respective users/groups. Owner and access of the element may be modified according to the used release procedure (e.g. 'STANDARD'). This function does not release any reserved elements. This userexit can only be used for relation records. Please refer to the userexit 'xstate_nxt_sta'. The configuration parameter EDB-CRM-STR-STA-EQL can be used to enable the transfer of more records simultaneously without requesting a new level indicator for each element.
usxContext | The userexit context. | |||||||||||||||
param | Parameter to control the behavior of this userexit. Syntax like: "LEV_IND [/PAR=taskId] [/SYSTEM] [/FROM=ValFrom] [/UNTIL=ValUntil]" with possible arguments:
[ |
int xtxt_tmp_men_rep | ( | const char * | param, |
const char * | ignore | ||
) |
Select-menu userexit to create a report regarding Text Management.
ctx | Context of the userexit | |||||||
param | Parameter to control the behavior of this function. Syntax is: "/TYPE=<report type> /PARAM=<list of columns to include> /ENCODING=<encoding scheme>" With possible arguments:
|
0 | OK |
---|---|
Else | Error |
int xtxt_whr_use_up1_men | ( | const char * | param, |
const char * | ignore | ||
) |
Tries to update a single entry from the Where-Used result list.
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 xvar_cal_mas_gen | ( | ) |
Select menu userexit to start the mask generator for the variant form created for the current variant.
If the current user does not have manager privileges, then an error message is displayed on the screen.
cp_Parameter | Userexit parameter, reserved. |
0 | OK |
---|---|
Else | Error |
int xvar_opn_var_prf | ( | ) |
Select menu userexit to open a list with prefered variants (mask EDB-ART-VAR-PRF-RLI).
cp_Parameter | Userexit parameter, reserved |
0 | OK |
---|---|
Else | Error, e.g. unable to the open variant list or the VAR_NUM field does not exist in the opened list. |
int xvar_var_lis | ( | ) |
Select menu, opens the variant list or variant form (for variants of type VARATT) for a selected variant.
The head form name is given by the configuration parameter EDB-VAR-FRM. The subform has the name EDB-VAR-x-SFR (where x is the variant number).
par | Userexit parameter, syntax like: [Entity_name /FRM /SUBLIS] with: Entity name (usually EDB-ARTICLE)
|
0 | OK | 1 | Error, the selected element is not a variant or the variant list does not exist yet | |
---|---|---|---|---|
Else | Other error |
int xvardf_del_var | ( | ) |
Select menu userexit to delete the attributes definition for the selected variant.
If a modern form (variant is of type VARATT) was created for this variant, then the form is deleted (regardless of parameter value).
Example: y /TABLE=T_CUSTOM_FLD can be used when the variant attribute defini- tions must be deleted. In this case T_CUSTOM_FLD is the name of the variant table to be used.
cp_Parameter | Userexit parameter for variants of type VAR (configuration parameter EDB-VAR-TYP has value ATT), syntax like: y or n /TABLE with:
|
0 | OK |
---|---|
Else | Error |
Sel menu usx to delete definitions of variant placeholder.
int xvardf_var_def | ( | ) |
Select menu userexit to create the table and mask for variants of type 'ATT' (mask EDB-ART-VAR-SLI or EDB-ART-VAR-SFR).
For the variants of type 'VARATT' a new form will be created with the name from configuration parameter EDB-VAR-SUB.
cp_Parameter | Userexit parameter, syntax like: entity /NOCONFIRM /MASGEN with:
|
0 | OK |
---|---|
Else | Error |
int xver_agg_ver | ( | ) |
Opens aggregate list with predecessor of selected record.
par_str | Parameter to open aggregate list. Syntax like: "entity2 view [list]" With possible arguments:
|
0 | OK |
---|---|
else | Error code from 'iwf_lis_agg' |
int xver_cre_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Creates a new revision of an element.
usxCtx | The menu userexit context for this userexit. | |||||||||||||||||||||||||||||||||||||||||||||||||||
param | Parameter to control the behavior of this function. Syntax like: "key [/MODE={R|E}] [/BATCH=lgv] [/N=field] [/PRE=usx] [/POST=usx] [/BUF=text] [/NO_E=entityname] [/TPR]" With possible arguments:
|
C-code example for handling with widget buffer: char ca_CID[11]; char *cp_Buff; DtvHandle wdg, l_OldCid; ... wdg = zag_ret_dst (); if (wdg == 0) wdg = dal_wdg_ret_act(NULL); cp_Buff = dal_wdg_ret_buf (NULL, wdg); if (zag_get_buf_elm (cp_Buff,"CRE_VER",ca_CID) == 0) sscanf (ca_CID, "%ld", l_OldCid);
0 | OK |
---|---|
1 | No new revision was created. |
2 | Error in function "xedb_cop_fil()" from function "dal_wdh_wri_lis(NULL)". |
int xver_del_ver | ( | const char * | param, |
const char * | ignore | ||
) |
Deletes the selected revision (current element).
Algorithm sequence:
usxCtx | The menu userexit context for this userexit. | ||||||||||||||||||||||||
param | Parameter to control the behavior of this function. Syntax is: "ENTITY2 VIEW [/CHECK={N|NF|Y}] [/CHECK_SLAVE] [/REPORTERROR]" With possible arguments:
|
0 | OK |
---|---|
-1 | Out of memory |
-2 | Delete statement failed (only if /REPORTERROR flag is set). |
int xver_del_ver_pur | ( | const char * | param, |
const char * | ignore | ||
) |
Deletes the selected revision (current element).
Algorithm sequence:
usxCtx | The menu userexit context for this userexit. | ||||||||||||||||||||||||
param | Parameter to control the behavior of this function. Syntax like: "ENTITY2 VIEW /CHECK={N|NF|Y} [/CHECK_SLAVE] [/REPORTERROR]" With possible arguments:
|
0 | OK |
---|---|
-1 | Out of memory |
-2 | Delete statement failed (only if /REPORTERROR flag is set). |
int xver_ref_ver | ( | ) |
Opens refine list with successor of selected record.
par_str | Parameter to open refine list. Syntax like: "entity2 view [list]" With possible arguments:
|
0 | OK |
---|---|
else | Error code from 'iwf_lis_ref' |
int xwfl_prc_abort | ( | ) |
Menu userexit to cancel a process.
cpPar | Default parameter (currently not used). |
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
// working example int iRc = xwfl_prc_abort("");
int xwfl_prc_chg_own | ( | const char * | param, |
const char * | ignore | ||
) |
Opens a dialog to change the owner of the process.
context | |
param | The name of the mask for the dialog |
int xwfl_prc_resume | ( | ) |
Menu userexit to resume a process.
cpPar | Default parameter (currently not used). |
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
// working example int iRc = xwfl_prc_resume("");
int xwfl_prc_start | ( | ) |
Menu userexit to start a process.
cpPar | Default parameter (currently not used). |
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
// working example int iRc = xwfl_prc_start("");
int xwfl_prc_suspend | ( | ) |
Menu userexit to suspend a process.
cpPar | Default parameter (currently not used). |
cpIgn | Default parameter (currently not used). |
0 | OK |
---|---|
1 | Error |
// working example int iRc = xwfl_prc_suspend("");
int zag_dlg_iwf_lis_ref | ( | ) |
Opens refine list for selected records.
Select menu userexit to open the refine list for the selected records. You need at least 'r'ead access for the entity records.
cp_name | Parameter to control the behavior of this function. Syntax (as for iwf_lis_ref): "<entity2> <view> [<listname>]" With possible arguments:
|
0 | OK |
---|---|
Else | Error code of iwf_lis_ref |
int zag_mas_opn_xas | ( | ) |
Select menu/button userexit that opens widget for current record.
cpPar | Parameter to control the behavior of this function. Syntax like: "[/SRC=src_fld] [/DST=dst_fld] /USX=usx_nam /PAR=usx_par" With possible arguments:
| ||||||||||||
cpIgnore |
0 | OK |
---|---|
ERR_ZAG_HYP_ILL_PARAM | Illegal parameter. |
ERR_ZAG_HYP_NO_WDG | No current widget. |
ERR_ZAG_HYP_NO_FLD | No such field. |
ERR_ZAG_HYP_ROW | Illegal row. |
ERR_ZAG_HYP_UPD_LIS | Error in wdh_upd_lis. |
// Select menu/button userexit in item structure widget: zag_mas_opn_xas (/SRC=PART_ID /DST=PART_ID /USX=bvb_usx_opn_ent /PAR="EDB-ARTICLE /EDB-L=EDB-ART-SLI /EDB-F=EDB-ART-CFR")
int zag_men_wri | ( | ) |
Writes text of selected menu selection into the current field.
Menu userexit to write the text of the passed menu selection into the current field. To use another text than this selection, a corresponding string may be passed to this userexit. The purpose of this userexit is:
cp_Parameter | Parameter to control the behavior of this function. Syntax is: "[<value>] [/NO_FLD_USX] [/NO_CLEAR]" with possible arguments:
|
0 | OK |
---|---|
1 | Error in pre- or post-field userexit. |
-1 | Error: No current menu, field or row. |