This help file contains technical information about the AI quick search and how it works. If you are looking for all of the prompts and keywords, see this help file.

Basically, we have created a single page called "search action". It allows for both URL and FORM scoped variables. What this means is that you can pass in information directly via a web address (URL scope) or you can enter information in a form and have it post to the correct page. Either way, the page will sort out what was passed to it and then run the correct function and look-up option.

There are over 350 keywords, prompts, and options. Also, each one has a number of possible aliases (alternates or alternative values). Once again, see this help file for more information on the actual prompts, keywords, and aliases.

The URL scope needs to follow this format: top_secret/search_action.cfm?aiSearch=[prompt] - where the [prompt] is the requested keyword or prompt.

If you are trying to fully qualify the URL or web address, you will need to add in the full https address. As a note, the user must be fully logged into the system and a valid session in progress and it, the session has not timed out. The fully qualified URL may look something like this: https://data0.adilas.biz/top_secret/search_action.cfm?aiSearch=[prompt]

The sub domain and the primary domain may change, depending on where the user is logged in at. This will need to change based on the server, that they are using. The path, top_secret/search_action.cfm will always be the same, no mater what domain and sub domain are being used.

The actual prompt or key words will vary depending on what is being asked. As a note, when using the URL scope, the prompts need to be URL encoded. Use %20 for spaces (percent sign, numeric 2, and numeric 0).

The URL variable name is called "aiSearch". It will look something like this: top_secret/search_action.cfm?aiSearch=new%20cart where aiSearch is "new cart" for this example. The question mark (?) tells the page that one or more variables is going to be included in the path. Technically, this is called the query string. That value could be any number of things. Here are a couple of sample:

aiSearch=invoice%20home (keyword invoice home - take me to my recent sales)

aiSearch=time%20home (keyword time home - show me the calendar)

aiSearch=clear%20cart (keyword clear cart - clear the shopping cart)

aiSearch=invoice%20555 (keyword invoice 555 - go to invoice 555)

aiSearch=deposit%20777 (keyword deposit 777 - go to deposit 777)

Once again, there are over 350 possible keywords and prompts. Please see this help file for more information and to view the real prompts and keywords.

If you would like to use the FORM scope, the system has a number of quick search forms or fields that you may use. The easiest way is to use the quick search in the page headers. If you want more technical information on the FORM scope, see below for a code sample. The opening and closing brackets were left off on purpose, just for this code sample.

form action="search_action.cfm" method="post"

input type="text" name="ai_main_search_field" value="" maxlength="255"

input type="submit" name="search_btn" value="Go"

form

The main important details, if using the FORM scope are the action needs to point to search_action.cfm page. If needed, you could fully qualify it similar to https://data0.adilas.biz/top_secret/search_action.cfm - remember that the primary domain name and sub domain names may change per server.

Use the "post" method to send the form values. It is okay to use plain English for the form fields values. No URL encoding is required. Okay to be just simple text values.

The main input field needs to be named "ai_main_search_field". Once you have the correct path, the correct method of post, and the correct field name, the prompt should go directly to the correct page. Pretty simple.

« Back . [contact Adilas support - email form]