Site Configuration

Some hints for using the Site Config screen.

Throughout these Help pages we refer to Site Config and sometimes give a Variable Name, in capitals, e.g. INVOICE_DIVERT_SUBSCRIPTION. To review or edit a Config Item, go to Admin Menu → Site Config → Config Items, and use the Variable Name filter (top left) by typing or pasting in all or part of the variable name. If you can’t edit it, that means it is restricted and you need to ask for help. The edit field is at the bottom of the screen, below descriptions, access levels etc. The edit field might be a text field, a rich text editor, a date or just a checkbox, depending on the type of configuration item you are editing.

Sometimes the browser loads a config item to display or use it. In that situation the Role Read field determines the Role that can read the item. For example you can control who can read a Custom Page. Common values for Role Read are “PUBLIC” or “BOOKINGS_MAKE” (without the quotes).

• PUBLIC is a special role which allows access without a login. This is preset on many config items for clubs that allow public bookings (bookings without a login), and for other items that are shown without a login.
• BOOKINGS_MAKE is the role that allows a user to make a booking and is usually set to Public or Member access level. In an emergency you can set this role to Administrator level to prevent bookings, but you should email your members with an explanation, because when they try to book, they will see “Your access level cannot book” as the only explanation. More specific roles are used in other situations.
• If you allow public bookings, and you want to restrict certain items to member/admin login only, you can create a role, e.g. MEMBER_ACCESS and give it “member” access level. If you don’t allow public bookings, you don’t need to create this role, just use BOOKINGS_MAKE.
• Most Config Items don’t have anything in the Role Read field. This doesn’t stop them working, it just prevents direct access to the role via a web browser. The back-end code uses these config items for their intended purpose, e.g. creating an email from a template, or controlling a rule etc.

To find all email formats, filter the Variable Name on HTML. This finds email templates, Custom Pages and a few other rich-text items. You can best look for a specific email format by pasting a phrase from an actual email into the “Value” filter. For more general email settings, filter Variable Name on “email” (without the quotes).

Some Config items apply to each individual lodge (this only applies to multi-lodge clubs). You will see an entry for each lodge in this case. You can find all such items by chosing “lodge details” in the “group” filter.

Config Items are recursively substituted into each other. Don’t create a circular reference! So an email template can include the value of any other config item by using #VarName#. You put the Variable Name of the item to be included instead of “VarName”. You will see plenty of examples of this in the existing email formats. Config Items are substituted when you send a test email from the Config Items screen.

If you are looking for an item and aren’t sure of it’s name, use the Variable Name filter and try some likely words. Chances are you will find what you are looking for. You can also filter using the “values” filter, which looks inside the value of each configuration item for a match. That’s particularly useful when you are trying to find a specific email template.

What isn’t in the Configuration Item table?

Tariffs aren’t here, nor are season periods, member classes, cancellation credits, optional extras nor room details. Look for all of these elsewhere in your admin menu.

See Also

PayPal Setup
eWay Setup
All about emails