Available Pages, FORM Fields, URL Variables, and Other Options
|
The pages below may be accessed either via FORM or URL scoped variables. For the most part,
you should either access a page fully by FORM or URL scope and not both at the same time.
The two exceptions are the web_inventory.cfm and web_general_inventory.cfm pages. ** See
special note below for pagination help.
|
The main URL address for the web folder is: https://data0.adilas.biz/shop/
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
search_web_inventory.cfm
|
|
|
|
This is the main starting page for the application. This page is capable of showing search forms and
quick links. The search forms that are shown on this page are controlled from within the main adilas.biz
application. The top section (if applicable) is for the stock/units or bigger ticket items (serialized
inventory). The bottom section (if applicable) is for parts and general inventory. Depending on the
settings, this page may show either section and/or both sections (stacked on top of each other).
|
|
corp_key_id
|
corpKeyId
|
blank
|
Required on every page - Must be at least 5 characters in length. First 3 chars of corporation name, a
dash (-), and the corporation id number. Ex: MOR-0002
|
|
nav
|
nav
|
"show"
|
Required on every page - The default is set to "show". If this param is not passed in, it will set
itself to the show value. The other option is the string "hide". The value "show" will
allow the pages to be viewed with the company logo, a title and current date on every page, sub navigation, and a page
footer. If the value of "hide" is used, the pages will be shown without any top branding (logos and
titles) and will just show the main page information. It will also hide the sub navigation and footer. There
will still be a back button link to help with basic navigation. Please note, once this value is set or passed in, all
other page links and navigation will continue to pass it on to the next page. Example for URL scope use: nav=show or nav=hide
[example using "show"]
[example using "hide"]
|
|
display
|
display
|
"sm"
|
Required on every page - The default is set to "sm" (or small size) and deals with the report display mode.
The display mode basically changes the output of the reports and either shows a small thumbnail image (29 x 22 pixels)
or a medium thumbnail image (160 x variable height pixels). If this param is not passed in, it will set
itself to the small display value. The other option is the string "med" or medium size. Once passed in, this
value will be passed on all of the links and sub navigation to maintain your settings. The true power of this setting is
best viewed in the web_inventory.cfm (stock/units) or web_general_inventory.cfm (parts and general inventory) page
section (see next page settings). Example for URL scope use: display=sm or display=med
[example using "sm"]
(this will set the display mode in the search form to small and will be used on all sub links.)
[example using "med"]
(this will set the display mode in the search form to medium and will pass through on all sub links.)
|
|
showCount
|
showCount
|
25
|
Required on every page - The default is set to 25 (show 25 units per page). The value should be numeric,
if not, it will be forced to an actual numeric value. The minimum is 1 and the max is 200 units per page.
The number submitted (showCount var) is the top level amount possible per page. However, the page results
may be less depending on the search that is performed. Example in the URL scope: showCount=25
[example using a count of 50]
(this will put the number 50 in the search form and pre-load all sub links with the count value of 50.)
|
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
web_inventory.cfm
|
|
|
|
This page will show the search results in a report-type fashion. This is the page that will show the stock/units
or bigger ticket items (serialized inventory). Once the results are returned, there will be drill-down links to each
item to view details and photos.
|
|
corp_key_id
|
corpKeyId
|
blank
|
Required - See note above.
|
|
inventory_type_id
|
type
|
blank
|
Optional - Use a blank value to skip or a numeric value to use as a filter.
|
|
location_id
|
location
|
blank
|
Optional - Use a blank value to skip or a numeric value to use as a filter.
|
|
make_id
|
make
|
blank
|
Optional - Use a blank value to skip or a numeric value to use as a filter.
|
|
model
|
model
|
"All"
|
Optional - Use the string "All" or leave blank to skip. Use an actual value to use as a filter. May be a
string and/or a number. The database SQL will use "like" (flex search) instead of equals. This means that
there are built-in wildcards to help keep things flexible.
|
|
sub_inventory_type_id
|
sub
|
blank
|
Optional - Use a blank value to skip or a numeric value to use as a filter.
|
|
** see notes
|
page
|
1
|
Required - ** This param should be passed in on the URL string. If not there, the application will assume
page 1 (this helps if using FORM params on the initial search). Please note, if the page returns more
records than the show per page value, pagination will occur (page # of total pages). At that point,
all FORM scope values will be converted to their URL scope values. All other page requests within that
record set will be done via the URL scope. To get back to the FORM scope, a new search is required.
|
|
nav
|
nav
|
"show"
|
Required - See note above.
[example using "show"]
[example using "hide"]
|
|
display
|
display
|
"sm"
|
Required - See note above. This is the page where this param has the biggest effect on what is shown.
[example using "sm" thumbnails]
[example using "med" thumbnails]
|
|
showCount
|
showCount
|
25
|
Required - See note above.
[example using count of 5]
[example using count of 25]
[example using count of 100]
|
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
web_unit_detail.cfm
|
|
|
|
This is the detail and photo gallery page for stock/units (serialized inventory). This is what
the customer or the general public will see as far as the details per unit. This includes description,
price, and location contact information. If the unit has any photos, they will also be displayed
here on this page.
|
|
corp_key_id
|
corpKeyId
|
blank
|
Required - See note above.
|
|
stock
|
stock
|
blank
|
Required - Must be numeric. This allows you to drill-down to a single stock/unit detail page with full description info and photos.
|
|
nav
|
nav
|
"show"
|
Required - See note above.
[example using "show"]
[example using "hide"]
|
|
display
|
display
|
"sm"
|
Required - See note above.
|
|
showCount
|
showCount
|
25
|
Required - See note above.
|
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
large_photo.cfm
|
|
|
|
This is the large photo gallery page. This page is used for both stock/units and parts and general
inventory. Each photo will be shown at it's largest dimensions. The page will also include any
caption information, photographer information, and possible next n (multi) navigation to see other
large photos or images. All page variables will need to be in the URL scope for this page.
Note: This is the most complicated page as far as passing in URL variables. Some developers have chosen to
navigate to the detail pages (actual stock/unit or part number), and then let the system do the actual
drill-down to the images.
|
|
none
|
corpKeyId
|
blank
|
Required - See note above.
|
|
none
|
caption
|
blank
|
Optional - Photo caption if desired.
|
|
none
|
person
|
blank
|
Optional - Credits for person who either took and/or posted the photo online.
|
|
none
|
photo
|
blank
|
Required - Must be numeric. This is the photo number to show.
|
|
none
|
stock
|
0
|
Required - Must be numeric. This is the stock number tie to the correct unit. This will be the
actual stock/unit number if browsing for a unit photo or set to 0 if browsing to a specific part
number photo. The URL.stock var and the URL.partId var are the main switch to tell the page what
to show.
|
|
none
|
partId
|
0
|
Required - Must be numeric. This is the part id number tie to the correct part or general item. This
will be set to 0 if browsing a stock/unit photo and an actual valid id number if browsing a part number photo.
|
|
none
|
photoCount
|
0
|
Required - Must be numeric. If you don't know, either don't pass in the param or set it to 0. If you know it,
pass it in and the page will show additional navigation (next n links or photo pagination). Ex: photoCount=0 or photoCount=12
[example without a photo count]
[example with a valid photo count]
|
|
none
|
nav
|
"show"
|
Required - See note above.
[example using "show"]
[example using "hide"]
|
|
none
|
display
|
"sm"
|
Required - See note above.
|
|
none
|
showCount
|
25
|
Required - See note above.
|
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
web_general_inventory.cfm
|
|
|
|
This page will show the search result in a report-type fashion. This is the page that will show the part numbers
or general inventory items (smaller ticket items). Once the results are returned, there will be drill-down links
to each part number detail page, part descriptions, and part photos.
Example links for parts and general inventory will use a fictitious company called Aspen Air - FBO. Corporation key ASP-0057.
|
|
corp_key_id
|
corpKeyId
|
blank
|
Required - See note above.
|
|
part_cartegory_id
|
category
|
blank
|
Optional - Use a blank value to skip or a numeric value to use as a filter.
|
|
part_number
|
part
|
"All"
|
Optional - Use the string "All" or leave blank to skip. Use an actual value to use as a filter. May be a
string and/or a number. The database SQL will use "like" (flex search) instead of equals. This means that
there are built-in wildcards to help keep things flexible. For the record, this filter will search the part id, the
part number, the part description, the barcode, and the reference number.
|
|
** see notes
|
page
|
1
|
Required - ** This param should be passed in on the URL string. If not there, the application will assume
page 1 (this helps if using FORM params on the initial search). Please note, if the page returns more
records than the show per page value, pagination will occur (page # of total pages). At that point,
all FORM scope values will be converted to their URL scope values. All other page requests within that
record set will be done via the URL scope. To get back to the FORM scope, a new search is required.
|
|
nav
|
nav
|
"show"
|
Required - See note above.
[example using "show"]
[example using "hide"]
|
|
display
|
display
|
"sm"
|
Required - See note above. This is the page where this param has the biggest effect on what is shown.
[example using "sm" thumbnails]
[example using "med" thumbnails]
|
|
showCount
|
showCount
|
25
|
Required - See note above.
[example using count of 5]
[example using count of 25]
[example using count of 50]
|
|
Page Name
|
FORM Fields
|
URL Variables
|
Default Value
|
Special Notes
|
web_item_detail.cfm
|
|
|
|
This is the detail and photo gallery page for individual part numbers (general inventory or small
ticket items). This is what the customer or the general public will see as far as the details per
part number. This includes description, price, and photos (if any).
Example links for part number details will use a fictitious company called Aspen Air - FBO. Corporation key ASP-0057.
|
|
corp_key_id
|
corpKeyId
|
blank
|
Required - See note above.
|
|
part_id
|
partId
|
blank
|
Required - Must be numeric. This allows you to drill-down to a single part number detail page with full description info and photos.
|
|
nav
|
nav
|
"show"
|
Required - See note above.
[example using "show"]
[example using "hide"]
|
|
display
|
display
|
"sm"
|
Required - See note above.
|
|
showCount
|
showCount
|
25
|
Required - See note above.
|