Form: object type

Properties

warningConfirm(okCancel)

Confirms a server warning message. Every operation can trigger a warning messages on the server.

This method is used to make the server aware of the last operation’s state:

• If the the user approves the action despite the warning message, specify 1 in the ‘okCancel’ parameter. When the server completes the operation, it will resolve the promise in the last server call.
• If the the user cancels the action following the warning message, specify 0 in the ‘okCancel’ parameter. When the server completes the operation it will reject the promise in the last server call.

Returns: Void

infoMsgConfirm()

Confirms a server information message. Every operation can trigger informational messages from the server. Call this method when the user confirms they have read the message.

Returns: Void

isAlive() ⇒ Promise

Checks whether a form is alive on the server. Attempting to call methods for a dead form will cause errors.

Returns: Promise-

Fulfill: number- 1: alive, 0: not alive.

Reject: ServerResponse

startSubForm(formName, onShowMessgeFunc, onUpdateFieldsFunc) ⇒ Promise

Starts a Sub-Form and sets the active row to be the first row of the Sub-Form.

See setActiveRow.

Returns: Promise-

Fulfill: Form

Reject: ServerResponse

endCurrentForm(returnJustThisRow) ⇒ Promise

Exits the current form. If the form is a Subform, returns to the active row originally set in the parent form. See setActiveRow.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

setSearchFilter(filter) ⇒ Promise

Sets a search filter in a form or sub-level form. The filter is used to retrieve rows according to a certain query. See getRows. In order to clear the filter call clearSearchFilter.

Note: As long as you do not clear or change the filter, it will remain in effect. Every call to getRows will return rows according to that filter.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

clearSearchFilter() ⇒ Promise

Clears the search filter. After clearing the filter, the getRows method will use the default query for the form when retrieving rows.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

getRows(fromRow) ⇒ Promise

Returns rows data for the current form. The number of rows retrieved is limited by the windowSize property of the Form object.

Notes:

• If the current form was started with the parameter autoRetrieveFirstRows=1 or 2, the first time you call this function the API will not go to the server but instead return rows that were already retrieved and stored locally.
• If a default query has been defined for the form, or a Filter is set, the returned rows will be according to the query or the filter.

Returns: Promise

Fulfill: Rows

Reject: ServerResponse

Rows : Object

{   
  "FORM_NAME" :   
          {      
            "row_index" :       
            {          
                "FIELD_NAME" : value,          
                "ANOTHER_FIELD_NAME" : value
                ...        
            },       
            "another_row_index": 
            {
              ...
            }
          } 
} 

clearRows() ⇒ Promise

Clears all rows of a parent form. This does not delete rows, but rather makes them inaccessible until retrieved again.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

newRow() ⇒ Promise

Creates a new row in the current form, then sets it as the active row.

Returns: Promise

Fulfill: RowIndex

Reject: ServerResponse

setActiveRow(row) ⇒ Promise

Sets the active row to the specified row. Note that the row number index starts at 1.

Note: To perform actions on a row, you must first set it as the active row.

Returns: Promise

Fulfill: RowIndex

Reject: ServerResponse

fieldUpdate(fieldName ,fieldValue) ⇒ Promise

Changes or adds a value in a field in the currently active row. The updated information is returned through UpdateFieldsCallback. After changing the value in the field, Priority triggers may be executed, updating additional fields. These changes are also returned via UpdateFieldsCallback Calling this action does not save the new value.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

saveRow(backToParentForm) ⇒ Promise

Saves all changes made to the currently active row. Updated data is returned via UpdateFieldsCallback.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

saveText(text, addFlag, signatureFlag, secondaryLanguageFlag) ⇒ Promise

Adds new text to a html text form.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

undo() ⇒ Promise

Undoes any unsaved changes in the current row made by fieldUpdate. This includes changes made by Priority triggers. Updated data is returned via UpdateFieldsCallback.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

delRow() ⇒ Promise

Deletes the current row. Updated data is returned via UpdateFieldsCallback.

When a row is deleted, the server returns a collection of rows with updated index numbers.

Each row that was after the deleted row gets an index number prior to what it had before the delete.

Thats way the order of the rows is kept.

In this method the server returns the index of the last row. Used to update the view with the changes.

Returns: Promise

Fulfill: RowIndex

Reject: ServerResponse

choose( fieldName, fieldValue) ⇒ Promise

Opens a choose/search operation for a specified field. A successful Choose function results in either a Choose or Search object that contain either ‘ChooseLine’ values or ‘SearchLine’ values, respectively. Certain choose fields can become search fields when there are enough values to choose from. Therefore, after a successful Choose, make sure your code can address both types of results.

Note: If the field currently contains a value, it will automatically be filled in as fieldValue, even if a different fieldValue was specified.

Returns: Promise

Fulfill: Search/‘Choose’

Reject: ServerResponse

Example:

      let search = await form.choose('TYPE', 'R')
      //Check whether result is search or choose object
      if (search.SearchLine === undefined){
        console.log(search.ChooseLine)
      } else {
        console.log(search.SearchLine)
      }

filterChooseAction(action, searchText) ⇒ Promise

Certain forms in Priority are subject to Business Process Management (BPM) restrictions. This means that users are restricted in the values they can see when running a ‘choose’ on a Status or Assigned To column. This can be an issue when users want to search for documents according to these values. This function circumvents this limitation and displays all available values. Use it when constructing a filter through user input.

In all other respects, this function is completely identical to choose.

searchAction(action, searchText) ⇒ Promise

Performs one of the following actions on the previously opened search field:

• Next(1) - Retrieve more search results.
• Prev(2) - Retrieves the previous search results. Usually, this action is unnecessary, as previously retrieved results are cached locally.
• TypeChange(3) - Change the ‘search-by’ method. Available methods are: By Name, By Number, By Foreign Name.
• TextChange(4) - Changes the search query text.
• StartChange(5) - Specifies that the search should look for results that start with the query text.
• IgnoreCaseChanged(6) - When running a search in English (or other languages with uppercase and lowercase), toggles the ‘ignoreCase’ flag on or off.

Returns: Promise

Fulfill: Search

Reject: ServerResponse

filterSearchAction (action, searchText) ⇒ Promise

Certain forms in Priority are subject to Business Process Management (BPM) restrictions. This means that users are restricted in the values they can see when running a ‘searchAction’ on a Status or Assigned To column. This can be an issue when users want to search for documents according to these values. This function circumvents this limitation and displays all available values. Use it when constructing a filter through user input.

In all other respects, this function is completely identical to searchAction.

activateStart(ename, type, progressCallback) ⇒ Promise

Starts an Action. An Action is a Procedure;

Returns: Promise

Fulfill: Object

Reject: Object. See ProcErrorCallback

activateEnd() ⇒ Promise

Call this after an action has finished to refresh the current form’s data.

Returns: Promise

Fulfill: Empty object

Reject: ServerResponse

getFileDataUri(filename) ⇒ Promise

When given a relative path of a file on the server, provides the file in data url format.

Returns: Promise

Fulfill: string - file data url

Reject: ServerResponse

uploadFile(file, [onProgress]) ⇒ Promise

Uploads a file to the server from a Blob or File object. Can be used both in a parent form and in a sub-form in file fields.

Allowed file types are determined by the Uploadable File Types in Priority.

Note: This function only uploads the file to the server. Use fieldUpdate to attach it to an attachment field in a particular row.

Returns: Promise

Fulfill: FileResult

Reject: ServerResponse

uploadDataUri(dataURI, type, onProgress) ⇒ Promise

Uploads a file to the server in dataURL format. Can be used both in a parent form and in a sub-form in files fields. Any file type in base64 format is supported, although some file types may be blocked by Priority.

Note: This function only uploads the file to the server. Use fieldUpdate to attach it to an attachment field in a particular row.

Returns: Promise

Fulfill: FileUploadResult

Reject: ServerResponse

cancelFileUpload()

Cancels the current upload action. Once cancelled, the UploadFile promise is resolved immediately.

UploadFileProgressCallback : function

Column : Object

Properties

Subform : Object

Properties

Filter : Object

Properties

Notes

• You can only query a field once per filter.
• Search is performed from the beginning of valid field values. For example, when querying a number-only field with a value such as “100”, the “” in the beginning will be ignored.
• The filter object must contain all of its members. For example if you don’t use toval send an empty string but don’t send the filter without toval.

Example

{
 or: (number),
 ignorecase: (number),
 QueryValues:
 [{
   field: (string),
   fromval: (string),
   toval:  (string),
   op: (string),
   sort: (number),
   isdesc: (number),
 },
 {
   ...
 }]
}

QueryValue : Object

Properties

RowIndex : Object

Properties

Choose : Object

Properties

Example

{
  title1: 'Type',
  title2: 'Description',
  alignright1: 0,
  alignright2: 0,
  multi: 0,
  ChooseLine: [
    { string2: '"Make" item', string1: 'P', retval: 'P' },
    { string2: '"Buy" item', string1: 'R', retval: 'R' },
    { string2: 'Other', string1: 'O', retval: 'O' }
  ],
  chooseid: '5943,6'
}

ChooseLine: Array of Objects

Properties

Search : Object

Properties

SearchLine : Array of Objects

Properties

FileProgress : Object

This object is obtained through UploadFileProgressCallback and shows the progress of the upload.

Properties

FileResult : Object

This object is obtained when UploadFile resolves, and provides the file’s url on the Priority server.