- priorityReady(localJson)
Called when GWT has loaded and API can be used.
- login(configuration, successCallback, errorCallback)
Initalization
- formStart(form, onShowMessgeFunc, onUpdateFieldsFunc, dname, successCallback, errorCallback, autoRetrieveFirstRows)
Start a form. Should be called once for each form.
- procStart(name, type, progressCallback, dname, successCallback, errorCallback)
Start a procedure/report.
- LoginSuccessCallback :
function - LoginErrorCallback :
function - FormStartSuccessCallback :
function - FormStartErrorCallback :
function - SetActiveRowSuccessCallback :
function - SetActiveRowErrorCallback :
function - ChooseSuccessCallback :
function - ChooseErrorCallback :
function - SearchActionSuccessCallback :
function - SearchActionErrorCallback :
function - FieldUpdateSuccessCallback :
function - FieldUpdateErrorCallback :
function - SaveRowSuccessCallback :
function - SaveRowErrorCallback :
function - StartSubFormSuccessCallback :
function - StartSubFormErrorCallback :
function - GetRowsSuccessCallback :
function - GetRowsErrorCallback :
function - NewRowSuccessCallback :
function - NewRowErrorCallback :
function - EndCurrentFormSuccessCallback :
function - EndCurrentFormErrorCallback :
function - UndoSuccessCallback :
function - UndoErrorCallback :
function - DelRowSuccessCallback :
function - DelRowErrorCallback :
function - ClearRowsSuccessCallback :
function - ClearRowsErrorCallback :
function - SetSearchFilterSuccessCallback :
function - SetSearchFilterErrorCallback :
function - SetSimpleSearchFilterSuccessCallback :
function - SetSimpleSearchFilterErrorCallback :
function - ClearSearchFilterSuccessCallback :
function - ClearSearchFilterErrorCallback :
function - ActivateStartSuccessCallback :
function - ActivateStartErrorCallback :
function - ActivateEndSuccessCallback :
function - ActivateEndErrorCallback :
function - UploadFileSuccessCallback :
function - UploadFileErrorCallback :
function - GetFileUrlSuccessCallback :
function - GetFileUrlErrorCallback :
function - addTextSuccessCallback :
function - addTextErrorCallback :
function - isAliveSuccessCallback :
function - isAliveErrorCallback :
function - ProcSuccessCallback :
function - ProcProgressCallback :
function This callback is used to update progress bar (called only when the procedure starts a program that reports progress). Note that if the procedure activates a process that doesn't report progress, or delays for other reason (for example: long running query), this callback WOULD NOT be called. So, it is recommended to use some action indicator always! Change it to a percentage indicator when this callback is called.
- ProcErrorCallback :
function - ProcOpenChooseCallback :
function - ProcSearchActionCallback :
function
Kind: global class
- Message
- .message :
string - .messagetype :
string
- .message :
Message text
Kind: instance property of Message
Message type
Kind: instance property of Message
Kind: global class
- Form
- instance
- .setActiveRow(row, onSuccess, onError)
- .choose(fieldName, fieldVale, onSuccess, onError)
- .searchAction(action, searchText, onSuccess, onError)
- .fieldUpdate(fieldName, fieldValue, onSuccess, onError)
- .warningConfirm(okCancel)
- .saveRow(backToParentForm, onSuccess, onError)
- .startSubForm(formName, onShowMessgeFunc, onUpdateFieldsFunc, onSuccess, onError)
- .getRows(fromRow, onSuccess, onError)
- .newRow(onSuccess, onError)
- .endCurrentForm(onSuccess, onError)
- .undo(onSuccess, onError)
- .delRow(onSuccess, onError)
- .clearRows(onSuccess, onError)
- .setSearchFilter(filter, onSuccess, onError)
- .setSimpleSearchFilter(filter, onSuccess, onError)
- .clearSearchFilter(onSuccess, onError)
- .activateEnd(onSuccess, onError)
- .uploadFile(fieldName, fieldValue, file, onSuccess, onError)
- .cancelFileUpload()
- .getFileUrl(filename, onSuccess, onError)
- .saveText(text, addFlag, signatureFlag, secondaryLanguageFlag, onSuccess, onError)
- .isAlive(onSuccess, onError)
- static
- instance
Goto row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| row | number |
Row number. |
| onSuccess | SetActiveRowSuccessCallback |
called on success. |
| onError | SetActiveRowErrorCallback |
called on error. |
Open choose/search in specified field.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| fieldName | string |
Name of field (for example CUSTNAME). |
| fieldVale | string |
Current value in field. |
| onSuccess | ChooseSuccessCallback |
called on success. |
| onError | ChooseErrorCallback |
called on error. |
Perform an action in search dialog.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| action | number |
One of: Next(1),Prev(2),TypeChange(3),TextChange(4),StartChange(5),IgnoreCaseChanged(6) |
| searchText | string |
the text to search for. |
| onSuccess | SearchActionSuccessCallback |
called on success. |
| onError | SearchActionErrorCallback |
called on error. |
Update value in field.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| fieldName | string |
Name of field. |
| fieldValue | string |
Current value in field. |
| onSuccess | FieldUpdateSuccessCallback |
called on success. |
| onError | FieldUpdateErrorCallback |
called on error. |
Confirm a warning message. After returning from the server this function calls 'onSuccess' / 'onError' function of the last API call.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| okCancel | boolean |
1: ok, 0: cancel |
Save changes in current active row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| backToParentForm | number |
0: stay in current row after save, 1: For Sub-Form only. go back to parent form and set active row to parent row. |
| onSuccess | SaveRowSuccessCallback |
called on success. |
| onError | SaveRowErrorCallback |
called on error. |
Starts a Sub-Form and sets the position of the active row to the first row of the Sub-Form.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| formName | string |
for example: ORDERITEMS. |
| onShowMessgeFunc | object |
callback function for handling error and warning messages (If null the main form callback is called). |
| onUpdateFieldsFunc | object |
callback function for handling field updates (If null the main form callback is called). |
| onSuccess | StartSubFormSuccessCallback |
called on success. |
| onError | StartSubFormErrorCallback |
called on error. |
Returns rows data of current form. Note: GetRows without a filter returns rows that have already been retrieved. It doesn't retrieve new rows.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| fromRow | number |
The position of the first row to be retrieved. |
| onSuccess | GetRowsSuccessCallback |
called on success. |
| onError | GetRowsErrorCallback |
called on error. |
Opens a new row in the current form. Set the position of the active row to this row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | NewRowSuccessCallback |
called on success. |
| onError | NewRowErrorCallback |
called on error. |
Exits the current form. On a Sub-Form sets the active row to the parent row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | EndCurrentFormSuccessCallback |
called on success. |
| onError | EndCurrentFormErrorCallback |
called on error. |
Undo unsaved changes in current row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | UndoSuccessCallback |
called on success. |
| onError | UndoErrorCallback |
called on error. |
Deletes current row.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | DelRowSuccessCallback |
called on success. |
| onError | DelRowErrorCallback |
called on error. |
Clear all rows in a top level form. Doesn't delete rows!
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | ClearRowsSuccessCallback |
called on success. |
| onError | ClearRowsErrorCallback |
called on error. |
Sets a search filter in top level form. Following calls to GetRows() function will use this filter until cleared or replaced by another filter.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| filter | Object |
the filter is an Object of the form: { or: (number), ignorecase: (number), QueryValues: [{ field: (string), fromval: (string), toval: (string), op: (string), sort: (number), isdesc: (number), }, { ... }] } or: 0: and, 1: or (operator to be used between ALL conditions). ignorecase: 0: case sensitive, 1: case insensitive. field: field name (for example: CUSTNAME) fromval: value toval: to value - if tovalue is not empty then condition is always: field >= fromval AND field <= toval, if tovalue is empty, then condition is: field op fromval. op: one of "=", "<", "<=", ">", ">=", "<>" sort: 0: no sort, other value: position of field in ORDER BY. isdesc: 0: ASC, 1: DESC Note: Filter MUST include all fields. Note: every field can appear only once in the filter. Note: The search is from the beginning of form field values. values such as "100", the "" in the beginning will be ignored. |
| onSuccess | SetSearchFilterSuccessCallback |
called on success. |
| onError | SetSearchFilterErrorCallback |
called on error. |
Sets a simple search filter in top level form. Following calls to GetRows() function will use this filter until cleared or replaced by another filter.
Note: The search is from the beginning of form field values. values such as "100", the "" in the beginning will be ignored.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| filter | string |
string to be searched for in the fields marked as search fields. |
| onSuccess | SetSimpleSearchFilterSuccessCallback |
called on success. |
| onError | SetSimpleSearchFilterErrorCallback |
called on error. |
Clears search filter for the top level form. Following calls to GetRows() will not use a filter.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | ClearSearchFilterSuccessCallback |
called on success. |
| onError | ClearSearchFilterErrorCallback |
called on error. |
Should be called after a direct activation (which runs in foreground) ends, In order to refresh form data.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | ActivateEndSuccessCallback |
called on success. |
| onError | ActivateEndErrorCallback |
called on error. |
Upload a file in an attachment field to server.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| fieldName | string |
name of attachment field. |
| fieldValue | string |
current value in attachment field. |
| file | Object |
A File Object (This object can be obtained from a HTML tag in the page). |
| onSuccess | UploadFileSuccessCallback |
called on success and progress. |
| onError | UploadFileErrorCallback |
called on error. |
Cancels current file uploading. After canceling te {UploadFileSuccessCallback}onSuccess callback is called from the 'UploadFile' request. The values of {ResultObj} result are : progress = -1 , isLast=1, file="".
Kind: instance method of Form
Translate attachment path to URL. For example: ../../system/mail/201611/enxjf/1.pdf ==> https://servername/primail/201611/enxjf/1.pdf
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| filename | string |
the Attachment path. |
| onSuccess | GetFileUrlSuccessCallback |
called on success. |
| onError | GetFileUrlErrorCallback |
called on error. |
add text to text form.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| text | string |
the new text to add (may be plain text or html). |
| addFlag | boolean |
add new text to existing text (1), or add new text and delete existing text (0). |
| signatureFlag | boolean |
Automatically add user signature (1). Don't add signature (0). |
| secondaryLanguageFlag | boolean |
Signature in primary system language (0), or secondary system language (1). |
| onSuccess | addTextSuccessCallback |
called on success. |
| onError | addTextErrorCallback |
called on error. |
Check if form is alive.
Kind: instance method of Form
| Param | Type | Description |
|---|---|---|
| onSuccess | isAliveSuccessCallback |
called on success. |
| onError | isAliveErrorCallback |
called on error. |
Start a Direct activation.
Kind: static method of Form
| Param | Type | Description |
|---|---|---|
| ename | string |
Name of procedure/report. |
| type | string |
Type ("R" for report, "P" for procedure) |
| progressCallback | ProcProgressCallback |
notify progress. |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Kind: global class
- Proc
- .message(ok, successCallback, errorCallback)
- .reportOptions(ok, selectedFormat, successCallback, errorCallback)
- .reportOptions(ok, selectedFormat, pdf, successCallback, errorCallback)
- .inputFields(ok, data, successCallback, errorCallback)
- .inputOptions(ok, selection, successCallback, errorCallback)
- .inputHelp(ok, successCallback, errorCallback)
- .continueProc(successCallback, errorCallback)
- .cancel(successCallback, errorCallback)
- .choose(fieldId, value, data, successCallback, errorCallback)
- .searchAction(fieldId, value, action, data, successCallback, errorCallback)
Call after a message is approved or canceled.
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel (If only one button can send either). |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after reportOptions step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel. |
| selectedFormat | number |
selected format. |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after documentOptions step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel. |
| selectedFormat | number |
selected format. |
number |
1: PDF, 2: HTML. | |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after inputFields step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel. |
| data | Object |
Input fields data (JSON): { EditFields: [ { field: (number) - field ID value: (string) - field value op: (number) - operator ID value2: (string) - value2 op2: (number) - operator2 ID } ... ] } |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after inputOptions step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel. |
| selection | number |
selected option ID. |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after inputHelp step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| ok | number |
1: OK, 0: Cancel. |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Call after every other step
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Cancel procedure.
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Open Choose or Search.
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| fieldId | number |
ID of field. |
| value | string |
current value in field. |
| data | Object |
Data in all fields (Choose/Search may be dependent on other fields values). { ChooseFields: [ { field: (number) - field ID value: (string) - field value } ... ] } |
| successCallback | ProcOpenChooseCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Perform action in search dialog.
Kind: instance method of Proc
| Param | Type | Description |
|---|---|---|
| fieldId | number |
ID of field. |
| value | string |
current value in field. |
| action | number |
One of: Next(1),Prev(2),TypeChange(3),TextChange(4),StartChange(5),IgnoreCaseChanged(6) |
| data | Object |
Data in all fields (Search may be dependent on other fields values). { ChooseFields: [ { field: (number) - field ID value: (string) - field value } ... ] } |
| successCallback | ProcSearchActionCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Kind: global class
type of error ("NotSupported" / "ServerBusy" / "Error")
Kind: instance property of ProcError
Error text
Kind: instance property of ProcError
Called when GWT has loaded and API can be used.
Kind: global function
| Param | Type | Description |
|---|---|---|
| localJson | json |
Local Json configuration file.When calling PriInit another file can be loded from a different place. |
Initalization
Kind: global function
| Param | Type | Description |
|---|---|---|
| configuration | Object |
Configuration Object of the form: { url: (string), tabulaini: (string), language: (number), company: (string), appname: (string), username: (string), password: (string), devicename: (string) } url: URL to Priority WCF service without the "wcf/wcf/service.svc" part. tabulaini: tabula.ini file name. language: language number. company: The name of the company in Priority. appname: Application Name - (Can be accessed in form triggers using form variable :FORM_APP_NAME) username: Username. password: Password. devicename: Name of device (additional information that is logged in the connection log). |
| successCallback | LoginSuccessCallback |
called on success. |
| errorCallback | LoginErrorCallback |
called on error. |
formStart(form, onShowMessgeFunc, onUpdateFieldsFunc, dname, successCallback, errorCallback, autoRetrieveFirstRows)
Start a form. Should be called once for each form.
Kind: global function
| Param | Type | Description |
|---|---|---|
| form | string |
Name of form. |
| onShowMessgeFunc | object |
callback function for handling error and warning messages. |
| onUpdateFieldsFunc | object |
callback function for handling field updates. |
| dname | string |
name of company in which form is started. |
| successCallback | FormStartSuccessCallback |
called on success. |
| errorCallback | FormStartErrorCallback |
called on error. |
| autoRetrieveFirstRows | number |
1: after starting the form, first rows are retrieved. else: this function only starts the form. |
Start a procedure/report.
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | string |
Name of procedure/report. |
| type | string |
Type ("R" for report, "P" for procedure) |
| progressCallback | ProcProgressCallback |
notify progress. |
| dname | string |
company name in which the procedure should run. |
| successCallback | ProcSuccessCallback |
called on success. |
| errorCallback | ProcErrorCallback |
called on error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| form | Form |
Form Object. |
| formData. | Object |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
Choose Object/Search Object/null |
| type | String |
"Choose" / "Search" / "None". |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
Search object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| form | Form |
Form Object. |
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. a JSON object of the form: { progress: (number), isLast: (number), file: (string) } where: progress: a number between 0 and 100 indicating the progress of the upload. isLast: is upload finished. file: if upload finished, the name of the file that must be placed in the attachment field. (Afterwards FormFieldUpdate API function should be called to notify the server on the change) |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | ResultObj |
result object. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | number |
1: alive, 0: not alive. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| errorMessage | string |
Error message. |
| isFatal | boolean |
Is fatal error. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| data | Object |
result data. data may be of the following structures: 1) Input Dialog with input fields: { type: "inputFields", input: { EditFields: [ { columntype: (string) - "Str" / "Rstr" / "Bool" / "Real" / "Int" / "Date8" / "Date10" / "Date14" / "Time5" / "Time6" field: (number) - field ID helpstring: (string) - field help text isboolean: (boolean) - is field boolean ispassword: (boolean) - is field password mandatory: (boolean) - is field mandatory operator: (number) - default operator (saved from last run) readonly: (boolean) - is field readonly (values come from choose) title: (string) - field title value: (string) - default value (saved from last run) value1: (string) - default value1 (when operator is "between") width: (number) - field width zoom: (string - "None" / "Attach" / "Search" / "Choose" / "Zoom" / "Date14" / "Date8" / "Date10" / "EMail" / "URL" / "HiddenZoom" / "LinkFile" / "QEdit" / "SpecialAttach" } ... ], Operators: [ { name: (string) - operator name op: (number) - operator ID title: (string) - operator title } ... ], text: (string) - help text title: (string) - title of dialog } } 2) Input dialog with choose field (In web interface shows radio buttons, if more then 8 choose options shows listbox): { type: "inputOptions", input: { Options: [ { field: (number) - option ID help: (string) - help text name: (string) - option name selected: (boolean) - is option selected (only one is selected) title: (string) - option title } ... ], text: (string) - help text, title: (string) - title of dialog } } 3) help dialog (Show help text with OK, Cancel buttons) { type: "inputHelp", input: { text: (string) - help text, title: (string) - title of dialog } } 4) Error/Warning message: { type: "message", message: (string) - message text, messagetype: (string) - "information" / "warning" / "error" } 5) New Report dialog: { type: "reportOptions", formats: [ { format: (number) - format ID selected: (boolean) - is selected title: (string) - format title } ... ] } 6) New Document dialog: { type: "documentOptions", formats: [ { format: (number) - format ID selected: (boolean) - is selected title: (string) - format title } ... ], pdf: (boolean) - is PDF Check box checked } 7) Display URL (Show generated report): { type: "displayUrl", Urls: [ { action: "display" (Only supported action currently) url: (string) - the URL to display } ... ] } 8) End (The procedure has ended): { type: "end" } |
This callback is used to update progress bar (called only when the procedure starts a program that reports progress). Note that if the procedure activates a process that doesn't report progress, or delays for other reason (for example: long running query), this callback WOULD NOT be called. So, it is recommended to use some action indicator always! Change it to a percentage indicator when this callback is called.
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| proc | Proc |
Procedure Object. |
| progress | Number |
0-100. |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| proc | Proc |
Procedure Object. |
| error | ProcError |
Object. { type: (string) - type of message: "NotSupported" / "ServerBusy" / "Error" text: (string) - text of message } |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | Object |
A choose or search object |
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| result | Object |
A search object |