Use this information as a guide to the Andornot Search Cannery Wizard.
Select your version of WebPublisher (SQL or non-SQL) or select Genie.
ISAPI or CGI
It's most likely your WebPublisher was configured to use ISAPI when it was installed. If in doubt, try ISAPI first for your query. If the query throws a '404 - File not found' error, it might indicate that WebPublisher is using CGI.
Your Website URL or WebPublisher URL
Enter the URL of the website where you'll be using WebPublisher. Include the 'http://' bit.
Or enter the full URL to your WebPublisher location.
e.g. for DB/Text WebPublisher ISAPI: http://www.andornot.com/dbtw-wpd/exec/dbtwpub.dll
e.g. for DB/Text WebPublisher CGI: http://www.andornot.com/dbtw-wpd/exec/dbtwpcgi.exe
e.g. for DB/Text for SQL WebPublisher ISAPI: http://www.andornot.com/ics-wpd/exec/icswppro.dll
e.g. for DB/Text for SQL CGI: http://www.andornot.com/ics-wpd/exec/icspcgi.exe
e.g. for Genie: http://www.andornot.com/inmagicgenie/opac_report.aspx
If you're unsure, try a search from your current search page and look for one of the above examples in the URL.
TN - Textbase Name
If you're unsure of the precise name of your textbase, open the textbase in DB/TextWorks. The title bar at the top of the window will list the textbase name. You can also select Display > Textbase Information. One of the lines in this report will tell you the location and name of the textbase.
Sn - Saved Set Name
An alternative to writing a query in command syntax is to create a saved set in DB/TextWorks, then reference that in this canned query. For example, you might search for all books published by John Doe and save that set as "JohnDoe", entering that set name here. Note that if you add new books by John Doe, you'll need to update the set in DB/TextWorks to include them.
RF - Report Form
Enter the name of the report form you've designed in your textbase for displaying brief search results. For example, if you are using the Andornot Starter Kit, a form such as WebBrief or WebDate would be a good choice.
DF - Display Form
Enter the name of the report form you've designed in your textbase for displaying a full record. For example, if you are using the Andornot Starter Kit, a form such as WebFull would be a good choice.
Enter the name of the Genie form you wish to use to display brief search results, selected from those in the Genie MyReports.config file. For a search of the Genie OPAC, OpacBrief is a good choice.
BU - Base URL
Enter the full URL of your search page location. This allows any relative URLs (images, CSS stylesheets, etc.) in your results to resolve properly.
QY - Query
If you're already familiar with Inmagic command query syntax, you can write the query directly here. However, a more foolproof method is:
- Open DB/TextWorks and the textbase you want to search.
- Enter search criteria and run the search to get desired results.
- Select Search > Command Query to view the command query syntax for the search you just ran.
- Copy this syntax and paste into the QY field in the Search Cannery.
- Once you get results, go to 'Command Query' from the Search menu. Copy and paste the search syntax.
One of the most useful queries is to find items recently added to the textbase. If you have an Automatic Date field named something like RecordCreated, try entering >=@DATE-60 in that field. This means find everything created from 60 days ago to the present. Adjust the 60 days parameter to capture more or fewer records (for example, if you enter 10 new ones per week, you might want to reduce it to just 7 or 14 days).
Note that accented characters work best in a query using the results control in the Andornot Starter Kit and may not work as expected when searching against the WebPublisher DLL directly.
More information is available on Inmagic query syntax.
MR - Maximum Records per Page
Limiting search results to 10 or 20 per page helps users navigate, especially when you have Next and Previous links.
TR - Total Records
Truncates the total number of results WebPublisher returns. If the search finds 9999 records, but TR=1000, only 1000 results will come back. Not a good idea to use this unless searches are returning many thousands of records and the search time is unacceptably slow as a result.
RL - Report List Behavior
Determines whether to offer the user a choice of other brief search results forms you have created. If you are using the Andornot Starter Kit, select "Don't show Report List" (as they are built in to the Kit instead).
DL - Display List Behavior
Determines whether to offer the user a choice of other full record display forms you have created. If you are using the Andornot Starter Kit, select "Don't show Display List" (as they are built in to the Kit instead).
Next Previous Toolbar Location
Specifies where the WebPublisher Next and Previous links will appear. If you are using the Andornot Starter Kit, select "Don't Show" (as they are built in to the Kit instead).
CS - CSS Positioning
Tells WebPublisher whether to use CSS absolute positioning to try and make forms look the same on the web as they do on desktop. Raw HTML and inline images in your form will be ignored if you turn this on. If you are using the Andornot Starter Kit, select "Do not use CSS".
MF - Message File
By default, WebPublisher uses the WPEngMsg.ini (DB/Text WebPublisher) or CSEngMsg.ini (DB/Text for SQL WebPublisher) as the source of error message wording and appearance. If you have created your own version of the message file, indicate its name here. For example, the Andornot Starter Kit includes the English message file GenericEngWpMsg.ini and the French message file
ID - Textbase Password
If your textbase requires a password to search, enter it here.
If you have designed a web-based edit form in your textbase and wish to permit editing from canned query search results, enter the name of the form here.
EL - Edit List Behavior
If you have designed more than one web-based edit form in your textbase and wish to offer a choice, select an option here.
Enter the text you'd like to use as a hyperlink. e.g. "View new records".
Can It and Test It
Click "Can It" to generate HTML code for your search. Note that this includes both the hyperlink and link text as complete code ready to copy and paste into a webpage. Note that spaces and some other characters are converted to HTML-encoded equivalents.
Click "Test It" to open your canned query search in a new browser window. If used DB/TextWorks to create the command query, the search results here should be the same as you found in DB/TextWorks.