10. Miscellaneous

 

The Miscellaneous section is comprised of two tabs, Miscellaneous Functions and File Transfer. Because we have already covered File Transfer in another section, we will not cover it here and concentrate on the Miscellaneous Functions Tab.

The Miscellaneous Function tab consists of several sections, which I suspect will become tabs in the future. But for now they are listed on one page as links, so we will lay them out and discuss each in turn.

 

10.1 – Miscellaneous – Miscellaneous Functions

10.1.1 – Misc – Misc Functions – File Management

File management is simply different starting locations for the same File Transfer utility that we have discussed previously. On the server, Interchange has a standardized directory structure, one that is quite consistent throughout different versions and installations. There is normally a “home” directory that is usually named with the name of the catalog. Under that directory are the many different directories that hold the files that the catalog is made of.

One reason for the consistent structure, and the fact that all other directories fall UNDER the “home” or catalog directory, is portability. If you need to transfer your catalog to another location, generally you can compress the entire catalog and simply move it. It is recommended to keep symbolic links and so forth limited to within this directory structure for that reason. Again, nothing is written in stone, and Interchange can be made to run with directories spread all over if you wanted to. But for the best efficiency, use what others Each of the following sections is just a link to the area described by the title –

  • 10.1.1a – Misc – Misc Functions – File Management - Upload/Download Pages: Generally will start in the catalog_name/pages directory. This is where the standard catalog pages are stored. You may want to download pages to your local machine to work on, and then load them back onto the server. However, because of complex template and component structures, in most cases it is best to access pages through the Interchange UI, and then copy and paste the “Content” area from the page to and from your html editor.

  • 10.1.1b– Misc – Misc Functions – File Management - Upload/Download Images: Generally will start in the catalog_name/images directory. This is where the images directory structure is stored. Images may have several sub directories, such as items and thumb, where images for the items are stored, as well as “thumbnail” or smaller images used to display with results from searches and so on.

  • 10.1.1c – Misc – Misc Functions – File Management - Search for sessions: Generally will start in the catalog_name/sessions directory. This is where the records for each user session are stored. You will not normally use this link, your Interchange Developer may use this area to track down problems that may be occurring.

  • 10.1.1d– Misc – Misc Functions – File Management - General File Transfer: Generally will start in the catalog_name directory. This is the top-level directory for your catalog. In this directory you will normally only have a few files, and several sub level directories. The files that will generally be located in this directory are catalog.cfg, and error.log. These are probably the 2 most important files in your catalog. Catalog.cfg determines quite literally how your catalog will operate. And, the error.log gives vital clues as to what is wrong when your catalog is not operating. Generally these 2 files should not be accessed unless you have experience with Interchange. In any case, make sure you have a backup saved PRIOR to any changes. That way if your catalog will not restart, at least you have a place to go back to!

 

10.1.2 – Misc – Misc Functions – Backup Functions

10.1.2a – Misc – Misc Functions – Backup Functions - Create catalog tar file

Transfer a catalog -this function creates a compressed tar file and an editable restore script for transferring a catalog from one server or location to another. This is a complex operation, and there are MANY variables. Only qualified Interchange Administrators or Developers should attempt to use this feature.

As stated in the online help for this feature, “It will only work properly with a "foundation" style setup with appropriate variables set properly” and it goes on to say “Also, this is designed for Linux systems or other systems with the GNU utility set. It relies on GNU tar and gzip. This only works for the default database, Mysql, and Postgres.”

With those caveats in mind, lets discuss the feature a little more in depth. What is happening here is that a script is being created to create a new catalog on the target server using your existing data and configuration. So all the options you see on the screen above will go into the script. If you want everything to remain as it is on your current server, then most likely you will leave each of the above settings with their default (current to your existing catalog) settings. Depending on how your new location is set up, you may HAVE to change some of the settings. If you simply want a different catalog name with everything else being the same, you can use the Rename window at the top of the screen. Simply enter the new name for the catalog in the window at the top of the screen, and click on the Rename button. Everywhere the old catalog name is used will be replaced with your new selection.

Now, we will go over each of these fields briefly:

  • SERVER_NAME – This is the name of your server or domain URL, without the leading protocol (the http://). For example www.yahoo.com.

  • SECURE_SERVER - This is the name of your secure server or domain URL, with the leading protocol the https://). For example “https://www.yahoo.com”.

  • CGI_URL - The url (without the server) to call the catalog. For example “/cgi-bin/my_catalog”. Interchange uses variables to form these various URL’s. To understand a little more completely, if you put the SERVER_NAME together with the CGI_URL, you would get the location that would be seen in your address window of your browser when you accessed the website. So using our example above, to get to catalog using your browser, the variables would convert like so:

http://_SERVER_NAME__CGI_URL_ or after the variables are interpolated ->

http://www.yahoo.com/cgi-bin/mycatalog

Note the slash preceding cgi-bin? That is included in the CGI_URL variable, not in the SERVER_NAME variable. Keep an eye out for such things as they are a common cause for problems if not entered correctly.

  • IMAGE_DIR – The image directory base url, again this will be plugged into the end of the SERVER_NAME variable, so make sure it has the proper format, for example “/my_catalog/images”.

  • SQLDSN

  • SQLUSER – SQL user if any. If you created a database in MySQL, Postgres, (or other database programs) you have the security option of giving access to that database only to specific users. That user can be Interchange, (the user Interchange is running under) or Interchange can provide the database with the username if it is different than the Interchange user.

  • SQLPASS – SQL password. See SQLUSER above. Note: password is stored in standard text form.

  • DOCROOT – This is the path location on your server where your html root is located. For example your default “index.html” outside of the catalog framework will normally be located here.

  • ORDERS_TO – The email address orders should be sent to.

  • SAMPLEHTML - Base HTML directory for the catalog (not usually important)

  • SAMPLEURL - Base static URL for the catalog (not usually important)

  • IC_DIR – The directory that the Interchange software is located within. Default is /usr/local/interchange, but this can and many times is located in a different area.

  • CGI_DIR – The directory where your cgi programs are stored, and where the link file will be copied to.

  • Link File – If you make a selection other than the default, the script will attempt to compile the cgi link program that calls interchange and place it into previously defined CGI_DIR. Otherwise you must manually compile or otherwise provide the link program.

  • Information – There are 3 fill-ins in the Information area:

  • Inhibit setuid if Unix mode – Intended for use with apache and suexec mode, or CGI-Wrap. Contact your Interchange developer to determine your needs.

  • Link Host if Inet mode – Only used for inet mode, contact your Interchange Developer.

  • Link port if INET mode - Only used for inet mode, contact your Interchange Developer.

  • Options

  • Create Database on target – will try to create a database, MySQL, Postgres, what ever you have chosen, on the target machine. Highly

  • Add Catalog line to interchange.cfg – This will add the appropriate catalog line to the interchange configuration file which will allow the IC server to recognize this new catalog.

  • Keep Files – This is simply a list of files that you can have “make the trip” with you. If you do not select any of these files, none of them will be transferred to the new site location.

That will take care of most of the catalog configuration issues. The other area being dealt with is database. THIS UTIILITY WILL ONLY WORK FOR THE DEFAULT INTERCHANGE DATABASE, MYSQL, AND POSTGRES.

Quoting directly from the IC help file on Transfer a catalog:

If you are using a SQL database on one DSN defined in SQLDSN, it will dump the database using the mysqldump or pg_dump utilities; they must be available in your PATH.

If you have more than one DSN, it will do the dumps but not create the restore script for those dumps; that must be done manually.

It exports all non-Postgres/MySQL database files to text files and does NOT transfer their associated .gdbm, .dbor .sqlfiles. This may suffice to transfer other SQL databases depending on how they were defined in the dbconf/directory.

It puts the database dumps and exports in the directory "xfer". Finally, it creates a tar file named CATALOGNAME.tar.gz, where CATALOGNAME is equal to IC's name for your catalog.

To restore the catalog, create the target directory where the catalog will be, then change directory there and restore the tar file.

mkdir -p /var/lib/interchange/newcat

cd /var/lib/interchange/newcat

tar -xzf /tmp/oldcat.tar.gz

 

If the directory already exists, move it somewhere else for backup purposes (or delete it entirely if you are sure it is safe to do so).

From that directory, inspect the shell script xfer/restore.shand make appropriate changes; this may include authorization or path information for the restoring calls to mysqlor psql. Once you have made any changes, run the shell script:

cd /var/lib/interchange/newcat

xfer/restore.sh

 

You will have to set any permissions separately if the restoring user ID does not have them.”

 

10.1.3 – Misc – Misc Functions – Legacy Tools

The legacy tools section provides some backwards compatibility with the previous versions of Interchange. There are two tabs in Legacy tools, Layout editor and Layout Auto-populate. They are somewhat inter-dependent, so it will shed light on the workings of each to give an overview of how this section works in total.

The Layout editor operates on two tables, area and cat. These tables work together to create a manageable hierarchy of your products or services. Area can be thought of as the top of the hierarchy grouping or the parent, with cat being the next level down or the child. For example, in the Demo you have a product group that would be in the Area table, Hand tools. Within the product group of hand tools, you have categories such as Pliers or Shears, which are defined in the cat table.

Each table, area and cat, needs to be associated with the products table in order for you to effectively relate these groups and categories to the individual products. That is where the Layout Auto-populate tab comes in. You select which columns will be related to the area table (as the parent level in the hierarchy) and which columns will be related to the cat table (or the secondary or child level in the hierarchy.)

After you have selected this, you use the Layout Auto-populate tab and it will add the required information to the area and cat tables, automatically.

Normally, with a new catalog, you would use the Layout Auto-populate tool first. Then you would go into the Editor and select what goes where. So if you wish, you can read the section on the Layout Auto-populate tab first, or just continue on to the Layout Editor.

10.1.3a – Misc – Misc Functions – Legacy Tools – Layout Editor

The Layout Editor allows you to create a manageable hierarchy for products and services on your site. As explained above, the Layout Editor is normally used AFTER the Auto-Populate tab. In the example above, Auto-populate has already been run. NOTE: you do not have to run Auto Populate, and in some cases it may be easier not to. We will talk more about Auto Populate in that section. For now we will assume you have the groups and categories above already loaded into the Layout Editor.

When you first come to the Layout Editor, you will see something like what is displayed above. So lets talk about what to do first!

First there are three sections on the top of the page, Area – Section, Contains, and Available categories.

  • The FIRST, Area displays the “Sections” that are currently available to use (this shows all entries in the “name” field from the “area” table).

  • The THIRD section, Available categories shows available categories (this shows all entries in the “name” field of the “cat” table)

  • The SECOND section “Contains” is a selectable area that allows you to associate, or disassociate, ANY of the available CATEGORIES, with the currently selected SECTION. When you click on one of the entries in the Area section, the categories that are currently associated with that Section will appear in this “Contains” window. In the example above, the left-Hand Tools area is selected, and the categories that are associated with left-Hand Tools are displayed in the “Contains” window. (Brushes, Hammers, Hand Planes, Hand Saws, and so on) I said you could either associate or disassociate these categories, and you do that by:

  • To associate an additional category with the current section, click on the desired category from the Available category window, and then click on the left arrow located next to the Available category window. This will move the desired category into the Contains window, and add it to the section.

  • To disassociate a category from the current section, click on the desired category from the Contains window, and then click on the right arrow located next to the Available category window. This will remove the desired category from the Contains window (and the section).

Before we move to the Section Properties, and Category properties, I will quickly describe the Icon meanings:

  • - Properties – Display the properties below of the currently selected item, either Section or Category.

  • - Sort Higher – This will move the currently selected item, either Section or Category, to a higher position in the list. This will also display the item higher on the web site. Places an appropriate number into the “sort” field of the appropriate table. This field is then used to sort the list when the list is created and displayed on the site.

  • - Sort Lower – This will move the currently selected item, either Section or Category, to a lower position in the list. This will also display the item lower on the web site. Places an appropriate number into the “sort” field of the appropriate table. This field is then used to sort the list when the list is created and displayed on the site.

  • - Create Item – This will allow you to create a new item for the list. If you are working with the Section list, then a blank form will be displayed in the Section Properties area, and if you are working with Category, then a blank form will be displayed in the Category Properties area. We will discuss how to fill these areas in below.

  • - Delete Item – This will delete the respective item from the respective table. Be careful, if you delete an item (section or category) you will have to use the Create item to replace it. You cannot “Undo” this operation.

Let’s move on to the Properties windows. There are two Properties windows, Section and Category.

The Section Properties contains several text entry areas:

  • Name – The name to be used to identify the Section. This will populate the “name” field in the “area” table. It will also be the name displayed on your menus.

  • Page Class – This is used to select which pages this Section will be displayed on. Choose all unless your Interchange Developer tells you other choices are available. This will populate the “which_page” field in the “area” table.

  • Page Area – This is used to determine which sections a component will display. You may want some sections displayed on components used on the left side of your page, or you may have sections that would display more appropriately if they are included in a horizontal presentation, such as top. This “populates” the “sel” field in the “area” table.

  • Link Type –

  • No link – Just displays the Section name, not clickable.

  • External Link – Use a link such as http://www.yahoo.com to link to a site out side of your catalog

  • Interchange page – Link to a page within the catalog. Once selected, a drop down window will appear upon the next access to Section properties, (you must click on change section button, and then navigate back to this page) populated with all available catalog pages. Simply select one.

  • Simple Search – Once simple search is selected, three windows will appear upon the next access to Section properties. (You must click on change section button, and then navigate back to this page)

  • One of the windows will be a drop down containing all the available tables to choose from in your catalog.

  • The second window will be labeled “field=column pairs”. You will need to enter the field you want to search, and the search entry. For example: “category=Pliers”

  • Finally the third is a drop down window labeled Results page. The default is the standard results page, but you can choose your own custom page if you have one. All of this will create a link on the section you have selected that will return a search of the category field on the products table for the string “Pliers” and return the results to the results page.

  • Complex Search - Once Complex search is selected, a Complex search link text window, with “Create” and “Clear search” buttons will appear upon the next access to Section properties. (You must click on change section button, and then navigate back to this page)

You can use the Create button to go to the Search Wizard and allow Interchange to guide you through building a search, or you can simply enter the search that you want, using Interchange standard search format, into the text window as shown above. If you are not familiar with the standard search format, either use the Search Wizard, or contact your Interchange Developer.

  • Display Type –

  • Banner Text or Name – The section will be displayed with the Name you have entered into the Name field.

  • URL Only – The section will be displayed with the URL only, if you selected no link for the Link type, then nothing will be displayed.

  • Icon and Name - Once Icon and Name is selected, two additional windows, Image and Image properties will appear upon the next access to Section properties. (You must click on change section button, and then navigate back to this page) When you use this option, the image you select, along with the name you selected above, will be used together on the display.

  • Image – You can either insert a relative file address such as “image.gif”, if the image is located in the standard images directory, or a complete address such as http://www.someotherwebsite.com/images/myimage.gif.

  • Image properties – Here you can put additional html formatting code for your picture, such as border=2 color=blue and so on.

  • Image – This is identical to “Icon and Name”, except that only the image will be displayed, not the name.

  • Link Template – This is an advanced option, you can put alternate templates here that will override the standard bar_link template for nav bar entries. Contact your Interchange Developer for additional information.

  • Once you have completed your desired changes, click on the Change Section button. You will be returned to the Layout Editor first page. You can then navigate back into the editor to whatever Section and Category you were working on.

The Category Properties also contains several text entry areas and is very similar to the Section Properties:

  • Name – The name to be used to identify the Category. This will populate the “name” field in the “cat” table. It will also be the name displayed on your menus.

  • Link Type – (populates “link_type” field in table “cat”) Options are:

  • No link – Just displays the Category name, not clickable.

  • External Link – Use a link such as http://www.yahoo.com to link to a site out side of your catalog.

  • Interchange page – Link to a page within the catalog. Once selected, a drop down window will appear upon the next access to Category properties, (you must click on change category button, and then navigate back to this page) populated with all available catalog pages. Simply select one.

  • Simple Search – Once simple search is selected, three windows will appear upon the next access to Category properties. (You must click on change category button, and then navigate back to this page)

  • One of the windows will be a drop down containing all the available tables that you might want to search from in your catalog.

  • The second window will be labeled “field=column pairs”. You will need to enter the field in the table that you want to search, and the search entry, or what you are looking for in this field. For example: “category=Pliers”

  • Finally the third is a drop down window labeled Results page. The default is the standard results page, but you can choose your own custom page if you have one. All of this will create a link on the category you have selected that will return a search of the category field on the products table for the string “Pliers” and return the results to the results page.

  • Complex Search - Once Complex search is selected, a Complex search link text window, with “Create” and “Clear search” buttons will appear upon the next access to Category properties. (You must click on change category button, and then navigate back to this page)

You can use the Create button to go to the Search Wizard and allow Interchange to guide you through building a search, or you can simply enter the search that you want, using Interchange standard search format, into the text window as shown above. If you are not familiar with the standard search format, either use the Search Wizard, or contact your Interchange Developer.

  • Banner Text – You can enter alternate text to be displayed in place of the entry from the Name field, also will be displayed on the results page as the “Banner Text” or the heading of the results of the search you entered above. (Goes to the banner_text field of table “cat”)

  • Banner Image – You can enter an image that will be displayed on the results page (or other chosen result page). Your results page may or may not be preprogrammed to display the banner image, if not check with your Interchange Developer for assistance. (Goes to the banner_image field of table “cat”)

  • Display Type – (Populates display_type field in table “cat”)

  • Banner Text or Name – The category will be displayed with the Name you have entered into the Name field.

  • URL Only – The category will be displayed with the URL only, if you selected no link for the Link type, then nothing will be displayed.

  • Icon and Name - Once Icon and Name is selected, two additional windows, Image and Image properties will appear upon the next access to Category properties. (You must click on change category button, and then navigate back to this page) When you use this option, the image you select, along with the name you selected above, will be used together on the display.

  • Image – You can either insert a relative file address such as “image.gif”, if the image is located in the standard images directory, or a complete address such as http://www.someotherwebsite.com/images/myimage.gif.

  • Image properties – Here you can put additional html formatting code for your picture, such as border=2 color=blue and so on.

  • Image – This is identical to “Icon and Name”, except that only the image will be displayed, not the name.

  • Link Template – This is an advanced option, you can put alternate templates here that will override the standard bar_link template for nav bar entries. Contact your Interchange Developer for additional information. (populates the link_template field of table “cat”)

  • Once you have completed your desired changes, click on the Change Category button. You will be returned to the Layout Editor first page. You can then navigate back into the editor to what ever Section and Category you were working on.

 

10.1.3b – Misc – Misc Functions – Legacy Tools – Layout Editor Auto-populate

The Layout Auto-populate tab, as we briefly discussed before can be used to populate the area and cat tables from various tables, and fields. Normally you will probably use the products table, and would choose 2 fields from your data that would allow you to begin to organize your products or services in a rational hierarchical structure.

Although the area and cat tables are related to whatever table you chose to pull your information, they are only “loosely” related. That is you could have a “section” in the “area” table that did not exist in your products table. Normally you would not have this, but the point is you could. The tables are not restricted in this way.

This allows you to create any type of structure you want to group and display your products or services. You are not limited by the data. For example, suppose you have your data already entered into the products database, and it is in sync with your accounting database for any number of reasons. Now you want to display an arbitrary group of products for the 4th of July sale you have coming up. You can’t change the products database; it is linked to the accounting database. So you simply add a new section to the area table via the Layout Editor, and either create a special search to locate the items, or assign appropriate categories to the section. So the Layout Editor allows you to freely group your products in any way that is convenient to your application.

Not only can you simply choose a table and 2 columns, you can also limit what is returned from those two columns. So lets go through each selection on the Layout Auto-populate page:

  1. Choose a table as the source: - Choose the table that you want to select the columns from.

  2. Choose a column to populate areas: - Choose a column that you can use, either the entire column or a portion of, to populate the “name” field in the table “area”. This will be the top-level group.

  3. Choose a column to populate categories - Choose a column that you can use, either the entire column or a portion of, to populate the “name” field in the table “cat”. This will be the next level down under the top-level group.

  4. Choose a search type –

  • Narrow Search – Will search the prod_group and category columns.

  • Simple Search – Will search the category column only.

  • Complex Search – Allows you to create your own search below.

  1. Complex Search Code – only active if Complex Search is selected,

  2. Select the page class: - This is used to select which pages this Section will be displayed on. Choose all unless your Interchange Developer tells you other choices are available. This will populate the “which_page” field in the “area” table.

  3. Select the page area: - This is used to determine which sections a component will display. You may want some sections displayed on components used on the left side of your page, or you may have sections that would display more appropriately if they were included in a horizontal presentation, such as top. This “populates” the “sel” field in the “area” table.

  4. Decide whether to remove previous settings: - Choosing no (default) will allow existing entries in area and cat tables to remain, and appending them with your current selection. If you choose Yes, then all existing entries in area and cat tables will be deleted.

  5. Click this button to populate : This simply takes the settings you have specified above and populates the area and cat tables according to those specifications.

 

 

10.1.4 – Misc – Misc Functions – ITL Helpers

ITL or Interchange Tag Language helpers. The 3 sections in this chapter deal with the ITL and wizards that can simplify the tasks of building a syntactically correct Search or Button, as well as providing a platform to test code without actually putting it into a page…

10.1.4a – Misc – Misc Functions – ITL Helpers – Search Wizard

The search wizard consists of a series of screens that will help you assemble a search based on criteria you provide along the way. At the end you can see a sample return of your search, and you can generate the code that can be cut and pasted into a template that will return the results of your search when executed.

A normal search will consist of 3 pages, a table selection page, a criteria selection page, and a sort page. You can also create more complex searches by using the Narrow further button on the criteria page. We will cover the basic search pages here, if you understand them, the additional criteria pages will not be difficult to maneuver.

  • Table Selection Area

The table selection area of the Search Builder is shown above. For our example lets assume that we are going to have a 10-dollar sale, and we want to create a link that will lead to everything that costs 10 dollars or less. The first field is

  • Search Table – A search is based on a table; the default table is products because in most cases you will be trying to retrieve a list of products for some reason. You can search on any table you like, but remember, the default search template RESULTS page is only formatted to display results from the products table. If you search a different table, you HAVE to create a results page that takes this into account. If you have any trouble, contact your Interchange Developer. For our example, the products table is fine.

  • Search Locality – This determines whether you will search the text file or the database. As we discussed earlier, the text file and the database can be different, although in most cases they will be identical. Many of the newer Interchange sites are being built using MySQL or Postgres databases. In these cases it is generally best to use the Database search. If you are going to search the whole file, not just one column, for a result, the text file may be your best choice. In our case, we are going to be pretty specific with our search so we will use Database.

  • Search Template – This is where the results of your search will be sent. The default is results.html. The default page is only set up to handle results from the products database (or text file). So remember, if you want to search a different table than products, you will have to create a different Search Template, or results page, and save it in the /pages directory. Once you have done that, you can select it here. For our example, we will accept the default.

  • Page size – Simply limits the number of results per page that are returned. Clicking on the “More” link that will be displayed on the default results.html search template can access additional results. We will leave it at 50 for the example.

  • Unique Only – In our example, we may have duplicates; say more than one item that has the same price. We want all of them shown, so we will leave this with no selected.

  • Allow full expressions – Do you think Perl is something that comes from an Oyster? If so, then leave this default setting of no. If you know what it is and how to use Perl, then select yes and use a “regular expression”.

  • OK now click on the Next--> Button.

  • Criteria Page

Ok, page 2 criteria. We have just entered in where we are looking now let’s enter what we are looking for.

  • Search table – Yes, we already entered it. This is just so you remember what table you are searching!

  • Search field – The default is all fields. In our example, if we waited to search all fields, the customer would grow old before they saw all our products under $10! So for our example we will select…you guessed it, the price field.

  • Search Operation – This tells the search engine how to compare your criteria (coming up in the next entry field) to the data in the field(s) you just finished selecting. There are several selections available, so we will list them:

  • Regular Expression Match – this is the default and will be used most frequently. It will allow you to match anywhere in the field, for example if you use “foot” in the Search for field and “football” is in the Search field you specified, then Bingo you will match.

  • equal to – A text equal to. If you use this, you will ONLY see an exact match for your text search entry.

  • not equal to – A text not equal to. If you use this, you will see everything BUT your exact text search entry

  • Regular expression negate – The opposite of Regular Expression Match above. If it’s in the field anywhere, it will not match.

  • Greater than - Text – A little hard to understand, but an example MIGHT help, if you search for “os280” in the SKU field, and used greater than, some of the returned products would include os28010, or os280a. You think you have it? Wait, here’s another example. If you search for “n”, all the products would be returned because they all start with the letter “o” which is GREATER than “n”. IF you search for “p”, NONE of the products would be returned because the sku of all the products begins with “o” which is less than “p”.

  • Greater than or equal – Text – See the explanation for Greater than - Text.

  • Less than - Text – See the explanation for Greater than - Text.

  • Less than or equal - Text – See the explanation for Greater than - Text.

  • Greater than (numeric) – This search criteria is more in line with what most of you would commonly expect for a search restriction. This is simply a greater than comparison, for example if you have the number “10 “in the Search For window, and you are searching the “price” field, then all records that had a price greater than 10 would be returned.

  • Greater than or equal (numeric) – Same as Greater than (numeric) but includes the “Search for” entry in the result set.

  • Less than (numeric) – Returns all records all records that had a price less than the amount in the “Search for” would be returned.

  • Less than or equal (numeric) - – Returns all records that had a price less than or equal to the amount in the “Search for” would be returned. In our example we want to return all amounts, less than or equal to $10, so we will use this criteria for our Search Operation.

  • Search for – Yes, this is where you enter what you are looking for. Should have some relation to the Search field, for example if the search field is price, you would not put a color here! For our example, we are looking for all products $10 or less, so we will enter the number 10 here.

  • Case Sensitive – If you are using a text search, you can specify that case sensitivity be considered in the search.

  • Word/partial word – Best described by the example on the screen: “If you select partial, a search for "bread" would match "breadbasket" and "bread". If you select whole words, it would only match "bread".”

  • Match beginning – Again, best described by the onscreen example: “By default, a search for of "bread" would match both "rye bread" and "bread bowl". If you select match beginning, it would only match "bread bowl".

At this point, we could do one of two things. We can continue on to the third and final page, or we could specify further search criteria. For our example, we are going to continue on, but if you wanted to further restrict the search, you would click on the Narrow Further button. This will simply take you through the same page we just described, but you can select another field to further restrict the search. For example, suppose in our example, we wanted to not only limit the search to items equal to or under $10, but we also wanted only New items. Perhaps we would have a field “new” that had either a yes or no in it. We could then first specify the 10 or under numeric search, and then further specify a text search for the word “yes” that would further restrict our search to New products under $10. For now, lets move on to the third and final page, sorting.

The third and final page on the Search Wizard is the sort page. This formats how your results will be displayed when they are returned. There are two areas, sort field, and Search return field. We will break them out and examine them.

  • Sort Field – The sort field allows you to sort the returned information. You can pick up to 3 fields to sort by. They will be sorted in the order of choice, from top to bottom. The first window lists the available fields, and the second window lists types of sorts. In the example above we have chosen to sort first by the price field, and next by the description field. In the price field we are sorting by reverse numeric, which will be from largest to smallest, and in the description price we are sorting by Normal, which will be an ascending alphabetic sort. The types of sorts are:

  • Normal – Standard alphabetic sort, ascending. “A, B,C…a,b,c”.

  • Numeric – Standard numeric sort, ascending “1,2,3,4…9,10”.

  • Reverse – Standard alphabetic sort, descending. “z,x,y…Z,X,Y”.

  • Case insensitive – Alphabetic sort, ascending, case insensitive “apple, Auto, Blue, boy…”

  • Reverse Numeric – Numeric sort, descending “10,9,8…3,2,1”

  • Reverse Case insensitive – Alphabetic sort, descending, case insensitive “boy, Blue, Auto, apple”.

  • Search Return Field – Use this only if you have a custom results page. It allows you to specify which fields are returned from the search. On the results page use [PREFIX-param field], where the field name is the same as you have chosen here.

Once you have specified all the above, you should select the Preview button to make sure that what you have entered, in fact returns the results you intended. We have entered a search that should return all products equal to or less than $10 in price, and sorted first by price from most expensive to least expensive, and next sorted by description if 2 products are the same price. Here are the results:

We got back all products equal to (there were none) or under $10. Two products where $8.99 and two where $5.99. If you look at those products, you will see that that are arranged in alphabetical order.

So now we have the search we want, so click on your browsers back button and go to the final page again. This time click on the Finish button, and you will come to this screen:

You can now cut and paste this code into the location of your choice and your search is formatted and ready to go. There are of course some criteria that need to be followed, to be sure that your code will work. For example, if you wish to create a clickable link, you will need to format it something like this:

<a href=”

[your cut and paste search here]

>My Search</a>

Or using the demo above

<a href=”

[area href=scan

search=|

 

fi=products

st=db

 

co=1

 

sf=price

se=10

op=<=

nu=1

 

ml=50

tf=price

to=nr

tf=description

to=x

|

]

>My Search</a>

 

Use the Search builder to assure yourself of both the format, and the results. It will save you time!

10.1.4b – Misc – Misc Functions – ITL Helpers – Button Builder

The Button Builder should really be called the Item Order Button OR Link builder. This little utility will allow you to build an order link that can be placed within the <a href=”[your cut and paste link “>Your link</a>, similar to the search builder described previously, OR a button within a form tag. Quickly build an order link or button. Lets go through the process to build an order link or button.

Starting at the top of the screen and working down, we will describe each item.

  • Empty basket – This is a utility link to dump the contents of the shopping cart, so that you can do repeated tests without ending up with a shopping cart full of 100+ items!

  • Test Order Link – This will be the test link that is created by the criteria you are going to enter below. If you selected button in the Type window below, a button will be displayed here. Simply click on the link or button to test it and make sure the item or items you want to be ordered, are in fact ordered.

  • Resulting Button window – If you choose “Button” in the Type window, this window will display the html to cut and paste for a form that includes the submit button. If you choose “Link” in the Type window, this window will display the link text that you can insert into an <a href=””> tag.

  • Type – Select which item you want to create, a link or a button.

  • Item Code – This window will display the description for the items available in the products database. Chose the product or products that you wish to order with the link or button. To choose multiple items, hold your CTRL button while left clicking on the selected items. Alternatively, you can enter the individual SKU into the window just below the main window.

  • Specific Quantity – Enter the number of each item you want to order. If you specified more than one item in the Item code window, separate the quantities by a comma. Make sure and specify the same number of “quantities” as you have items.

  • A specific database – The default database to select from is products. You can select items from other databases that have been registered as ProductFiles in the catalog.cfg file. If you don’t know what that means, contact your Interchange Developer.

  • Separate Line – 999 The Interchange documentation on this describes it best: “Changes the default when ordering an item via Interchange to allowing multiple lines on the order form for each item. The default, No, puts all orders with the same part number on the same line. Setting SeparateItems to Yes allows the item attributes to be easily set for different instances of the same part number, allowing easy setting of things such as size or color.”

  • Group Items – Advanced function – When creating a buy link, in some cases you may have a parent-child relationship for some items, if this is selected then when the parent item is removed from the shopping cart, all dependant children will be removed as well. For more info contact your Interchange Developer.

  • Affiliate code – Appends the proper code to associate the ordering of this item with an affiliate. If you wish to also associate the proper campaign see more on Affiliates here.

  • Action – Click on this button to build your button or link.

You can now cut and paste this code (located in the Resulting Button text area) into the location of your choice and your search or button is formatted and ready to go. *Remember to use the link within the <a href=””> tag. Also you can format the button to be more aesthetically appealing by adding HTML .

10.1.4c – Misc – Misc Functions – ITL Helpers – Test Code

The Test Code area should be somewhat self-explanatory. You either type or paste the Interchange Tag Language code you would like to test into the window, and click on Run. There is a drop down window at the bottom of the page, in which the selections are Source or HTML. The Source selection will reveal what you would see if you did a view source on the web page, and the HTML will display how you would see the code if it were viewed simply from the browser.

 

 

10.1.5 – Misc – Misc Functions – Encryption

10.1.5a – Misc – Misc Functions – Encryption – Add GPG Key

The Encryption – Add GPG Key link in the Miscellaneous - Miscellaneous Functions tab is really a link to the GPG Key Add tab in the Administration Commerce tab. In order to use this area you need to have GPG or PGP set up on the server that Interchange is running on. Once you have GPG or PGP set up on the server, you can select which public key you would like to use when encrypting payment information.

  • PGP/GPG key selection - If you have GPG set up, and an active Key Ring owned by the Interchange user, the available keys would be displayed in this drop down window. It will either display the Key ID, or the email address associated with the key. In the example above, both a Name and an email address are displayed.

  • PGP/GPG Upload file – If you have a Public key on your computer, usually stored as a simple .asc file, you can use the Browse button here and select it for upload.

  • PGP/GPG Public Key – By far the easiest if you have the proper GPG or PGP program on your desktop, is to simply drag and drop the selected key into this area. In the example, that is exactly what has just taken place. We clicked on the Greg Hanson key, and dragged it to the GPG/PGP Public key window and dropped it there. We then clicked on the Import GPG/PGP key and the key was installed.

If any of the functions above do not work, you will need to contact your Interchange developer for assistance.

 

10.1.5b – Misc – Misc Functions – Encryption – Encryption Preferences

This link will take you to the following window:

Neither of the variables above need to be set with the newer versions of Interchange. If you used the Add GPG key function that we just described, you will not need to change these settings. These are primarily here for backwards compatibility.

  • Encryptor – This is the command to be used to encrypt data on your system, again this should normally be blank if you use GPG and you have one or more key files in your Interchange users directory. For older systems, a command line similar to: /usr/local/bin/pgp -feat sales@company.com The old entries will work, but you do not need them any longer.

  • PGP Key – You can use this to select a key to use for encrypting your data. If you have not already selected the key in the add GPG key function, the format for this entry is something like

  • joe@shcmo.com You can normally use the email address associated with the key, or you can use the

  • Key Id which will look something like this: 0x692DD04A

 

10.1.6 – Misc – Misc Functions – Upgrade Helpers

10.1.6 – Misc – Misc Functions – Upgrade Helpers – Merge metadata

If you have upgraded or moved an older catalog to a newer Interchange server, this utility will bring your existing catalog metadata into the current mv_metadata table. If you have an older catalog, you may have metadata that is crucial to the operation of your catalog, and you may not want Interchange to blow away that data in an upgrade. So you have the choice of whether to keep the metadata or update. The screen below shows a sample of an Merge Screen and the choices for the various updates. This will of course be different than yours, but it shows what types of things will be displayed, and the choices associated with each.

In the screen above, you see first a list of what needs to be merged, what has been merged, and so on. You also see a dropdown window with the “Defer decision” value displayed. There are 3 options in this window that bear discussion and they are

  • Defer decision – Fence sitter! This will just do nothing!

  • Merge – This will bring the new data in over the old. Only use this choice if you are certain that removing the old meta will not affect your catalog. This may be a good time to call your Interchange Developer!

  • Keep old forever – This choice allows you to keep your existing values, and like the national “Do not Call” list, you will not be bothered again with it. The next meta update will ignore any fields that have been set with this option.

 

 

 

 

Previous

INDEX
A Perusion Help Document
Page XXX

Next