E9 Workflow Form Frontend API Quick Reference

Goal: quickly locate the right WfForm API by scenario. This version keeps API names, constants, config keys, and important constraints, while removing screenshots, long demos, and repeated explanations.

Basic Rules

#

• Global object: window.WfForm; most code uses WfForm directly.
• Mobile check: WfForm.isMobile(); backend code can read _ec_ismobile.
• Frontend entry points: template code blocks, route-level custom pages, and app-level global custom pages.
• Do not import init_wev8.js in route-level or global custom pages.
• Prefer WfForm APIs for field operations. Avoid jQuery("#field111").val() and do not mutate form fields with raw DOM APIs.
• Field mark format: main fields look like field111; detail fields look like field111_0.
• viewAttr: 1 read-only, 2 editable, 3 required, 4 hide field label and content, 5 hide the whole row.

Open Workflow Forms

#

Action Events

#

Before-action Guards

#

WfForm.registerCheckEvent(type, fn) runs before the action. The callback must call callback() to continue; otherwise the action is blocked.

jQuery(function () {
  WfForm.registerCheckEvent(WfForm.OPER_SUBMIT, function (callback) {
    // Continue after custom validation.
    callback();
  });
});

After-action Hooks

#

WfForm.registerAction(actionName, fn) runs after the action.

WfForm.registerAction(WfForm.ACTION_ADDROW + '1', function (index) {
  console.log('new row index:', index);
});

Field APIs

#

const field = WfForm.convertFieldNameToId('zs');
WfForm.changeFieldValue(field, { value: 'text value' });

WfForm.changeFieldValue('field11_2', {
  value: '2,3',
  specialobj: [
    { id: '2', name: 'Zhang San' },
    { id: '3', name: 'Li Si' }
  ]
});

Field Events and Custom Rendering

#

WfForm.bindFieldChangeEvent('field27555,field27556', function (obj, id, value) {
  console.log(id, value);
});

Detail-table APIs

#

const rows = WfForm.getDetailAllRowIndexStr('detail_1');
(rows ? rows.split(',') : []).forEach(function (rowIndex) {
  const value = WfForm.getFieldValue('field222_' + rowIndex);
  console.log(value);
});

Global APIs

#

Field-type APIs

#

WfForm.appendBrowserDataUrlParam('field111', { cus_type: 'A' });
WfForm.controlDateRange('field222_0', '2019-05-01', '2019-05-31');

Sign Remark APIs

#

Legacy E8 Compatibility

#

Common System Config

#

These settings usually affect all workflow forms in the current Ecology system. Confirm scope before changing them.

Common CSS Cases

#

Other Scenario

#

• Refresh the mobile workflow list after submitting from a heterogeneous mobile system: redirect to current Ecology server URL + '/workflow/workflow/WfRefreshList.jsp'.
• If mobile access uses a reverse proxy, use the proxy-facing server address.

AI Lookup Keywords

#

• Field values: getFieldValue, changeFieldValue, specialobj, changeMoreField.
• Field state: changeFieldAttr, getFieldCurViewAttr, viewAttr.
• Linkage: triggerFieldAllLinkage, bindFieldChangeEvent, bindDetailFieldChangeEvent.
• Detail rows: addDetailRow, delDetailRow, getDetailAllRowIndexStr, getDetailRowCount.
• Browser fields: appendBrowserDataUrlParam, getBrowserShowName, overrideBrowserProp.
• Select fields: removeSelectOption, controlSelectOption, getSelectShowName.
• Sign remarks: getSignRemark, setSignRemark, appendSignEditorBottomBar.
• Config: updateWfConfig, support_html_textarea_field, MobileWFOfficeSign.properties.