Internal Codes
These are all the internal codes that the system uses to change the way it operates for different groups.
If there is a code listed here that you don't see on your internal codes screen, it is probably an optional one that hasn't been created - there is a Create Link at the bottom. As the name "Internal" implies, you should be somewhat careful setting these - it is possible to get an "Internal Error" from which you can't recover without my help if, for example, you put a string setting into a code that expects a number.
| Code | Meaning |
|---|---|
| ADMIN - one entry required | The admin password for your site. Keep this secret. On login screen, any non-blank phone accompanied by this PIN will grant admin menu access and enable various other features: Admin Menu * Allow Login without a valid phone number (Audit trail will show "Admin"), or use your own number to use your real name. * Allow edits to items that are not 'yours'. * Set Buy-it-Now price on items * Mark items as ABC qty specific lots * Enable access to all pages * Enable 'Move' features - From item page, you can move a single item to another member (lookup their internal code first) * Enable 'Move All' features - From statement page, there are two separate move links - you can move all sales and payments from one member to another, and you can move all donated items from one member to another - use these to help consolidate 'duplicate' members that aren't discovered till after they have been used for a while. * Access to the "Reports", including the catalog spreadsheet download to generate printed catalog from. * Feature to convert bids to sales * Feature to Reset paddle numbers (if they change each year) * Feature to auto-assign numbers to members without paddles. * Access to edit front-page Notices, aka, manage the 'website' folks see. * Access to the 'Marketing' emails, where you can send bulk emails to your membership with various limits. |
| ALLOW_DUPLICATE_BIDS | optional, default "false". When online bidders place bids, they are normally required to out-bid existing bids by at least $1 in order to prevent ties. If you set this true, the earliest bidder has the advantage, but later bids may win at the same price. |
| AREA_CODE | required, default 614. If you have a simple 10 digit phone pattern, this needs to be 999. When using a pattern that allows either long or short formats, this is the default area code to be assumed when the short expression is used, which also means it is not allowed for the long format. (The error message will use this when an invalid pattern is entered). |
| BID_INCREMENT_RULE | One entry, optional. See above. Format is: {UpTo,Increment},...,finalIncrement for example, 10,1,2 would mean for bids below 10, increase is by one, then by 2 after that. Default if not supplied is: 10,1,25,2,50,5,100,10,250,20,500,25,50 Another reasonable choice (ignoring the bid amount) might be just 1 |
| BID_MESSAGE | optional, default: Check the catalog frequently to ensure you have not been outbid by others. Potential winning bids will be pre-printed on the bid sheet for this item. This message appears on the Place Bid screen. |
| BUY_IT_NOW | optional, default "false". When enabled, the item screen will have a new optional buy-it-now price visible only to admin/volunteer roles. The main catalog view will show a column for the buy-it-now amount when enabled. If a user bids for an amount over that price, the bid will be immediately converted to a sale and they will see a new thank-you page with a link to their statement. |
| BUY_IT_NOW_ITEM_MSG FIXED_ITEM_MSG ITEM_MSG |
If you have set any of these messages, they will appear below every item description in the online catalog, but not on bid sheets. Typically you would begin with if you want the message on the following line - you can use any HTML with the message. ONLY ONE of these will print per item, starting with the first one if has been set and it applies, then the 2nd and so on. If you set an ITEM_MSG it will appear on all items that don't show one of the other item messages. |
| BUY_IT_NOW_NAME | optional, default "Buy it Now". If you prefer to call this feature something like "Win it Now" you can use this setting to do that. |
| COLLECT_ITEM_MSG | optional, default "Collect Item At Auction". This message appears on statements next to items marked as 'physical' items. |
| DONATION_LEGAL_MSG | optional, default: (blank) This message appears just above donated items on member statements. You can use it for a legal blurb about no value being received for the donation, or any other info related to donations (we reserve the right to adjust prices, no you aren't getting it back if it doesn't sell, ...etc.) You can use HTML in this setting (bold/italic/ ...etc). |
| DUPLICATE_EMAIL_DAYS | optional, default "30". When sending bulk emails, you may run into a problem (for example, a limit on the number of emails you can send within a given time) part-way thru a long list. In order to make the process repeatable without sending duplicates, member notes will get entries indicating when emails were sent using the bulk email system. These notes will be of the form: Email 123 sent 9/4/14 21:04. Later, if you try to re-send the same email to everyone, it will skip the ones it already sent and only send to the remaining members. However, if you want to re-use the same email year after year, it will consider it OK to re-send if the date is more than this number of days old. You can still use the batch job start and limit, but this gives you another approach to just keep sending each day/hour/whatever time limit till it says there are no more to send. This limit is ignored if you are sending to a single member (to allow you to send several test emails to yourself to test before sending to the entire list). The new feature to add to the member notes whenever a bulk email is sent can be turned off by setting this to "0". |
| EMAIL_REMINDER_BCC | optional, default "". Send a blind copy of all email reminders to this email. You can use a single email address, or a comma separated list of emails. |
| EMAIL_REMINDER_DAYS | optional, default "5". This means event reminder emails will be sent 5 days before dated events at 9am EST. You can change this to 7, or make it a comma separated list of days to send reminders more than once (for example, 14,7). |
| EMAIL_SEND_PROBLEM | If an automated email failed to send, this will have an error message to help diagnose the problem. If this message contains "AUTH", further sending will be disabled (because AuthenticationError is the most common setup issue). After correcting the problem (see MAIL_PASSWORD below) you must also remove this setting to re-enable email. |
| EMAIL_SETUP_PROBLEM | Same as above, but error in establishing session before trying to send mail. |
| FIXED_BUY_NOW | optional, default: false. Set this true to immediately convert a fixed price bid to a sale - the user will see the same message as if they had done the buy-it-now. The qty remaining will adjust accordingly. |
| FIXED_HOLDBACK | optional, default: 0.0. This is a ratio of how much qty of fixed price items to 'hold back' from online bidders. The bid button will not appear if the available qty falls below the initial qty * this ratio, rounded down. A common value might be 0.5 to hold back half the fixed price items so that the online bidders can't snap them all up. So if you set it for 0.4, that means there must be more than 40% of the original qty remaining in order for the bid button to appear. |
| FOOTER | required - Text appears at the bottom of every page. Usually shows auction email info and/or contact person's name and phone. |
| HIDE_BIDDING | optional, default "true" (This means online bidding is DISABLED BY DEFAULT UNLESS YOU TURN IT ON) Note you also must be signed on to see the bidding info - that is because it needs to know who you are in order to show either "You" or "Others" for the bidder name, in order to keep bidding info anonymous until the bid sheets are printed and revealed at the event. |
| HIDE_HOWMANY | optional, default "false". Bid sheets normally show a "How Many" column when the qty offered is more than one (seat). If this is "true", that column will never appear. Typically use with a BID_MESSAGE (see below) explaining to use one name per line. |
| HIDE_QTY | optional, default "false". Hides qty from catalog and new catalog views. |
| HIDE_REMAIN | optional, default false. Also controls the Left (aka Qty Remain) column, but just a simple on/off switch unrelated to days till auction. |
| HIDE_SOLD | optional default "false". Makes Catalog list and grid only show remaining unsold items. Changes "Unsold Items" into "Sold Items" (which is the ONLY way to view such items since all other filters will hide them). This is most useful for multi-day online bidding auctions to automatically hide sold items from bidders. |
| HIDE_VALUE | optional, default "false". If "true", the EstValue column and data entry field will be hidden on catalog and item entry form. This also hides the amount paid above estimated value from member statements below the price paid for each item. |
| LATE_MSG | optional - Any message you want to appear if an item is donated after the deadline. |
| LATE_MSG_DAYS | relative to the event, how many days prior you can make a donation without the above message appearing on the thank you page. |
| LOGIN_INFO | optional - Any message you want to appear on the login page can go here. |
| MAIL_FROM | the email address used for the "ContactUs" link, and as the "From" address on system generated emails. |
| MAX_DESCRIPTION | optional default 0. Character limit to prevent overly verbose item descriptions. Suggested values from 400-800. |
| MAX_DESCRIPTION_{prefix} | optional, default 0. Override the above 'Any category' value with a category specific max length (not the category full name), for example, vacations. 0 means no limit. |
| MIN_BID_PHYSICAL | optional, default 0. Reject 'physical' items with min_bid below this value. (see setup category page and item donation page for Physical checkbox - aka 'take it home tonight') |
| MIN_BID_SERVICES | optional, default 0. Reject non-'physical' items with min_bid below this value. A red message will appear on item entry form when lower values are entered, prevent saving of the item. When either an item's category is first set (or changed), or if the Tangible "Winner takes it home auction night" checkbox is changed, the "(Reserve price)" next to the min bid will change to indicate the corresponding required minimum, for example "(Reserve price, $10 min)". To avoid confusion on blank forms, the text will not include the minimum when any item form is printed. |
| NOINDEX | optional, default "false". If "true", suppresses Google index of your online catalog. If you are concerned with privacy, turn this on; if you like being able to google someone's name and have the auction catalog included in search results, leave it absent or false. |
| PADDLE | optional, default "Paddle". If you have a different term you use (Bidder, or Ticket for example) you can change the column title to your terminology here. This is the number that identifies members who are eligible to bid and/or buy items. |
| PAYMENT_TYPE | Multiple entries possible. Typically Cash/Check/Credit but if you never use Credit, for example, you could remove that one - or if you want to have a choice for GiftCert, for example, you could add that. |
| PAYPAL_EMAIL | optional. This will enable a pay with paypal row on each statement with a balance due. You should mention (using STATEMENT_INFO described above) that payments may take time to process. |
| PERCENT | optional, default 1. Enter an integer percentage to add. (Typically 1-3). The mouse hover over the link will show the amount that will be charged if you click it. |
| PERCENT_ITEM | optional. Enter the item number (with prefix) of an item in the current auction year you have created for percentage fees. Designed to be used for credit card surcharges. This will enable a link near the Add Sale link on the statement to add a percentage of the amount due. It will also make a new row print on statements with balances due showing what the balance due would be including credit card surchage. Non-admin users can add or remove the percent surcharge on their statements. The percentage is computed only on sales totals that haven't already been paid with non-credit payment types, then reduced by any such item previously added. (Delete the current one and re-add to 'combine' the different amounts if more sales were added.) The "($xx.xx over est. value)" that might otherwise display is suppressed for this item. |
| PHONE_EXAMPLE | For the phone number error message, an example template using the format you require. (Parenthesis around area code, dash, …etc). Should be consistent with following 2 settings - I will set this. |
| PHONE_PATTERN | required. A "regular expression" for validating phone numbers. I will set this for you when I initially import your member data based on the format I see or if you request. Needs to match the initial input data for member phones. |
| POST_BID_DAYS | optional, default 0. How many days after the day before the event, to keep online bidding active. Note: This is a bit misleading since 0 means stop bidding 2 day prior, 1 to include the day before, 2 to include auction day, ...etc. |
| PRE_SALE_DAYS | optional, default 0. Controls whether the catalog shows the qty_remain ("Left") column, before the auction event. Set this to a non-zero value if you pre-sell items before the event and wish to convey what qty remain available for bidding. |
| PREPRINT_BID_CATEGORY | Multiple entries possible. Controls which category name(s) will use a variation of the bid sheet in which amounts are pre-printed (according to bid increment rule) with columns across the top for seats. Often used for Dinners. (Fixed price items in these categories will use the normal format). |
| PREPRINT_BID_MAX_SEATS | optional, default 6. No more than this number of columns will print on the bid sheets with pre-printed amounts. |
| PREVENT_{prefix}_BIDS | optional, default "false". You can prevent bids on any category using a setting named like this using the category prefix. |
| PREVENT_BIDS | optional, default "false". You can prevent users from making their own bids if, for example, you already have a web and/or paper or email system for them to submit bids to you - you can enter bids on their behalf manually using the Advance Bidding Form. Note that buy-it-now is not available from the bid admin page. |
| PREVENT_HIDDEN_MAX_BIDS | optional, default "false". You can disable the Hidden Max feature by setting this true. On the admin bids display, you will see each bid's hidden max is equal to the 'price' of bids made when this setting is true. |
| PREVENT_LIVE_BIDS | options, default "false". Advance bids on live items have so far never won and caused some confusion so you can just prevent them if you want. |
| PREVENT_NEW_ITEMS | optional, default "false". If you want to be in control of item creation, this will hide the "Donate a new Item" link on the statement page unless you are a volunteer or admin. It also hides the big Donate button on the front page (already hidden for admins since they use check-in instead). You may want to consider setting this true after you have started a long-running auction. |
| QUESTION1 | optional, no default. (Up to 5 identical settings can be made to enable custom item questions. This first setting defines what the question is - for example, Vegan Friendly, Wants unsold item back, Jury Accepted..etc. Just about anything you want to keep track of. If any questions have been defined, you will see the question search buttons appear on the left panel below the category links. |
| QUESTION1_DEFAULT | optional, default Both. Can be either Yes, No, or Both. This is the initial filter for the question on the Catalog. Users can change the filter by clicking one of the other buttons. |
| QUESTION1_HIDDEN | optional, default false. If true, the user cannot change the default filter selection, and the question will only appear on the item edit screen for admin or volunteer users. So this is good for 'administrative' things you want to keep track of but not make public. |
| SHOW_BIDDER_NAMES | optional, default "false". The bidding grid will show "You" for your bids, and "Others" for other people's bids unless this setting is true, in which case the other bidder's names will be visible for all to see. |
| SHOW_LOOSING_BIDS_ON_STATEMENTS | optional, default "false". When you make this true, popular events will display on the donor's statement with an additional list of other non-winning bidders. This can be used as a helpful list of alternates for last minute cancellations. This requires you to either be using advance bidding (where it is most useful), or else you would have to go in afterwards and manually enter loosing bids from the bid sheets after sale entry. (And if member already have printed statements, they might not have the alternates, so it's really just for those who know how to sign in and see their statement online) |
| SORT_DEFAULT | optional, default "NEWEST". When categories are chosen, items appear in numeric order, but when the catalog is first shown this option controls which items appear first. NEWEST - The date the item was first added. VALUE - The est. price * qty offered (total expected potential earned). For ties, the next criteria is the item's number within the category. |
| STATEMENT_INFO | optional - Any message (tax info...etc) you want to appear on the statement can go here. Also, it isn't really an internal code, but see the CatalogEdit screen for a similar info message that you can have on the bid sheets - it can vary by category and also for each category there is a fixed price and normal version. |
| SUGGEST_BUY_IT_NOW | optional, default "true". When you print bid sheets with buy it now qty remaining, it will print that many lines at the top with the buy it now price. The idea is that someone can just write their paddle number and name on that top line and the cross out the rest of the sheet. (For buy it now items with many qty available, it will stop at 5 lines or you can change that with SUGGEST_BUY_IT_NOW_MAX). |
| SUGGEST_NEXT_BID | optional, default "true". When you print bid sheets with pre-printed bids, it will print another blank line (similar to the blank line that shows minimum bid when there are no advance bids). If you set this to false, the lines below the advance bids will be entirely blank (no pre-printed amount) - it's up to your wordsmith skills in the category bid sheet messages to get the crowd to figure out how to bump bids that may or may not include duplicates... |
| TANGIBLE_MSG | optional - default "Winner takes it home auction night?" - The label next to the "Tangible" (aka physical item) checkbox on the item entry/edit screen. For online auctions, you may want slightly different wording here. |
| TITHELY_ID | optional. This will enable a pay with Tithe.ly row on each statement with a balance due. You may enable both options. |
| TITLE | required - When users minimize your website window, this is the system tab name and title shown in the web browser window. Usually your organization's name. |
| VOLUNTEER | one entry required - The volunteer password for your site. Share this with your workers/volunteers/online catalog proofreader assistants. * Allow Login without a valid phone number (Audit trail will show "Volunteer"), or use your own number to use your real name. * Allow edits to items that are not 'yours'. * Enable access to CheckIn, CheckOut, and Sales entry pages |
| ZOOM_LEVEL | optional, default "Grid". on the "New Catalog" page, the default view, either "Grid" or "zoom". |