Priority ERP
18 min
engini’s priority erp activities allow you to create and modify records, activate form activations, and make api calls from your priority erp using priority’s webhooks module getting started with priority erp prerequisites priority api license open access to priority via port 443 if you can’t open this access, you can also just whitelist our ip (see below) 34 159 217 185 34 141 24 31 optional – dictionary module to enable language specific operations for both crud operations (create, read, update, delete) and procedures, ensure that the dictionary module is activated in your priority erp system by default, the api will operate according to the system language unless specified otherwise connecting engini to priority erp enter your engini account at https //app engini io https //app engini io/ navigate to connections page by clicking on the connections on the left sidebar or by clicking here https //app engini io/connections click on the add connection option located at the topbar choose priority erp’s option from the available applications enter the following details in the “edit connection” form connection name choose a significant name api url including the tabula ini for example https //erp engini io/odata/priority/tabula ini https //erp engini io/odata/priority/tabula ini to specify the language for api operations, append a comma and the language code to the end of the url for example, for american english, use “ https //erp engini io/odata/priority/tabula ini,3 https //erp engini io/odata/priority/tabula ini,3 “ database name company id in companies form api username companies that use priority identity management module should place their personal access token api password companies that use priority identity management module should place “pat” in all caps websdk url optional used when using a dedicated priority connector x app id & x app key websdk username optional used when using a priority’s form activations, for example, for printing a price quotation document websdk password optional used when using a priority’s form activations, for example, for printing a price quotation document time zone choose the correct time zone of your location, or you enterprise location communication channel choose the appropriate connection type based on your setup cloud if you are connecting to a database hosted in a cloud environment, select “cloud” opa if your database is on premises and you are using an on premises agent (opa) for the connection, select “opa” in this case, an additional field will appear on prem agent choose the specific on premises agent that you want to use for this connection if you have multiple agents configured save settings click on the save button located at the bottom of the form triggers record updated this action triggers when a record is updated and sends the updated data to a specified webhook url for further processing url the webhook endpoint where the updated record data will be sent this is the destination that receives the event object type defines which type of record or entity you want to monitor for updates (e g , item, order, contact) add conditions allows you to set specific rules or filters so the action will trigger only when certain criteria are met select from the drop down the field you want to add the condition on select the condition you want the record to meet click on the empty field and the tooltip will pop up showing the options you can choose you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps a d for all the fields you want to populate actions create record this action creates a new record in the selected object type with the data you provide in the fields object type specifies the type of record you want to create (e g , customer order, contact, item) add field allows you to define and map the fields and values that will be included in the new record choose from the drop down the field you want to fill click on the empty field to the right of the dropdown to see a tooltip with all the available options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions https //app archbee com/docs/ixqqblwfxopjg0nave78y/o3kkbgi5xnqf yvnuqkcv and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate update record this action updates an existing record in the selected object type using the data provided in the fields object type specifies the type of record you want to update (e g , customer order, contact, item) record (customer order) a required field that identifies the specific record to update for each object type, this field will dynamically match the relevant entity (e g , order id, contact id) that was connected or selected add field allows you to define which fields will be updated and assign new values to them choose from the drop down the field you want to fill click on the empty field to the right of the dropdown to see a tooltip with all the available options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions https //app archbee com/docs/ixqqblwfxopjg0nave78y/o3kkbgi5xnqf yvnuqkcv and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate get record this action retrieves a specific record from the selected object type and returns the requested data fields object type specifies the type of record you want to retrieve (e g , customer order, contact, item) record (customer order) a required field that identifies the specific record to retrieve for each object type, this field dynamically represents the relevant entity (e g , order id, contact id) that was connected or selected output fields allows you to choose which fields from the record will be returned in the response get records this action retrieves a list of records from the selected object type, with options to filter, sort, and limit the results object type specifies the type of records you want to retrieve (e g , customer orders, contacts, items) output fields allows you to select which fields will be returned for each record in the response top n you can set the maximum number of sales order records engini will return during one workflow cycle (default = all records) if you set top n = 1 , a single record will be returned instead of an array if no record is found, the action will fail, allowing you to implement an if condition within the workflow this can be useful for processes where the existence of a record determines the next steps in the workflow offset the offset parameter allows you to skip a certain number of records from the beginning of the result set (default = 0 records) add filters you can add filters to query the sales orders and retrieve only the records that met the conditions choose from the drop down the field you want to fill click on the empty field to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields add sorting you can sort the retrieved list by multiple sales order fields either ascending or descending choose from the drop down the field you want to sort by choose the sorting option descending or ascending you can define a multi sort by adding more than one field to the sort use the arrows on the right to select the field that will be used as the primary sort, secondary, etc repeat steps 1 2 for all the fields delete record this action deletes a specific record from the selected object type object type specifies the type of record you want to delete (e g , customer order, contact, item) record (id) a required field that represents the unique identifier of the record you want to delete this value corresponds to the specific object selected (e g , order id, contact id) form activation form name choose the form name from the drop down menu the available forms are the open parent screens and child screens from your priority account activation choose the activation from the drop down menu according to the form name, an identifier field will appear enter a static value as you can see at the image below quote number – enter the specific quote identifier to retrieve or filter the related subform records this value determines which quote the action will be executed against add subform filter – allows you to add additional filtering conditions to the subform data this helps narrow down the returned records based on specific field values or criteria run press run each run can add new fields to fill in run procedure prerequisites eprog form is accessible to api in formlimited form the user used for the integration should have at least read privileges to eprog form the user used for the integration should have privileges to execute the relevant procedure to use priority’s run procedure, follow the following steps procedure name choose the procedure name from the field options tab in the tooltip menu all the available procedures run press run each run can add new fields to fill in when you need to reset the values you can press the “reset” button send api request this action sends a custom api request to an external service, allowing you to interact with endpoints using different methods, headers, and payloads base url the main endpoint of the api you want to call (e g , the server or service url) relative url the specific path or resource you want to access, appended to the base url method defines the http method used for the request (e g , get, post, put, delete) body type specifies the format of the request body (e g , json, form data) body the payload sent with the request, usually required for methods like post or put add headers allows you to include additional headers (e g , authorization, content type) required by the api add queries allows you to add query parameters to the request url (e g , filters, pagination)