Global

priorityReady()

This method is automatically called by the SDK when it has fully loaded. Use it as the entry point for your client side logic. Ensure that ‘priorityReady’ is called first, before you start calling any other SDK methods. This is particularly important if you choose to include the SDK via a script (as opposed to npm). Define this function as a global function:

window.priorityReady = () => {
  //Call some API method here.
}

login(configuration) ⇒ Promise

Use this function to initialize the system and login. A succesful login also returns the LoginFunctions object.

Returns: Promise

Resolve: LoginFunctions Object

Reject: ServerResponse

Configuration : Object

Properties

URL

Local Installations

For local installations, the URL is the url to the Priority WCF service, without the “wcf/wcf/service.svc” part (i.e. the URL configured for the Priority Application Server).

Priority Cloud

For installations hosted on Priority Cloud, a distinction needs to be made between tenants on Private vs. Public Cloud (AWS).

• On the public cloud (AWS), all installations share the same URL, and are distinguished by differing tabula.ini files. For production environments, the url is:
  https://p.priority-connect.online/wcf/service.svc

  For test environments, the prefix is an s, instead:
  https://s.priority-connect.online/wcf/service.svc

• On the private cloud, the URL is the url to the Priority WCF service, without the “wcf/wcf/service.svc” part.

Verifying the URL

While Priority Cloud is migrating from the private to the public cloud, given the possible URL variations, you might want to add some code that verifies the URL provided to your app is correct. You can use the Fetch API to check these variations:

async function checkUrlRequest(serverUrl, resolve, reject) {
        let success = false;
        if (serverUrl.toLowerCase().includes('service.svc')) {
            return resolve(serverUrl);
        }
        success = await this.tryFetch(serverUrl + '/wcf/service.svc');
        if (success) {
            return resolve(serverUrl);
        }
        success = await this.tryFetch(serverUrl + '/wcf/wcf/Service.svc');
        if (success) {
            return resolve(serverUrl);
        } 
        return reject({message: 'No WCF service found in URL'});
}       

You can of course extend this code with additional validations, for customers with their own private installations and setups.

profile: Object

Properties

Note: If you are unsure what to enter in url, tabulaini, and profile, check with the Priority system administrator.

Example:

const priority = require('priority-web-sdk');

async function webSDK() {

let config={
  url:<your url>,
  tabulaini:<your tabula.ini>,
  language: 3,
  profile: {
                company: 'test',
            },
  appname:'demo',
  username:<your username>,
  password: <your password>,
  devicename:'', 
  X-App-Id: 'APP001',
  X-App-Key: '15nXqSDXnNeaIEFQSSDXkNeZ16DXodeV16TXmSDXoteb16nXmdeVISEh'
};
try { 
    await priority.login(config)
    console.log('Your are in!! Enjoy!')
}
catch(reason){
    console.error(reason.message)
}
};

Personal Authentication Tokens

Accessing the SDK via Personal Authentication Tokens is available as of version 19.1 of Priority

To use an authentication token to access the SDK, your System Administrator must first generate the token. To access the SDK via the token, specify the following credentials:

const priority = require('priority-web-sdk');

async function webSDK() {

let config={
  url: <your url>,
  tabulaini: <your tabula.ini>,
  language:3,
  profile: {
                company: 'test',
            }
  appname:'demo',
  username:<your token>,
  password: 'PAT',
  devicename:'', 
  X-App-Id: 'APP001',
  X-App-Key: '15nXqSDXnNeaIEFQSSDXkNeZ16DXodeV16TXmSDXoteb16nXmdeVISEh'
};
try { 
    await priority.login(config)
    console.log('Your are in!! Enjoy!')
}
catch(reason){
    console.error(reason.message)
}
};

formStart(formName , onShowMessgeFunc , onUpdateFieldsFunc , profile , autoRetrieveFirstRows) ⇒ Promise

Opens a Form. Call this method once for each Form you want to open.

A Form will stay open until you end it. Once open, you can use all of its methods.

Returns: Promise

Resolve: Form

Reject: ServerResponse

FormStartSuccessCallback : function

MessagesCallback : function

A callback passed to the formStart function. Use it to display messages received from the server.

This callback is called by the SDK whenever messages are received from the server after calling a Form Object method.

Notes:

• If the server returns an error after calling an API method, it indicates the action has resulted in a Priority error and the promise is rejected. The error message will be returned through messagesCallback, but any catch block will run.

• When the server returns a warning after calling an API method, it indicates the user has encountered a warning message where they must decide whether to continue the action or cancel it. The warning message will be returned to the messagesCallback and the action will not be completed until:

  • The action is approved despite the warning - warningConfirm is called with ‘okCancel’ = 1. In this case the original promise that triggered the warning is resolved.
  • The action is canceled due to the warning - warningConfirm is called with ‘okCancel’ = 0. In this case the original promise that triggered the warning is rejected.
• When the server returns an information message after calling an API method, it indicates the user has encountered an informational message regarding the current action (for example, a message related to a customer that was selected). This message simply needs to be confirmed. The message will be returned to the messagesCallback and the action will be completed once the infoMsgConfirm function is called.

UpdateFieldsCallback : function

A callback function passed to the formStart function. This callback is called by the SDK when updates to a Form’s row or field are received from the server. Updates can be received after performing certain actions, including:

• fieldUpdate
• saveRow
• undo
• delRow Methods that include updates will be noted as such, and will call this function.

Note: This callback should be carefully implemented to cover all ‘update’ cases, in order to ensure local data is always synchronized with data on the server.

Example:

let customersForm;

const updateFieldsCallback = (updates)=> {
  if(updates["CUSTOMERS"] != null) {
    Object.assign(customersForm.rows,updates["CUSTOMERS"]);
  }
}

const messagesCallback = (serverMessage)=> {
  alert(serverMessage.message);
}

try {
customersForm = await formStart("CUSTOMERS", updateFieldsCallback, messagesCallback)
...
}
catch {
  //reject
}

Profile: Object

Properties

formStartEx(formName , onShowMessgeFunc , onUpdateFieldsFunc , profile , autoRetrieveFirstRows , exParams) ⇒ Promise

Opens a Form in a special mode that can call on additional parameters. Specifically, you can use the exParams object to specify a row number and this function will open the form and retrieve that row (when the getRows method is called).

Note: Other parameters of formStartEx are identical to those of formStart.

exParams : object

Contains additional parameters used by the formStartEx function.

Properties

procStart(name, type, progressCallback, dname) ⇒ Promise

Start a Procedure or a report.

ServerResponse : Object

Properties

ServerResponseType : enum

Properties

ServerResponseCode : enum

Properties