WebServer

In web mode your organisation will store, manage and access their dictionary from a webserver.

Everytime CADLex runs it will make a call to the webserver and check it has the latest company dictionary. If not the latest custom dictionary will be downloaded. Hence when a company initially implements CADLex there will be more server traffic as additions / rejections accumulate toward some stable agreed custom dictionary.

Your organisation must appoint at least one administrator who will take responsibility for controlling the custom dictionary contents.

Sample Config.json for Web

When CADLex starts it reads a configuration file in order to set which mode it is operating in and identify the network locations.

{
  "language": "en_GB",
  "input_mode": "web",
  "file": {
  },
  "web": {
    "server": "https://cadlex.turtlestack.net",
    "dictionary_url": "dictionary/allwords",
    "new_request_url": "admin/pending",
    "rejected_url": "dictionary/rejects",
    "pending_url": "dictionary/pending",
    "latest_id_url": "dictionary/latest-id",
    "key": "UserAPIKey"
  }
}

PARAMETERS

input_mode Single word governing which mode CADLex is running in - either 'file' or 'web'. 
"input_mode": "web",
server Path to where the dictionary server is running. Smaller volume customers can use can use the default cadlex server (as shown) whilst larger organisations may require their own more performant instance. 
"server": "https://cadlex.turtlestack.net",
new_request_url Path to the new request API endpoint 
"new_request_url": "admin/pending",
rejected_url API endpoint to return the rejected words 
"rejected_url": "dictionary/rejects",
pending_url API endpoint to return the words pending administrative review 
"pending_url": "dictionary/pending",
latest_id_url API endpoint to return latest unique dictionary hash 
"latest_id_url": "dictionary/latest-id",
key Organisation internal API key. This will be issued to you when you purchase a CADLex licence. 
"key": "UserAPIKey"