Insert Request¶
Data can be inserted into your JustWare database from JusticeWeb by using the JustWare API (Application Program Interface). Using the API allows JusticeWeb users to insert cases and names into JustWare. Using the JustWare API will provide your organization with the ability to invoke workflow (Business Rules) when this data is inserted into your JustWare database. It also provides security by utilizing the data access layer built into the API. It is important to remember that a JusticeWeb user is never in your JustWare database, but instead leverages the API to insert data. In order to insert data into JustWare though JusticeWeb, requests will need to be configured that allow the JusticeWeb user to submit data that will then be inserted into the JustWare database as cases and names. To learn how to create a request, see Creating Requests.
Inserting a Case¶
To insert a case into JustWare from JusticeWeb you must use the Insert-case Request Type. Case information can be inserted on any page in an Insert-case Request. To learn how to create a Request Type, see Request Type. Once you have created an Insert-case Request Type, there are a few criteria that must be met in order to submit data to JustWare:
- An Insert-case Request Type must have a Name Page.
- The Name Page must have a field for an Involve Type that ties to a PIP Involve Type in JustWare. On a name page that is used for adding PIP Involve Types you can only have PIP Involve Types on a page. See Configuring Field Types to learn more about configuring fields. Important:In order to add multiple PIPs on the same case, the Allow Multiple PIPs Per Case Application Parameter must be set to True. Do this is in System Administration | Code Tables | Application Parameters.
- The Name Page must have a field with a Field Type of Last Name. This will be the name that will be entered into JustWare. See Configuring Field Types to learn more about configuring fields.
- An Insert-case Request Type must have a field with a Field Type of Case Status. This can be on the Name Page or a separate page if desired. See Configuring Field Types to learn more about configuring fields.
- An Insert-case Request Type must have a field with a Field Type of Case Type. This can be on the Name Page or a separate page if desired. See Configuring Field Types to learn more about configuring fields.
Other fields can be on the Insert-case Request, but as long as the criteria above is met, the request will be able to submit data into JustWare via the JustWare API when the JusticeWeb user submits the request from the JusticeWeb Web site. Fields located in the Case Fields section of the Add a Field tab can be used to insert data into a case record. Note: If you create a request that inserts a case, and that request has a field to allow the user to specify a case number, this number will override any auto-generated case numbers. If you want to use the auto-generated case number, do not have an agency number field on the request.
Inserting a Name¶
Names can only be added through JusticeWeb as part of a case. A name cannot be added without an Involve Type on a case. To insert a case you must use a Name Page and include a field for Last Name and Involve Type. Name records can only be added using the Name Page, and only the information on that page will be inserted into the name record. Fields located in the Name Fields section of the Add a Field tab can be used to insert data into a name record. Important:In order to add multiple PIPs on the same case, the Allow Multiple PIPs Per Case Application Parameter must be set to True. Do this is in System Administration | Code Tables | Application Parameters.
Duplicate Name Detection¶
When inserting a name record through JusticeWeb, measures are taken to ensure that duplicate name records are not created. JusticeWeb utilizes a similar feature to JustWare's Duplicate Name Detection utility. Duplicate name detection is a convenient and powerful maintenance tool used to prevent the JustWare database from becoming cluttered with duplicate name records. The diagram below illustrates how names are inserted into JustWare from JusticeWeb.
Step |
Description |
---|---|
1. |
When inserting a name, JusticeWeb will query JustWare and perform a Duplicate Name Detection to see if the name that is being submitted already exists. When a Duplicate Name Detection is performed, JusticeWeb will query for names with the following criteria:\ Duplicates are found with the highest degree of confidence. Both last and first names must be spelled the same and the middle initial must be the same. At least two other critical pieces of information must match. Critical pieces of information that will be used for matching names are:
A match is not made if conflicting critical information exists. In order to be a match, numbers must have the same MasterCode as listed in ctblNumberType. Matches will be made with both inactive and active numbers. Conflicts will be made with active numbers only. Notes:
|
2. |
JustWare returns possible matches for the name the name that is being submitted. |
3. |
If a match is found, JusticeWeb will update the existing name, if no match is found, JusticeWeb will use the API to create a new name record in JustWare. |