Creating a job

Creating a job in a back office application that removes rekeying on behalf of officers without any technical coding etc. is the holy grail for product development.

It's because enabling the complex to be made simple is remarkably hard to do. But with this plugin we have enabled non-technical users to map the content from eDesigner forms directly into Symology.

Within the map set up for Symology, click on 'Push Jobs To Symology' as shown below:

Mapping the Form content to the Symology API

When you do so you will be presented within the following UI:

Symology Job Creation Set up

Important

The request type that we send can only come from one question's answer. Originally, it was thought that you could filter right down via multiple questions. However, as the Request Type has a 1 to 1 relationship with the question in the form you can only really have a single question providing the answer to the type of request.

The purpose of the above screen is to enable non-technical users to pass the content that the Symology API - SendRequestAdditionalGroupAuthenticated- requires to create a job in the back office application.

Not all of the fields are mandatory!

The following illustrates this screen populated to provide context when we walk through each of the different fields:

We will walk through each now:

User name

The 'User name' is the user name that should be used for the update audit in the back office

Service Code

This tells the back office the service area to which it relates. I.e. HIGH means Highways

User Entry Fields

Notice how the rest of the fields have a label (in blue e.g. Request Type) followed by two fields. This is because, RequestType is the thing that needs to be sent to Symology. But the form needs to know which page and question will provide it. It needs to know this because you could build a 100 different forms with different pages and questions and we need to cater for that.

So for each item in blue you have one drop down on the left to say the page it will come from and another to say which question/answer will provide it.

Request Type

This is the type of incident/issue being reported.

In this form there is a page called 'My first page' and on that page a question with a field id of 'reportedRequestType' which captures the type of issue they're reporting. This same way of mapping works the same for all of these items mapped from the form.

Location

A text based description of the location. Can be used to help with pinpointing the location. E.g. Outside number 20 on the high street.

Geo Location

The geo-location i.e. physical coordinates in Easting/Northing measurement.

Description

Any more specifics or details relating to the issue in question

Customer Firstname

The customer's first name (if provided)

Customer Surname

The customer's surname (if provided)

Customer Email

The customer's email address (if provided)

Once you've added all of these you're ready to set up the trigger to create a job.

Adding an Action

To add an 'action' to a form, i.e. trigger something when the form is submitted, one needs to go to form details in Form Management:

Once you've clicked on that click the Advanced Create link and you will see the following:

Once done, the only thing you need to do is give the action a name.

This name will appear in the Forms Portal's integration tab so try to make it clear as possible as to what it is.

Naming the Symology Create Job action

Whatever you name, it will also shown in the screen below once you've saved it:

Now you can test submitting the form and seeing the updates in Symology.

Integration outcomes

When a form is submitted it can be viewed within the Forms Portal. Importantly, you can click on the 'Integration' tab and see the outcome of it.

Plus, on the 'Documents' tab there is a document called: api-input.json as shown below, which holds the details that were passed to Symology.

A sample file is shown below where one can see the fields mapped in creating a job - user entry fields are present.

{
  "TextFields": [
    {
      "Id": "Request.UserName",
      "Value": "CAC"
    },
    {
      "Id": "Request.ServiceCode",
      "Value": "HIGH"
    },
    {
      "Id": "Request.RequestType",
      "Value": "BLDM"
    },
    {
      "Id": "Request.Description",
      "Value": "There's a huge issue"
    }
  ],
  "LocationField": {
    "latitude": "51.49068560236329",
    "longitude": "-0.11641360221279928",
    "id": null
  },
  "Documents": [],
  "CreatedOn": "2021-12-13T17:08:36.067",
  "Reference": "KZXFWJNK"
}