Proc: object type

Properties

Introduction

Priority’s procedures are usually a sequence of individual steps, with some of them requiring user input. Only after the input for a step is complete does the procedure move on to the next step. Running procedures via the Web SDK follows the same structure. When a procedure is called, the response includes (in the data object) the current input step, which can be one of several types. These step types are outlined in the table below.

For each step type, there is a corresponding function to be called to fill in the input. Once input is specified, the promise is resolved, and the next procedure step that requires input is returned from the server, with its own step type. This continues until the end of the procedure is reached (the end step type is returned).

Here’s an example of this workflow, using the Order Confirmation procedure, which creates an order confirmation document on the server.

1. We run the WWWSHOWORDER procedure using procStart.
2. The promise is resolved, returning a proc object with a type of inputFields, where the user can pick the order to print a confirmation for.
3. We use the corresponding inputFields function to respond to this step type, specifying the order to print.
4. When the promise is resolved, the proc object is returned with a step type of documentOptions, allowing the user to choose the print format for the order confirmation.
5. We respond to this step type by using the corresponding documentOptions function, specifying the desired print format.
6. The server now creates the file, so this time, the step type returned is displayUrl, informing us of where the file is saved on the server.
7. To continue the procedure, we use the corresponding continueProc function.
8. Finally, we get back a step type of ‘end’. This lets us know the procedure has been completed.

data : Object

The data object can be one of several types, and each type has a corresponding function to address that type. Function names are almost always identical to the type they correspond to. All of these functions return promises, and when resolved return a new data object for the next step of the procedure, until the end step is reached. For example, when generating an Order Confirmation document, upon starting the procedure, the promise resolves wiht a data object of type inputFields. After specifying which order to generate the confirmation document for using the inputFields function, the server returns a new data object of type documentOptions. You can then select the desired print format with the documentOptions function, which returns a new data object with a different type, and so on.

inputFields: object type

This data type describes a dialog where the user has to fill in one or more fields in order for the procedure to run. It is the most common procedure data type.

Structure of the data object:

Example:

input:Object {EditField: Array[2], Operators: Array[9], text: "", …}
proc:Object {}
type:"inputFields"

input: array

Example:

EditField:Array[2] [Object, Object]
Operators:Array[9] [Object, Object, Object, …]
text:""
title:"Parameter Input"

EditFields: array

Note: A zoom value of “Attach” in a field indicates that the input should consist of a file. Use the fileUpload method to fill in this value - it will automatically add the file’s location on the server as the input (once upload is complete).

Example:

0:Object {field: 1, helpstring: "\nSpecify the code of the special offer in which yo…", isboolean: 0, …}
columntype:"Str"
field:1
helpstring:"\nSpecify the code of the special offer in which you want to include customers."
mandatory:0
operator:0
readonly:0
title:"Offer Code"
value:"1"
value1:""
width:56
zoom:"Choose"

Operators: array

Example:

0:Object {name: "= ", op: 0, title: "equals"}
name:"= "
op:0
title:"equals"

Possible Operators

Some operators might not be available in certain situations. For example, if the input fields include From Date and To Date, an exact date (equals) must be specified.

inputFields(ok, data)

Call this function as a response to a procedure’s inputFields data type.

InputFieldsData: object

Used to return the user’s input in various fields to the server.

EditFields: array of objects

Specify the values to be entered in the various input fields. Each fields is represented as an object with the following properties.

formZoom(fieldID, onShowMessgeFunc , onUpdateFieldsFunc , profile , autoRetrieveFirstRows , exParams)

Use this function to drill-down into a form that contains source data for a certain input field. This replicates the standard Priority functionality of “zooming” into a form to retrieve input. This function behaves almost identically to the formStartEx function for forms, except that rather than specifying the form, you specify the field ID of an input field.

This function only works on input fields with a zoom value of zoom, choose, and search, although it is only available in certain choose and search fields.

After the user retrieved the desired data, use the standard endCurrentForm function to return to the procedure, while setting a value in the returnJustThisRow parameter.

This returns a proc object of type zoomvalue.

zoomvalue object type

This data type is returned after an attempt to zoom into a form from a procedure in order to retrieve data. It either describes a failure to zoom into the form, or the retrieved values.

Example:

{

                "proc": {
                                "title": "Print Sales Invoice",
                                "name": "WWWSHOWAIV",
                                "session": "AVIAPC26360z1608046859y167"
                },
                "type": "zoomvalue",
                "haszoom": 1,
                "field": 1,
                "value": ""

}

In this example, the zoom was successful and multiple records were retrieved - several Sales Invoices were selected.

After zoom is complete, you can continue the procedure as if you returned to the inputFields object type - either zooming into additional input, letting the user enter data in the input fields, or continuing the procedure with the inputFields function.

inputOptions: object type

This data type describes a dialog where the user has to select an option in order for the procedure to run. In Priority’s web interface, these options would show as radio buttons (if there are more than 8, as a listbox). Structure of the data object:

Example:

input:Object {Options: Array[3], text: "", title: "Prep. Type"}
proc:Object {}
type:"inputOptions"

input: object type

This data type indicates a step where the user should choose a single option out of two or more possible options (radio buttons).

Structure: |Name | Type | Description | | — | — | — | |Options|array| Contains the choice fields for the procedure. | |helpstring|string| Contains help text for the dialog.| |title|string| The title of the dialog.|

Example:

Options:Array[3] [Object, Object, Object]
text:""
title:"Prep. Type"

Options: array

Example:

  options: [
    {
  field: 2,
  helpstring: '\n' +
      `This report calculates a new ABC class for each material, based on actual issues over the period for which it is run, displaying that together with the standard class (designated in the "Purchase/MRP Parameters for Part" form). Select this option to leave each part's standard ABC class as is (no update).`,
  name: 'CH2',
  selected: 0,
  title: 'No'"
  },{...}]

inputOptions(ok, selection)

Call this function as a response to a procedure’s inputOptions data type.

inputHelp: object type

Some procedures include an introductory or intermediate dialog that displays help text. Structure of the data object:

Example:

input:Object {text: "", title: "MRP Planning"}
proc:Object {}
type:"inputHelp"

input: object

Example:

text:"The MRP planning program..."
title:"MRP Planning"

inputHelp(ok)

Call this function as a response to a procedure’s inputHelp data type.

message: object type

An error/warning/informational message provided by the procedure. Data structure:

Example:

message:"The "Material Requirements Planning" program was last run on 12/04/18."
messagetype:"information"
proc:Object {}
type:"message"

message(ok)

Call this function as a response to a procedure’s message data type.

fileUpload(file, [onProgress]) ⇒ Promise

Uploads a file to the server from a Blob or File object. On successful upload, the procedure continues.

uploadDataUri(file, [onProgress]) ⇒ Promise

Uploads a file to the server in dataURL format. On successful upload, the procedure continues.

reportOptions: object type

When launching a report that has multiple formats defined, allows you to choose the desired format. Structure of the data object:

formats

excelTemplates

Example

{

"proc": {
        "title": "Orders for Customer",
        "name": "ORDERSBYCUST"
},
"type": "reportOptions",
"formats": [
        {
          "title": "Basic",
          "format": -101,
          "selected": 1
        },

        {
          "title": "Copy of Basic",
          "format": -104,
          "selected": 0
        }
],

"hasExcel": 1,
"excelTemplates": [

        {
          "selected": 0,
          "template": 937,
          "title": "ExampleTemplate"
        },

        {
            "selected": 0,
            "template": 1072,
            "title": "Lots of Orders"
        }]
 }

reportOptions(ok, selectedFormat, options)

Call this function as a response to a report generating procedure’s reportOptions data type.

options: object

Example Usage

result.proc.reportOptions(1, -101, {excel: 1, excelTemplate: 1061});

documentOptions: object type

When launching a document that has multiple display/print formats defined, allows you to choose the desired format. Structure of the data object:

Example:

formats:Array[15] [Object, Object, Object, …]
pdf:0
proc:Object {}
type:"documentOptions"
wordTemplates: Array[10] [Object, Object, Object, …]

formats: array

Array of objects listing the available print/display formats.

Example:

0:Object {title: "By Base Product", format: -7, selected: 0}
format:-7
selected:0
title:"By Base Product"

wordTemplates: array

Array of objects listing the available word templates to print/display the document by.

Example:

selected: 1
template: -3
title: "Predefined Template"

documentOptions(ok, selectedFormat, options)

Call this function as a response to a report generating procedure’s documentOptions data type.

options: object

More about mode:

• singature - use this mode to prepare the document in Click2Sign mode, where the customer can sign the document online.
• automail the document will automatically be sent to the recipient (e.g. customer or vendor contact person).
• display prepare the document to be viewed/downloaded from the server.

displayURL: object type

After generating a report, this data type displays the url on the server of the report. Structure of the data object:

Example:

proc:Object {}
type:"displayUrl"
Urls:Array[1] [Object]

Urls: array

Example:

0:Object {url: "https://example.com/dev/netfiles/ec00dep0138400…", action: "display"}
action:"display"
url:"https://example.com/dev/netfile"

continueProc()

Call this method as a response to a report generating procedure’s displayURL data type.

client: object type

Certain standard Priority procedures use the client step to request special data from the client. This is mostly used to identify whether the current client is on a machine where the Priority App Plugin is installed and to obtain data from it.

If you encounter a procedure that includes the client step, you should respond with an empty clientContinue method (with no data specified) to continue the procedure.

You can find a full list of procedures that include this step in this list.

Example:

proc:Object {}
type:"client"
data: [data object sent from server to client]

clientContinue(data)

Call this method as a response to a step of type client.

cancel()

Cancel procedure in progress.

ProcProgressCallback : function

Use this function to update a progress bar. This function is called by the SDK whenever a progress bar is called on the server by the procedure itself.

Note that as long as a progress bar was not called by the procedure on the server, this function WOULD NOT be called, even if the procedure is taking a long time (e.g., due to a long-running query).

Therefore, you should always use some sort of action indicator. Change it to a percentage indicator when this callback is called.

ProcError : thrown error

ProcError : Object

Properties

For example, a ProcError might look like this:

proc:Object {}
message:"step GANTT is not supported"
type:"NotSupported"

choose(fieldId, value, data)

Opens a choose/search operation for a specified field. A successful Choose function resolves in an object of ‘Choose’ type, that contains both a generic Proc object (describing the current procedure) and a Search object that can contain either ‘ChooseLine’ values or ‘SearchLine’ values. The type of values in the object is not predefined for each field, but is rather dependent on the number of results - if the number is large, ‘ChooseLine’ may be replaced by ‘SearchLine’. Therefore, after a successful Choose, make sure your code can address both types of results.

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

choose data object

This object should contain an array fields in the current procedure which currently have a value, which some may affect the current choose operation. For example, if you filled in a customer, and are currently choosing a price quote, it might limit the choose operation only to price quotes opened for that customer. This array is composed of objects with the following properties:

ChooseField array of objects

Example

let procedure = await priority.procStart("WWWSHOWDOC_Q", "P", null);
let ChooseProps = {};
ChooseProps.ChooseFields = [];
ChooseProps.ChooseFields[0] = {
  field: 1,
  value: ""
};
const procChoose = await procedure.proc.choose(2, '', ChooseProps);
// The returned object can contain either search or choose results - your code should support both
if(procChoose.Search.SearchLine === undefined){
  console.log(procChoose.Search.ChooseLine)
} else {
  console.log(procChoose.Search.SearchLine)
}

Returned object Example

{
  proc: {
    title: 'Print Service Call Form',
    name: 'WWWSHOWDOC_Q',
    session: 'PRIDEV23e8z1654668601y378',
    message: [Function (anonymous)],
    reportOptions: [Function (anonymous)],
    documentOptions: [Function (anonymous)],
    inputFields: [Function (anonymous)],
    inputOptions: [Function (anonymous)],
    inputHelp: [Function (anonymous)],
    continueProc: [Function (anonymous)],
    cancel: [Function (anonymous)],
    choose: [Function (anonymous)],
    searchAction: [Function (anonymous)],
    uploadFile: [Function (anonymous)],
    uploadDataUrl: [Function (anonymous)],
    clientContinue: [Function (anonymous)],
    formZoom: [Function (anonymous)],
    cancelFileUpload: [Function (anonymous)],
    isSupported: [Function (anonymous)]
  },
  type: 'Choose',
  Search: {
    title1: 'Sort',
    title2: 'Description',
    alignright1: 0,
    alignright2: 0,
    ChooseLine: [ [Object], [Object], [Object] ]
  }
}

searchAction(fieldId, value, action, data)

Perform action in search dialog. Performs one of the following actions on the previously opened choose/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.

List of Procedures with a Client Step

The following procedures contain the ‘client’ step type. Note that some of these would generally only be used within the main Priority interface, but are included here for completion’s sake.

CHECKS
CLOSEPRINTAIV
CLOSEPRINTBIV
CLOSEPRINTCIV
CLOSEPRINTDIV
CLOSEPRINTEIV
CLOSEPRINTFIV
CLOSEPRINTPIV
CLOSEPRINTRIV
CLOSEPRINTSIV
CLOSEPRINTTIV
CLOSEPRINTYIV
DESIGNCHECKSTEMPLATE
DOCEXPTOMSPROJECT
DOCSENDSTARSHIP
EXPTOMSPROJECT
GMAILSYNC
HMRCVATGBR
ICSFILE
IVSENDSTARSHIP
LABELS
LABELSSET
LOADMSPROJECT
LOADRPROJWORD
OUTLOOKPORTAL
PRINTCHECK
PRINTCHECKS
PRINTEMAILDEFDOC
PRINTEMAILDEFIV
PRINTEMAILDEFORD
PRINTEMAILDEFPORD
PRINTEMAILDEFPRF
SHVA
SHVA
SHVA
SHVA
STARSHIPMAPVALUES
VEREXPTOMSPROJECT
WINOUTLHISTORY
WINOUTLOOKAUTO
WINOUTLOOKAUTOG
WINOUTLWORKAREA
WWWSHOWAIV
WWWSHOWAIVDISTR
WWWSHOWBIV
WWWSHOWCIV
WWWSHOWCIV
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWDOC
WWWSHOWEIV
WWWSHOWFIV
WWWSHOWRIV
WWWSHOWRIV
WWWSHOWSIV
WWWSHOWSIV
WWWSHOWTIV
WWWSHOWTIV