The CHAPI service is responsible for all locking, unlocking, and refreshing of database records within Control. At times these locks can be held in the system even when there is not an active version of Control running that has the file locked. You can utilize the Chapiddler utility to release any locked records once all other possible actions have been attempted. Chapiddler simply serves as a tool to submit calls directly to the CHAPI service.

When using the Chapiddler, data can be modified and/or deleted if the wrong steps are taken. Use caution when doing this on a live database.

These steps should only be performed by a Cyrious Software Technician.

When using Chapiddler you will need to specify the database name on which CHAPI should attempt to communicate. Once you have this name, it should appended to all calls that are made in Chapiddler.

1. Connect to Server

1. In any browser, navigate to http://localhost:12556/chapi/HomePage/ChapiDocumentationChapiddler.html

1. Ensure Get is selected in the dropdown.

1. Enter the text below in the URL field next to the Submit button.

code

http://localhost:12556/chapi/database

code

1. Find the value of the property called name in the Returned Output section.

1. The value immediately after that response is your database name (i.e., Store Data, Store_Data, etc.). Below is a sample of what your response in the Returned Output section may look like.

code

200 OK

Content-Length: 212

Content-Type: application/json; charset=utf-8

[{“name”:“Store Data”,“application”:“Control”,“isactive”:true,“databasetype”:“SQL”,“path”:“SERVER\\Cyrious,1433”,

“databasename”:“StoreData”,“description”:“Control Store Data Group”,“hotfolderpath”:“”}]

code

• If there is a space in the name then be sure to use %20 in place of the space when specifying the databasename name later on in your calls. Ex: Store%20Data

1. Now that you have the name, you can use it in any of the calls below when initiating unlocks or other commands.

Message:

Record is being edited by

1. Connect to Server.

1. In any browser, navigate to http://localhost:12556/chapi/HomePage/ChapiDocumentationChapiddler.html

1. Launch SQL Management Studio and log in. Create a new query using the customer's live database.

1. Execute this query:

code_formatsql

select id from transheader where transactiontype = 1 and ordernumber = xxxxx

code

1. Copy the id from the query + c10000 and paste it in the URL as shown below.

code

Ex: http://localhost:12556/chapi/lock(1000c10000)?databasename=Store%20Data

code

1. Change the dropdown from Get to Delete and click Submit.

1. Output should return a “1” not a zero.

1. The record lock is now deleted and the user should be able to edit the order.

Message:

already logged in to at '', cannot add to logged-in user list.

1. Connect to Server.

1. In any browser, navigate to http://localhost:12556/chapi/HomePage/ChapiDocumentationChapiddler.html

1. To remove the user (log them out), select Delete from the dropdown and enter the following in the URL field.

code

http://localhost:12556/chapi/user?databasename=Store%20Data&username=

code

• Replace with the username for that employee. Usernames are case sensitive.

1. Click Submit.

1. The last value you receive in the response should be a “1”. If you receive a “0”, the user was not removed or was never logged in.

Contributor: TGilbert, SHendrix, Cyrious Software

Updated: 02/07/2014

Version: Control 5.xx

• Backlinks include_pagepage_componentbacklinks