The following section will outline the functionality that has been provided to create service request cases from an iCM form submission.
End Points
The service requests connector contains 114 SOAP methods, it would not be sensible to detail all 114 methods in this document, so while the whole API has been made available via iCM end points only the most relevant have been documented here.
The service requests end points can be found within the
Each end point has an input and return schema which details the parameters accepted by the end point and thus the Idox connector method.
GetCnCodeListByFieldName
This method can be called to retrieve "CNCODE" values by field name. The list of field names can be found at the end of the Idox technical documentation. This method can be used to retrieve case type codes and potentially provide drop down options for some form fields, for example pest types.
SubmitGeneralServiceRequest
Submits a new General Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitDogServiceRequest
Submits a new Dog Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitFoodServiceRequest
Submits a new Food Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitPestServiceRequest
Submits a new Pest Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitContractServiceRequest
Submits a new Contract Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitNoiseServiceRequest
Submits a new Noise Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
SubmitNonEHServiceRequest
Submits a new General Request to the Idox Environmental Health module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
Note from the Idox technical documentation: This method cannot be used to create Enforcement requests, if you want Uniform users to be able to create (or link to) Enforcement cases from them. For this purpose, use the SubmitServiceRequestReception method instead. The SubmitNonEHServiceRequest method is intended for the creation of Housing, Licensing, and High Hedges service requests only.
SubmitServiceRequestReception
Submits a new record to the Idox Service Request Reception module.. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to create a new case within Idox uniform.
Note from the Idox technical documentation: This is the method which you must use if you want Uniform users to be able to create (or link to) Enforcement cases from Enforcement requests within Uniform. You cannot use the SubmitNonEHServiceRequest method for this purpose.
Blueprint Forms
To provide examples and act as an integration test facility, eight blueprint forms have been provided to demonstrate submitting General, Dog, Food, Pest, Contract, Noise, Non EH and Reception service request cases from a GOSS form into Idox Uniform.
The forms can be found under the goss >> Idox >> Service Request Blueprints folder.
Each form follows the same pattern as there are common input parameters for the various "Submit*" connector methods. Where additional parameters are accepted for a particular connector method, for example SubmitPestServiceRequest accepts a "PestTypes" parameter, these have been added as example on the blueprint form and mapped through to the endpoint request.
The blueprint forms only deal with the creation of an Idox uniform case, these forms do not contain any further logic to generate PDFs, create GOSS Case Management cases or submit files to the Idox DMS.
Form Snippets
Several form snippets have been created to provide a good starting point for creating an Idox integrated form. The service request specific snippets can be found under the goss >> Integration Util Snippets >> Idox Service Request folder.
The following snippets are provided:
- Integration: Idox SR - Submit General Service Request
- Integration: Idox SR - Submit Dog Service Request
- Integration: Idox SR - Submit Food Service Request
- Integration: Idox SR - Submit Pest Service Request
- Integration: Idox SR - Submit Contract Service Request
- Integration: Idox SR - Submit Noise Service Request
- Integration: Idox SR - Submit Non EH Service Request
- Integration: Idox SR - Submit Service Request Reception
Note that each of these snippets has been used on the blueprint forms of the applicable type.
Each snippet to create a service request case has the following structure:
IDOXCONNECTORCODE - This hidden field denotes that the form will be creating a case within the SR connector. This field is referenced by subsequent snippets and should not need to be changed.
EXTERNALREFERENCE - This hidden field is created with no value, once the Idox case has been created this hidden field will be populated with the Idox case "ReferenceValue".
CREATEIDOXSRCASE - This script action is responsible for gathering the required information from the form submission and ultimately creating the Idox case via an endpoint call within the script. This is where the bulk of the form specific changes will need to be made as the form field values are mapped onto the request parameters sent to the Idox API. Once the case has been created this snippet contains the relevant logic to push the returned Idox case "ReferenceValue" into the EXTERNALREFERENCE hidden field. The snippet also contains logic to cancel the processing of the rest of the form and display an error message should there be a problem in creating the case in the Idox system.
Share this page
