ats online marketplace user’s guide marketplace... · 2020. 10. 22. · use the imis desktop...

ATS Online Marketplace

User’s Guide VERSION: 2020.43.11250

P a g e | 1

Association Technology Solutions 4704 Harlan Street, Suite 325 Denver, CO 80212

(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE OF CONTENTS

Introduction ....................................................................................................................................................................... 7

Online Marketplace Management Customer Records .................................................................................................. 8

Store Manager ........................................................................................................... 8

Anonymous Record ..................................................................................................... 9

General Lookup/Validation Tables ................................................................................................................................ 10

Table: Access_Keywords .............................................................................................. 11

Table: ATS_Image_Handler_Whitelist ............................................................................... 14

Table: Batch_Settings ................................................................................................. 15

Table: Coupon_Categories ............................................................................................ 19

Table: Coupon_Status ................................................................................................. 19

Table: Coupon_Type ................................................................................................... 20

Table: Dues_Rollup .................................................................................................... 21

Table: Passkey_Events ................................................................................................ 23

Table: Passkey_Settings ............................................................................................... 25

Tables: Store_Admin_Payment_Options ............................................................................ 26

Table: Store_Best_Seller_Exclude .................................................................................... 27

Table: Store_Donation_VOLProductCodes .......................................................................... 28

Table: Store_Dues_Categories_Addl ................................................................................. 29

Table: Store_Dues_Category_Descriptn (sic)...................................................................... 30

Table: Store_Dues_Category_Sort_Order ........................................................................... 31

Table: Store_Dues_Product_Prereq ................................................................................. 32

Store_Dues_Kits ........................................................................................................ 33

Tables: Electronic Documents ........................................................................................ 36

Table: Store_Event_Categories_Addl ................................................................................ 47

Table: Store_Event_Function_Prefixes .............................................................................. 29

Table: Store_Event_Function_Prereq ................................................................................ 29

Table: Store_Event_Function_Resources ........................................................................... 29

Table: Store_Event_Guest_Badge_Fields ........................................................................... 30

Table: Store_Event_Meeting_Resources ............................................................................ 30

Table: Store_Event_Reg_Authorization ............................................................................. 31

Table: Event_Reg_Sp – iMIS 10.x Only ............................................................................. 35

P a g e | 2


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Event_Timezone_Override ........................................................................... 35

Table: Store_Featured_Events ....................................................................................... 36

Table: Store_Fundraising_Appeals ................................................................................... 37

Table: Store_Fundraising_Mappings ................................................................................. 38

Table: Store_Fundraising_Options ................................................................................... 39

Table: Store_Kit_Events ............................................................................................... 40

Table: Store_Long_Titles .............................................................................................. 41

Table: Store_Member_Type_Description .......................................................................... 42

Table: Store_Member_Type_Sort_Order ............................................................................ 43

Table: Store_Product_Categories .................................................................................... 44

Table: Store_Product_Categories_Addl.............................................................................. 46

Table: Store_Product_Purchase_Filters ............................................................................. 46

Table: Store_Product_SP_Pricing .................................................................................... 47

Table: Store_Receipt_Subject_Lines ................................................................................ 48

Table: Store_Registration_Validation ................................................................................ 50

Table: Store_Search_Keyword_Exclude ............................................................................. 53

Table: Store_Settings .................................................................................................. 54

Table: Store_Shipping_Methods .................................................................................... 103

Table: Store_Specials ................................................................................................ 104

Table: Store_Specials_Events ...................................................................................... 105

Table: Store_Tax_Auth .............................................................................................. 106

Table: Store_Unbilled_Dues ....................................................................................... 107

Table: Store_Warehouses .......................................................................................... 108

Tables: Cross-sell, Substitute, Up-sell ............................................................................ 109

User-defined Windows – Field Overview ................................................................................................................... 111

ATS_Checkout_Windows Tab ....................................................................................... 112

ATS_Dues Tab ........................................................................................................ 115

ATS_Payment_Options .............................................................................................. 122

ATS_Shopping_Cart Tab ............................................................................................ 124

Coupon Tab ........................................................................................................... 125

Product Review Tab .................................................................................................. 138

Product Review Comment Tab ..................................................................................... 140

P a g e | 3


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Activity Setup ................................................................................................................................................................ 141

SHIPPING ............................................................................................................ 149

Setup in AR/Cash .......................................................................................................................................................... 151

Credit Card Types .................................................................................................... 151

Batch Control ......................................................................................................... 152

Terms .................................................................................................................. 152

Payment Type Labels ................................................................................................ 152

PayPal Express Setup ................................................................................................ 154

PayPal TeleCheck Setup ............................................................................................. 158

Staff Only Payment Options ........................................................................................ 159

Blue Pay Payment Gateway ........................................................................................ 162

Setup in Orders ............................................................................................................................................................. 163

Where Product Information Displays .............................................................................. 163

Freight by Weight - United States Shipping Setup ............................................................... 164

Multi-Warehousing ................................................................................................... 165

Shipping Tracking .................................................................................................... 165

Stored-Procedure Pricing for Products ............................................................................. 165

Purchase Orders ...................................................................................................... 167

PDF Watermarking & Security ...................................................................................... 168

Newest Items ......................................................................................................... 170

Web Categories ...................................................................................................... 171

How Products are Displayed ........................................................................................ 174

Order Processing in iMIS ............................................................................................ 174

Real-time United States Postal Service Freight Pricing (Add-on Module) ............................................................ 175

Setup the Shipping General Lookup Tables ....................................................................... 176

Setup in Events ............................................................................................................................................................. 179

Event Functions ...................................................................................................... 179

REG_ Functions .......................................................................................................................................................... 179

Event Question Manager ............................................................................................ 188

Event Description Display ........................................................................................... 190

Event Image Display ................................................................................................. 190

Event Resource Web Display ....................................................................................... 190

Displaying Speaker Information .................................................................................... 199

P a g e | 4


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Guest Functions ...................................................................................................... 203

Guest Badges ......................................................................................................... 204

Register Someone Else Functionality .............................................................................. 206

Bulk Registration ..................................................................................................... 209

Edit Registration ...................................................................................................... 210

Other Information – Event Setup .................................................................................. 212

Schedule of Events Listing .......................................................................................... 212

Event Registrant Class Determination in iMIS 15 ................................................................ 214

Event Stored Procedure Pricing .................................................................................... 215

Add to Calendar Functionality ...................................................................................... 217

Confirmation Letter System ......................................................................................... 218

Setup in Dues ................................................................................................................................................................ 227

Join ..................................................................................................................... 228

Renewal ............................................................................................................... 230

Chapters ............................................................................................................... 231

Company Dues/Pay Someone Else’ Dues ......................................................................... 232

Subscriptions .......................................................................................................... 235

Non-eligible ........................................................................................................... 237

Settings ................................................................................................................ 238

Cart Behavior ......................................................................................................... 241

Renewal Logic ........................................................................................................ 241

Dues Wizard Header ................................................................................................. 242

Dues Product Sorting ................................................................................................ 243

Long Titles for Member Type and Category ...................................................................... 243

Pre-select Member Type and/or Category When Starting Dues.aspx ......................................... 244

Dues Product Prerequisites ......................................................................................... 244

Exclude VOL items from Dues Coupons ........................................................................... 246

Blank Category ....................................................................................................... 246

Join/Renew and Pay Later ......................................................................................... 248

List Billing ............................................................................................................. 250

Dues Product Grouping, Sorting, and Filtering .................................................................. 252

enSYNC Online AutoDraft ........................................................................................... 259

Donations ....................................................................................................................................................................... 268

P a g e | 5


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

VOL Dues Product Setup ............................................................................................ 269

Fund Raising Product Setup ........................................................................................ 270

Donation Page ........................................................................................................ 271

Online Marketplace Behavior ...................................................................................................................................... 272

Store Banner .......................................................................................................... 272

Responsive Design ................................................................................................... 273

Add to Cart Modal Window ......................................................................................... 273

Checkout, Receipt, and Welcome Messages ..................................................................... 273

One-Click Checkout .................................................................................................. 278

Use Parent Company Pricing ........................................................................................ 278

Staff Processing: Impersonation/On Behalf Of.................................................................. 279

Staff Email Notifications and Error Reporting ..................................................................... 281

Your Price ............................................................................................................. 284

Personal Coupons .................................................................................................... 286

Searching in the Online Marketplace ......................................................................................................................... 289

Searching Products in the Marketplace ............................................................................ 289

Searching Events in the Marketplace .............................................................................. 289

Search Results Display Control ..................................................................................... 289

Tag Cloud ............................................................................................................. 290

Auto-Searching ....................................................................................................... 293

How Images Work ........................................................................................................................................................ 294

Immediate Add to cart ................................................................................................................................................. 294

Source Codes ................................................................................................................................................................. 296

Google Analytics eCommerce Tags ............................................................................................................................ 297

Testing your Marketplace Setup ................................................................................................................................. 299

Things to know about iMIS Web transactions .......................................................................................................... 299

Credit Card Processing ................................................................................................................................................. 300

Standard Processing ................................................................................................. 300

Other Factors ......................................................................................................... 301

Troubleshooting ...................................................................................................... 302

Flowchart of Credit Card Process ................................................................................... 302

iMIS User Security Levels ............................................................................................................................................ 304

P a g e | 6


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

iMIS 15 & 20 .......................................................................................................... 304

iMIS 10 ................................................................................................................ 306

Modules ................................................................................................................ 307

User-Defined Tables ..................................................................................................................................................... 308

User-defined table names ........................................................................................... 308

User Defined Table: ATS_Checkout_Windows ................................................................... 309

User Defined Table: ATS_Dues ..................................................................................... 310

User Defined Table: ATS_Payment_Options ...................................................................... 314

User Defined Table: ATS_Shopping_Cart ......................................................................... 316

User Defined Table: Coupons ....................................................................................... 320

User Defined Table: Product_ReviewComment.................................................................. 322

User Defined Table: Product_Reviews ............................................................................ 323

User-Defined Windows (Tabs) .................................................................................................................................... 324

SQL Server Setup .......................................................................................................................................................... 328

Best Sellers Stored Procedure ...................................................................................... 328

Product Recommendations Stored Procedure .................................................................... 330

SQL Server Jobs ...................................................................................................... 332

SQL Server Tables.................................................................................................... 335

iBO Performance ........................................................................................................................................................... 340

P a g e | 7


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

INTRODUCTION

The ATS Online Marketplace was designed for you to give your organization’s customers an all-in-one online

experience to pay dues, register for events, order products and give donations. The Online Marketplace uses

iMIS setup to process these different types of transactions, so it is important that all aspects of each module

use the iMIS desktop setup. For example, shipping and handling on orders is based on how your freight

settings are set in iMIS. It is important to keep this in mind during your implementation process and testing.

This document is a guide to help you setup the ATS Online Marketplace for iMIS. This manual will cover setting

up the general lookup tables, user-defined tables, user-defined windows, activity types and the custom SQL

Server configuration needed by the web store to run correctly. In addition, there are sections for each module

and tips for optimizing use of the Marketplace via your iMIS setup.

P a g e | 8


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ONLINE MARKETPLACE MANAGEMENT CUSTOMER RECORDS

The Online Marketplace will use a couple of records in your customer database for managing different

processes. You will need to make a note of each of their ID numbers.

Store Manager

This record will be used to manage coupons and dues settings. Many organizations use their MANAGER record

in iMIS for this since it will never be deleted from iMIS and is a Full User account. Make a note of this ID

number; it will be entered as a setting in the Store_Settings general lookup table.

P a g e | 9


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Anonymous Record

This record will be used for calculating nonmember prices in the Marketplace before a customer logs in.

Create a new Customer record as a nonmember and note the ID number. This ID will be entered in the

Store_Settings general lookup table. This record must have an address; if it doesn’t, the Online Marketplace

may not be able to calculate freight and your customers would get an error message. We recommend you use

your organization address on this record. Do not use this ID for any testing or access once setup and set in

the Store_Settings table. Do not link this record to a parent/company record as it could show the ‘Register

Someone Else’ button before someone logs in.

P a g e | 10


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

GENERAL LOOKUP/VALIDATION TABLES

To add a new general lookup table, open iMIS desktop and log in as a manager (or another login with access

to Set Up Tables in Customers). Then, go to Customers>>Set up tables>>General lookup/validation

You will see a drop-down list containing all the general lookup tables being used by iMIS. To add a new table

scroll to the bottom of the drop down list and click the “(New Table)” entry. You will then be asked to enter a

new table type, which is essentially the table name. A list of the table names that we will be adding follows.

Each of the general lookup tables has data associated with it that will also need to be entered manually. To aid

you with this process, screenshots of each lookup table and the data it contains follow. You will see that many

of these tables contain two columns for the data. The first column shows the “Code” data, and the second

column shows the “Description” data. If no second column exists, then only the “Code” data will be entered.

To enter an item into the general lookup table:

1. Click New

2. Fill out both the “Code” and “Description” fields for each field and then click enter (or Save).

3. Once all the data items have been entered into the table be sure to click the save button in the lower

right hand corner to save the changes to the database.

The data required for each table are shown in the screenshots below. Missing data and any additional

information pertinent to the table can be found after each table, when necessary.

By default ATS will install the two required General Lookup tables: Batch_Settings and Store_Settings.

P a g e | 11


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Access_Keywords

This standard iMIS table may already

exist and contain some entries. If the

table doesn’t exist you can create it and

add the following entries:

CODE Description

(values)

What it does

ATSSTOREADMIN Access to Online

Marketplace Admin

Portal

Gives any user with this access keyword access to the

administrative portal for the Online Marketplace. The

administrative portal URL is http://YourURL/store/admin

MNGR Store Manager Used to set restrictions for the Online Marketplace user-defined

tables (i.e. Coupons) and activities (i.e. Promotions).

Users that do not have the ATSSTOREADMIN access keyword set on their user credentials will receive a ‘not

authorized’ message when trying to enter the administrative portal.

P a g e | 12


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ASSIGNING ACCESS KEYWORDS

iMIS Staff Site

1. Community>>Security>>Users

2. Load the All Full and Casual (NonSystem) query to get a full list of staff logins

3. Select staff login

4. Expand the Staff Access section at the bottom of the page add the ATSSTOREADMIN access keyword.

iMIS Desktop

1. Find the record you want to assign

an Access Keyword to in

Customers

2. Then click the User Credentials

button

3. Expand the Staff Access section

4. Click on the Select link next to

Access Keywords

P a g e | 13


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

5. Next check the box to select the

MNGR access keyword, click Ok,

then Save.

P a g e | 14


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: ATS_Image_Handler_Whitelist

Image Whitelisting – Implemented support for image whitelisting to ensure no malicious attacks

can happen through image URL’s. NOTE: Images that do not have an entry in this table

will display as broken links.

This table will contain the prefixes of URL’s for images displayed for products and events in the

Marketplace. For example, if an image URL is set to

https://sandbox.atsol.org/store/images/nophoto.png the entry in the Gen table would be:

▪ Code: 1

▪ Expansion: blank

▪ Description: sandbox.atsol.org

You can whitelist an entire domain (sandbox.atsol.org) or you can restrict it even further to

something like sandbox.atsol.org/images. If it is a relative URL (i.e. /images/nophoto.jpg) then

enter a URL of /images in the general lookup table.

There is an audit report in the administrative portal for products under Products>>Product

Audits and Tasks>>Product Images that can help determine if images have not been whitelisted.

Additionally, if there are entries missing for a product there will be a button to add it to the

general lookup table.

For whitelisting this /images is different than images. The code is very literal. Here is how to

determine what to use. When images are not appearing and returning the 403 error, look at the

error in the event log or from the error email received. That error will show the exact string it is

evaluating. For example: "Image handler refusing to serve non-whitelisted image for

path '/ATSResources/images/image.jpg'. Org: ABC; Server: abc.org; Server IP:

xx.xx.xx.xx; App: store;" would require the entry in the whitelist table to

be /ATSResources/images/and not ATSResources/images/.

https://sandbox.atsol.org/store/images/nophoto.png

P a g e | 15


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Batch_Settings

This table is used to tell the Marketplace how to

create and use batches. The order of logic that the

Online Marketplace uses when creating batches is:

1. Batch Date

a. Batch Early/Late

2. Batch Cash Account

3. Batch Description

4. If registration – Is EventSeparateBatch set to

True

5. Is Operator-Assigned Batch Numbers turned

on in iMIS – that use batch Mask

P a g e | 16


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CODE Description (values) What it does

BATCHCASHACCOUNTAMEX Name of your cash account to be

used in an American Express batch.

(AMEX)

Selects desired cash account for this

type of transaction.

BATCHCASHACCOUNTCASH Name of your cash account to be

used in a cash batch. (Cash)



BATCHCASHACCOUNTCHEC

K

Name of your cash account to be

used in a check batch. (Cash)



BATCHCASHACCOUNTDINE

RS

Name of your cash account to be

used in a Diners Club batch.

(DINERS)



BATCHCASHACCOUNTDISC Name of your cash account to be

used in a Discover batch. (DISC)



BATCHCASHACCOUNTMC Name of your cash account to be

used in a MasterCard batch. (MC)



BATCHCASHACCOUNTPO Name of your cash account to be

used in a Purchase Order batch.

(Visa)



BATCHCASHACCOUNTVISA Name of your cash account to be

used in a Visa batch


type of transaction. NOTE – You may

want your Visa, MC and Discover to use

the same cash account (i.e. VISA) if

that’s how you balance that now.

CARDTYPEAMEX Enter the code you use for

American Express in iMIS (AMEX)

Determines what code will be entered

as the payment type for American

Express.

CARDTYPEDINERS Enter the code you use for Diners

Club in iMIS (DINERS)


as the payment type for Diners Club.

CARDTYPEDISC Enter the code you use for

Discover in iMIS (DISC)


as the payment type for Discover.

CARDTYPEMC Enter the code you use for

MasterCard in iMIS (MC)


as the payment type for MasterCard.

CARDTYPEVISA Enter the code you use for Visa in

iMIS (VISA)


as the payment type for Visa.

CASHACCOUNTAMEX Name of your Cash Account for

American Express

Code for Cash Account must contain

AMEX.

CASHACCOUNTCASH Name of your Cash Account for

Cash

CASHACCOUNTCHECK Name of your Cash Account for

Checks

This is for saving check payments in

iMIS. It cannot be used for ACH

processing as you cannot mark it as a

“credit card” type of cash account.

P a g e | 17


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


CASHACCOUNTCHECKPROC

ESSOR

Name of your Cash Account for

CHECK Processing (ACH)

This cash account needs to be a “credit

card” type to allow you to process ACH

transactions through iMIS.

CASHACCOUNTDEFAULT Name of your Default Cash Account This must be a cash Cash Account

CASHACCOUNTDINERS Name of your Cash Account for

Diners Club


DINERS.

CASHACCOUNTDISC Name of your Cash Account for

Discover


DISC.

CASHACCOUNTMC Name of your Cash Account for

MasterCard


MC.

CASHACCOUNTPO Name of your Cash Account for

Purchase Orders

CASHACCOUNTVISA Name of your Cash Account for

Visa


VISA.

DUESDESCRIPTION Description for Dues Batches

(DUES)

Determines what the description of

dues batches will be.

DUESMASK Date mask for dues batch –

suggested is YYMMDD

Valid masks are:

• YYMMDD

• MMDDYY

• MMDD

When using operator-assigned batches

in iMIS this is the mask that is used to

create the name of the batch.

EVENTSDESCRIPTION Description for Event Batches

(EVENT)


event batches will be.

EVENTSMASK Date mask for event batch –

suggested is YYMMDD

Valid masks are:

• YYMMDD

• MMDDYY

• MMDD




EVENTSEPARATEBATCH True/False True – Event registrations will be kept

in a separate batch for each event.

False – Registrations will be kept in

one events batch.

FUNDRAISINGDESCRIPTIO

N

Description for Donation Batches

(EVENT)


donation batches will be.

FUNDRAISINGMASK Date mask for donation batch –

suggested is YYMMDD

Valid masks are:

• YYMMDD




P a g e | 18


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


• MMDDYY

• MMDD

ORDERSDESCRIPTION Description for Order Batches

(EVENT)


order batches will be.

ORDERSMASK Date mask for order batch –

suggested is YYMMDD

Valid masks are:

• YYMMDD

• MMDDYY

• MMDD




PAYFLOWPROTIMEZONEOF

FSET

Defines the number of hours

before or after midnight you want

the transactions to cutover to the

next day or stay behind a day to

coordinate with your settlement

times with PayPal. Valid values can

be positive or negative. For no

offset use 0:00.

For example, -3:00 meaning that at

9:00 pm of the local server it will cut

over.

The value should be in the format of

HH:MM.

ROLLDESCRIPTIONAFTER Label for batch descriptions based

on PayPal rollover time

(LATE)

This will help you determine if the

transaction was entered before the

rollover time or after.

ROLLDESCRIPTIONBEFORE Label for batch descriptions based

on PayPal rollover time

(EARLY)

This will help you determine if the

transaction was entered before the

rollover time or after.

ROLLOVERTIME Time of day on your server that

batches will switch from early to

late. For no rollover use 23:59.

The value should be in the format of

HH:MM.

P a g e | 19


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Coupon_Categories

This table contains a list of item types that a coupon may be applied to.

Available coupon categories include:

• Dues – Use for applying a coupon to dues products

• Events – Use for applying a coupon to event functions

• Freight – Use for applying a coupon to freight charges only

• Handling – Use for applying a coupon to handling fees

• Orders – Use for applying a coupon to order products

• Shipping – Use for applying a coupon to freight and handling fees

• Sub – Use for applying a coupon to subscription products only

• Coupon categories can be combined to create multi-category coupons. Do not add SHIPPING in

conjunction with FREIGHT and/or HANDLING coupons.

Table: Coupon_Status

This table lists the valid status

types for a coupon.

P a g e | 20


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Coupon_Type

This table lists the discount

types that are available for

coupons.

P a g e | 21


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Dues_Rollup

This table is used to combine multiple dues items into a single dues item to be displayed on the Dues

Summary page, in the shopping cart, and on the receipt. The code field should contain the product code of the

billing product to display in place of the dues items, and the description field should contain a comma

separated list of the dues items that relate to that particular product code. See the Setup in Dues section for

full information about setting dues for the Online Marketplace.

This table will also allow you to use the iMIS wildcard feature. For example, if you want any Chapter product

to be included you would enter CHAPT/*.

Dues Summary Page

P a g e | 22


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Shopping cart showing one product with full amount for all kit items:

Dues receipt showing only one item:

Products paid:

P a g e | 23


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Passkey_Events

This table stores the event codes that will use Passkey functionality.

This lookup table is the link between events in iMIS and “events” in Passkey. After creating this table you

must click the “New” button and add a record for every Passkey event for which your iMIS users can register.

• CODE: The iMIS Event Code (e.g., 2014ANNUAL).

• Description:

o Two Parameters: You will want to use two parameters if everyone that registers through iMIS

will get the same PassKey eventCode. A PassKey event code is a unique ID which identifies an

Attendee Type configured for a specific event in GroupMAX. This unique “sub-block” is often

used to group sets of attendees, for example, General Attendee, VIP, Staff, or Exhibitor.

▪ Example: EVENTID|EVENTCODE (139992|RTEATT0116)

Code Description

iMIS Event Code iMIS Code for Conference or Event

Example: DMAANNUAL

Description Corresponding Passkey Event ID

This consists of either 2 or 3 parameters

EVENTID|EVENTCODE

OR

EVENTID|EVENTCODE|SQLVIEWNAME

* EVENTID This is a unique code for a specific event, for example the Jones Wedding would have a single event ID

* EVENTCODE This is a unique id for the Attendee Type within the Event. This can be used for General Attendees, VI

P, Staff, etc.

* SQLVIEWNAME is the name of a SQL view in your iMIS database that contains information about the eventcode

that each person can register for.

P a g e | 24


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

o Three Parameters: If you wish to specify a different eventCode for different ID numbers then

you will use the three parameter solution.

▪ Example: EVENTID|EVENTCODE|SQLVIEWNAME

(139992|RTEATT0116|vwAnnualPassKey)

▪ In this situation the EVENTID is the event ID while EVENTCODE is the DEFAULT

EventCode for all registrants that are not in the SQLVIEWNAME. The SQLVIEWNAME is

the name of a SQL view in your iMIS database that contains information about the

eventcode that each person can register for. If the person is not in the view, they will

get the default EVENTCODE.

▪ The SQL view must contain the following fields:

• ID - iMIS ID number

• EVENTCODE - PassKey EVENTCODE for this individual

• For example, to create a view of all people who have ever been the president of

a committee, you could create a view like this:

o Create view vwAnnualPassKey as select NAME.ID,'VIP' as EVENTCODE fro

m name, activity where name.id = activity.id and activity.activity_type = '

COMMITTEE' AND ACTION_CODES = 'P'

• If this is used with the three parameter option, then only people who are

included in this view will get the EventCode in the view. All others will get the

default EventCode setup as the second parameter in the pipe-delimited list.

Each ID number should be in the view only once.

P a g e | 25


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Passkey_Settings

This table is used to store the settings for your Passkey account.

Code Description

API_URL URL of the PassKey API provided by PassKey

Testing: https://training-api.passkey.com

Production: https://api.passkey.com

DESTINATION Value must be “02”

MODE Value must be “S”

NOT_AUTHORIZED_URL This is a URL to which a person will be redirected if they have not

registered for the event but visits the PassKeyDirect URL.

Example: https://www.abc.com/PleaseRegisterFirst

OPERATION Must be “CreateBridgeAndRedirectResWeb”

PARTNER_ID This is a unique number assigned by Passkey to each third party organization with a certified RegLink Open API integration and identifies the system to GroupMAX.

PASSWORD Password associated with API Username

USERNAME Username assigned by Passkey that has been granted API access

VERSION Passkey message version (i.e. 4.00.02)

https://training-api.passkey.com/

https://api.passkey.com/

https://www.abc.com/PleaseRegisterFirst

P a g e | 26


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Tables: Store_Admin_Payment_Options

This table is used to identify the cash accounts available for the staff-only payment functionality. Entries in

this table are the cash accounts (case sensitive) that you want available for staff-only payments. See the

Staff Only Payment Options section for more information.

NOTE: Cash accounts listed in this table MUST be Cash cash accounts and not Credit Card cash accounts.

P a g e | 27


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Best_Seller_Exclude

This table is used to exclude items from the best sellers list. If there are any products that you do not want to

show up as a best seller, then enter the product code for that product in “Code” field and add the item to the

table. These are products from the Orders module in iMIS.

P a g e | 28


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Donation_VOLProductCodes

This table is not required and interacts with the donations page only (donation.aspx). Any voluntary (VOL)

dues product listed in this table will display on the donation.aspx page. Products must be set to ‘Accept

Payments on the Web’. Additionally, the Pay Priority field on the product controls the sort order of the

products on the page.

P a g e | 29


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Dues_Categories_Addl

This table is used to create links to your dues/subscription processes. The subscriptions.aspx page must

include the product code as this page is designed to present one specific subscription item for subscribing to.

Example

~/subscription.aspx?id=JOUR would take a customer to the page to subscribe to the JOUR product.

~/dueslistbill.aspx take a customer to the list bill dues page.

P a g e | 30


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Dues_Category_Descriptn (sic)

This table is used to display a long description for billing category (Name.CATEGORY). Code is the code of

the category from the Category general lookup table and the description is the long description you want to

display.

P a g e | 31


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Dues_Category_Sort_Order

This table is used to control the sort order of categories in the dues join/renewal wizard. The code is the

Billing Category code and the Description is a number that designates sort order. Categories without an entry

will be sorted alphabetically.

P a g e | 32


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Dues_Product_Prereq

This table allows you to set a pre-requisite for displaying dues items. The code is the product that has a

prerequisite and the description is a comma-delimited list (no commas) of the product(s) that will allow the

product identified in the code to be displayed in the dues wizard. See the section Dues Product

Prerequisites section in this document for more information about setting up this feature.

P a g e | 33


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Store_Dues_Kits

This table allows you to kit a group of dues products in the dues wizard (dues.aspx). Unlike the Dues_Rollup

table that only combines, or rolls up, products for display on receipts, in the dues summary and in the

shopping cart, this will display the combined products as one product in the dues wizard. The Code in this

table is the dues/subscription product the person will be joining or renewing and the Description will be a

comma-delimited list of the product(s) that will be included in the price. See the Setup in Dues section for full

information about setting up dues for the Online Marketplace.

The end result is that all of the dues/subscription items are added to the person’s record and paid.

Products must be listed as they exist in the Product table.

All dues/subscription products are the product code with the exception of Chapter products that include the product type (CHAPT/DALLAS).

Each item must be selected in the billing cycle in iMIS.

Only kits for join/renew are supported (dues.aspx not subscriptions.aspx).

Nested kits (kits within kits are not currently supported).

Voluntary dues products (VOL) are not allowed in kits.

Kits may not contain products or event functions. They can only contain dues- related items.

P a g e | 34


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE:

Dues renewal process showing main kit item with amounts combined for all products in dues kit:

Billing tab in iMIS after payment:

P a g e | 35


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Payment in iMIS:

P a g e | 36


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Tables: Electronic Documents

This section explains how to setup electronic content including download link text and the number of days a

product is accessible. Event registrations can also include a link for registrants to view event-specific pages.

TABLE: STORE_ETYPES

This table is used to categorize the different types of electronic products to be sold in the web store. The

legacy (prior to April 2013) setup only had one item in this table, with a code of “Electronic Documents” and a

description of “STORE_INTERNAL.” Now, you don’t need to use the STORE_INTERNAL table but can create

your own custom tables. The Code explains the grouping of files and the description contains the name of

another general lookup table that contains the product codes of the electronic products associated with that

particular electronic products category.

TABLE: STORE_ETYPES_CLICK_DESCRIPTION

This table will allow you to control the link description when someone is accessing different types of electronic

content. For example, you may have PDF files that ‘Click to Download’ is the appropriate message but you

might also have links to LMS links where you may want to see ‘Click here to take your course’.

TABLE: STORE_ETYPES_EXPIRATION_DAYS

This table allows you to override the number of days a type of electronic content is available. You can

reference anyof the Store_Etypes general lookup tables or a single product code to set the number of days a

P a g e | 37


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

customer has access to the content before it expires. The system default is in the Store_Settings table called

ConfigVaultExpirationDays. If this table does not exist, that setting will be used for all electronic content. To

set no limit on the number of days enter 0 (zero) in the Description field.

TABLE: STORE_XXXX

The XXXX in the table name will be name of the table(s) that exist in STORE_ETYPES. These tables contain

the product code(s) and URL to each product. When adding items to these tables, be sure to enter the

product code into the Code field and use the securefile.aspx logic as shown to the right in the Description to

ensure the person purchased the product. In the path, the LOC is the location identified in the

ConfigVaultRootPath entry in the STORE_SETTINGS table. Subfolders are allowable and can be appended in

the path above.

The items added to these tables will be unique for each installation, based on which products are considered

electronic, and do not need to match the examples shown.

P a g e | 38


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PRODUCT EXAMPLE

In this example product V101 was purchased and shows the link verbiage and time left to view:

EVENT EXAMPLE

An event code/function code can also be entered into these tables to display a link for event registrants.

You might have a web page with a webcast you want them to view prior to the event or materials to

download. The event functionality does not use the securefile.aspx functionality.

The gen table with the link to the event information needs to include the event code and function code.

For example SIMPLE18/REG_MAIN is used in the example below.

P a g e | 39


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

HTTP/HTTPS

If your links are https you will need to make an edit to the appSetting.config file: <add

key=”RequireSecureSSL” value=”on”/>

P a g e | 40


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ELECTRONIC DOCUMENT TYPES

To have your web server display electronic documents your web server must have the proper MIME Types

setup in IIS. Many are preconfigured by Microsoft but some require the addition of the MIME Type in IIS.

Following are examples of the MIME Type for ePub and Mobi files.

o .epub application/epub+zip

o .mobi application/x-mobipocket-ebook

1. To open IIS in Windows Server 2008R2, click “Start” >> “Administrative Tools” >> “Internet Information

Services (IIS) Manager”

P a g e | 41


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

2. Inside of that window double-click “MIME types”.

3. To add a new MIME type, right-click somewhere in the center pane and click “Add…”. Alternatively you can

click the “Add…” link in the right-hand pane.

4. Enter the file extension and the MIME type in the

appropriate fields and click “OK”.

P a g e | 42


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FILE SIZE CONSIDERATION

IIS has limitations on the file size and depends on your specific server settings. Please review the

screenshot below and set the maximum to be larger than your largest file for download.

SETTING UP READ PERMISSIONS ON A FOLDER OF DOWNLOADABLE DOCUMENTS

Setting the folder in the STORE_SETTINGS general lookup table

The General Lookup Table has an entry in the STORE_SETTINGS called CONFIGVAULTROOTPATH. The

description is the folder location in edocs (e.g., d:\edocs\)

Setting permissions on the folder

Once the folder location is identified you need to give the ATS Online Marketplace permissions to access

that folder. Access to the folder is best given by giving the application pool that runs the ATS Online

Marketplace permission to access the folder.

This step requires you to identify the name of the application pool that where the ATS Online Marketplace is

running. In the example below it is in the application pool called ATS_Store

ApplicationPoolIdentity is actually the best practice to use in IIS7. It is a dynamically created, unprivelaged

account. To add file system security for a particular application pool see IIS.net's "Application Pool

Identities". The quick version:

http://learn.iis.net/page.aspx/624/application-pool-identities/

http://learn.iis.net/page.aspx/624/application-pool-identities/

P a g e | 43


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

If you application pool is named "ATS_Store" (just replace this text below if it is named differently)

1. Open Windows Explorer

2. Select a file or directory.

3. Right click the file and select "Properties"

4. Select the "Security" tab

5. Click the "Edit" and then "Add" button

6. Click the "Locations" button and make sure you select the local machine. (Not the Windows domain if

the server belongs to one.)

7. Enter "IIS AppPool\ATS_Store" in the "Enter the object names to select:" text box. (Don't forget to

change "ATS_Store" here to whatever you named your application pool.)

8. Click the "Check Names" button and click "OK".

9. Click the “Apply” button.

10. Click the “OK” button.

Here are the steps with screen shots.

1. Open Windows Explorer

2. Select a file or directory.

3. Right click the file and select "Properties"

4. Select the "Security" tab

P a g e | 44


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

5. Click the "Edit" and then "Add" button

P a g e | 45


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

6. Click the "Locations" button and make sure you select the local machine. (Not the Windows domain if

the server belongs to one.)

7. Enter "IIS AppPool\ATS_Store" in the "Enter the object names to select:" text box. (Don't forget to

change "ATS_Store" here to whatever you named your application pool.)

8. Click the "Check Names" button and click "OK".

P a g e | 46


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

9. Click the “Apply” button.

10. Click the “OK” button.

P a g e | 47


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Event_Categories_Addl

This table will display the links in the

Events section in the right gutter above

the Products. It can be turned on or off in

the STORE_SETTINGS table and the

header can be changed. The following

STORE_SETTINGS help manage those

settings: LblEventCategories,

ShowCalendarView and

ShowEventCategoriesList.

P a g e | 48


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EVENT LINKS

There are 3 different views you can direct customers to using an event link:

• Brief Listing • Schedule Listing • Calendar Listing

Additionally, any meetings in the CONFIGSEARCHEXCLUDEEVNETCODES or

CONFIGSEARCHEXCLUDEEVENTTYPES settings in the Store_Settings general lookup table will not show. Using

the parameters listed along with the following filters can help you direct people to different lists of events.

Filter Shows

/searchresults.aspx, /calendarschedule.aspx

and /calendar.aspx

All future events

?EventType=WEB (Appended to the desired

page parameter)

All future events with event type of WEB (or the Event

Type you desire); Can be a comma delimited list

?ExcludeEventType=WEB (Appended to the

desired page parameter)

All future events excluding the event type of WEB (or the

Event Type you desire); Can be a comma delimited list

?EventCode=2012ANNUAL (Appended to the

desired page parameter)

The single event called 2012ANNUAL (use your actual

event code). Event codes cannot be longer than 10

characters.

P a g e | 25


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

BRIEF LISTING

The parameter used to direct customers to the Brief Listing is /searchresults.aspx.

The Brief Listing directs people to a brief listing of events with a Details button to go to the event detail page.

The amount of detail displayed on this page is controlled by the following Store_Settings:

• ShowEventCoordinatorsBrief

• ShowEventDatesBrief

• ShowEventDescriptionBrief

• ShowEventNotesBrief

• ShowEventPricingBrief

• ShowEventSpeakersBrief

EXAMPLE: ENTRY IN EVENT_CATEGORIES_ADDL

This setting:

P a g e | 26


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Displays this:

P a g e | 27


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SCHEDULE LISTING

The parameter used to direct customers to the Schedule Listing is /calendarschedule.aspx. The

ShowCalendarScheduleView Store_Setting must be set to true to enable this page.

The Schedule Listing directs people to a grid view of events showing Event Title, City, State, Begin Date and a

includes Details button to go to the event detail page.

EXAMPLE: ENTRY IN EVENT_CATEGORIES ADDL

This setting:

Displays this:

P a g e | 28


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CALENDAR LISTING

The parameter used to direct customers to the Calendar Listing is /calendar.aspx. The ShowCalendarView

Store_Setting must be set to true to enable this page. The Calendar Listing will show events in a calendar

view. In addition, you can click on the calendar item and go to the details about the event or hover over the

calendar item and see a pop up of the brief details of the event. When using calendar.aspx the calendar will

forward to the first occurrence of a meeting. If no meetings match the criteria then the current month/date

will be shown.

EXAMPLE: ENTRY IN EVENT_CATEGORIES_ADDL

This setting:

Displays this:

Style Sheet considerations:

In the calendar view each

event is styled so that a

different style can be applied to each

event type and/or each event. This

means that all webinar events

could have a green background

while all expositions could have a

background of yellow.

P a g e | 29


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Event_Function_Prefixes

This table llows for the use of pre-defined

function prefixes to function like ATS

Function Prefixes. The description is a

comma delimited list of your custom

functions that will have the same

functionality as the one in the CODE.

See the ‘Setup in Events’ section of this

document for an explanation of all ATS

Function Prefixes.

Table: Store_Event_Function_Prereq

This table allows you to designate which

function a person must register for

before they can register for that

function. The Code is the function the

person will see if they are registered for

any of the functions in those listed in the

Description field.

Table: Store_Event_Function_Resources

This is a general lookup table that

includes references to meeting resources

for a function to show meeting resources

and control the order of the resources.

See the ‘Event Resource Web Display’

section for details.

P a g e | 30


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Event_Guest_Badge_Fields

This is a general lookup table that controls what fields are displayed for guest badges and if they can be

edited. See the ‘Guest Badges’ section for details.

Table: Store_Event_Meeting_Resources

This is a general lookup table that

includes references to meeting

resources for the event as a whole. This

will appear at the top of the registration

details page. See the ‘Event Resource

Web Display’ section for details.

P a g e | 31


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Event_Reg_Authorization

This table gives you

the ability to write a

custom SQL view to

select the pool of

records that the

‘Register Someone

Else’ functionality

uses. By default, the

only people someone

can register someone

else for, is people with the same Company ID in iMIS. Your view must contain the ID number of the person

doing the registering and the ID number of the person they can register. You have a few different options:

1. Create an entry with a code of your event code and the name of your view in the Description – this will

be used for only that event.

2. Create an entry with a code of DEFAULT and the name of your view in the Description – this will be the

view used for all events.

3. This feature first looks for an entry of the event code, then it looks for an entry called DEFAULT and if

neither exist it will use the Company ID hierarchy.

EXAMPLE VIEW FOR ANYONE SHARING A COMPANY ID

USE [OnlineMarketplace]

GO

/****** Object: View [dbo].[vwRegisterFromCompany] Script Date: 12/15/2011 10:44:03 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

create view

[dbo].[vwRegisterFromCompany] as

SELECT

NAME.ID,

NAME2.ID AS REGISTRANT

FROM

NAME,

NAME NAME2

WHERE

NAME.STATUS = 'A' AND

NAME.CO_ID = NAME2.CO_ID AND

NAME.CO_ID <> '' AND

NAME2.STATUS = 'A'

P a g e | 32


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

REGISTER SOMEONE ELSE WITHIN A COMPANY TREE

This script will create a view to let anyone within a company tree (up to 5 levels) register anyone at in the

tree:

USE [iMIS20]

GO

/****** Object: View [dbo].[vwTBA_REGISTERSOMEONEELSE] Script Date: 09/12/2014 16:52:02 ******/ SET ANSI_NULLS ON

GO


GO

CREATE VIEW [dbo].[vwTBA_REGISTERSOMEONEELSE] as SELECT

NAME.ID,

EMPLOYEE.ID AS [REGISTRANT] FROM

NAME, NAME EMPLOYEE,

(

-- This select gets the root id up to 5 levels high SELECT NAME.ID, NAME.CO_ID FROM NAME WHERE NAME.CO_ID <> ''

UNION SELECT NAME.ID, NAME2.CO_ID FROM NAME, NAME NAME2 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID

<> '' UNION

SELECT NAME.ID, NAME3.CO_ID FROM NAME, NAME NAME2, NAME NAME3 WHERE NAME.CO_ID = NAME2.ID AND

NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID <> '' UNION

SELECT NAME.ID, NAME4.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID <> ''

UNION

SELECT NAME.ID, NAME5.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4, NAME NAME5 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID =

NAME4.ID AND NAME5.CO_ID <> '' ) ROOT

WHERE

NAME.ID = ROOT.ID AND NAME.COMPANY_RECORD = 0 AND

NAME.STATUS = 'A' AND EMPLOYEE.CO_ID <> '' AND

EMPLOYEE.CO_ID = ROOT.CO_ID

UNION

SELECT NAME.ID,

EMPLOYEE.ID AS [REGISTRANT]

FROM NAME,

NAME NAME2,

P a g e | 33


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

NAME EMPLOYEE,

(



<> '' UNION

SELECT NAME.ID, NAME3.CO_ID FROM NAME, NAME NAME2, NAME NAME3 WHERE NAME.CO_ID = NAME2.ID AND


SELECT NAME.ID, NAME4.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID <> ''

UNION



WHERE

NAME.ID = ROOT.ID AND NAME.COMPANY_RECORD = 0 AND


EMPLOYEE.CO_ID = NAME2.ID AND NAME2.CO_ID = ROOT.CO_ID

UNION

SELECT

NAME.ID,

EMPLOYEE.ID AS [REGISTRANT] FROM

NAME, NAME NAME2,

NAME NAME3, NAME EMPLOYEE,

(



<> ''

UNION SELECT NAME.ID, NAME3.CO_ID FROM NAME, NAME NAME2, NAME NAME3 WHERE NAME.CO_ID = NAME2.ID AND


SELECT NAME.ID, NAME4.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4 WHERE NAME.CO_ID =

NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID <> '' UNION



WHERE

P a g e | 34


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

NAME.ID = ROOT.ID AND

NAME.COMPANY_RECORD = 0 AND


EMPLOYEE.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME2.ID AND

NAME2.CO_ID = ROOT.CO_ID

UNION

SELECT

NAME.ID, EMPLOYEE.ID AS [REGISTRANT]

FROM

NAME, NAME NAME2,

NAME NAME3, NAME NAME4,

NAME EMPLOYEE,

( -- This select gets the root id up to 5 levels high

SELECT NAME.ID, NAME.CO_ID FROM NAME WHERE NAME.CO_ID <> '' UNION

SELECT NAME.ID, NAME2.CO_ID FROM NAME, NAME NAME2 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID <> ''

UNION

SELECT NAME.ID, NAME3.CO_ID FROM NAME, NAME NAME2, NAME NAME3 WHERE NAME.CO_ID = NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID <> ''

UNION SELECT NAME.ID, NAME4.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4 WHERE NAME.CO_ID =

NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID <> ''

UNION SELECT NAME.ID, NAME5.CO_ID FROM NAME, NAME NAME2, NAME NAME3, NAME NAME4, NAME NAME5 WHERE

NAME.CO_ID = NAME2.ID AND NAME2.CO_ID = NAME3.ID AND NAME3.CO_ID = NAME4.ID AND NAME4.CO_ID = NAME4.ID AND NAME5.CO_ID <> ''

) ROOT WHERE

NAME.ID = ROOT.ID AND

NAME.COMPANY_RECORD = 0 AND NAME.STATUS = 'A' AND

EMPLOYEE.CO_ID <> '' AND EMPLOYEE.CO_ID = NAME4.ID AND

NAME4.CO_ID = NAME3.ID AND

NAME3.CO_ID = NAME2.ID AND NAME2.CO_ID = ROOT.CO_ID

GO

P a g e | 35


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Event_Reg_Sp – iMIS 10.x Only

This table is used to create stored procedure pricing for events in iMIS 10. The code is the Event Code and

the Description is the name of the stored procedure that will calculate the pricing.

Table: Store_Event_Timezone_Override

This table is used to override the Default Time Zone on Events. The ConfigDefaultEventTimezone entry in the

Store_Settings table will determine your default time zone (usually the location of your organization). In this

table you will enter the Event Code and the time zone for that event to display.

The description of the time zone must match what’s listed in the Time Zone Registry on the server the Online

Marketplace is installed. This can be found under the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones.

P a g e | 36


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Featured_Events

To feature an event you will create a table called Store_Featured_Events where the code is the event code

from iMIS. The event will only be listed until the specified End Date of the meeting, the status is ‘A’ and the

‘Show this Event on Web’ option is turned on.

P a g e | 37


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Fundraising_Appeals

This is a listing of the Appeal Codes that will be displayed. Appeal codes are listed under Fundraising>>Set up

tables>>Appeals:

NOTE: Each Distribution code must have a Fund, Appeal and Campaign assigned to it in order to

display in the Marketplace.

P a g e | 38


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Fundraising_Mappings

This optional table will map your donation products to the types of tributes available to that product.

This is how tributes appear on the Donations page:

P a g e | 39


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Fundraising_Options

This optional table is used to setup the tribute options you want to offer on your donations page. These are

two examples but you can create others.

P a g e | 40


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Kit_Events

This table is used to combine items from multiple events into a single item to be displayed in the cart, during

checkout, and on the receipt.

The code field should contain the product code of a product you create in Orders under Orders ->>Manage

Inventory to display in place of the event items, and the description field should contain a comma separated

list of the event items (Event Code/Function Code) that make up the combined product code. Your product in

Orders must be marked as a kit and have at least one child product. We recommend a dummy product. Both

must be set to Sell on Web.

You can also include products in your Kit from the Orders module that would then also be included in the kit,

in addition to the events setup here.

P a g e | 41


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Long_Titles

This table allows you to enter an Event Code, Function Code or Product Code in the Code field and a title that

is too long for the iMIS Title field. The long title will be used in the ATS Online Marketplace in the following

areas:

• Search Results • Event Details

• Product Details • Calendar views

• Featured items, best sellers, people who bought this, upsell/cross sell, recently viewed items.

EXAMPLE OF THE DISPLAY IN THE ONLINE MARKETPLACE:

P a g e | 42


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Member_Type_Description

This table is used to display a long description for member type (Name.MEMBER_TYPE). Code is the code of

the customer type from the customer type table and the description is the long description you want to

display.

P a g e | 43


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Member_Type_Sort_Order

This table determines the sort order in which member types are displayed during a join or renew. The code is

the customer type code and the description is a number that designates the sort order.

P a g e | 44


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Product_Categories

This table specifies what product categories to show in the Online Marketplace. When adding items to this

table, be sure to put the iMIS Product Category Code in the Code field and the full category name in the

Description field. A list of product category names can be found in iMIS under the Orders>>Set up

tables>>Product categories. From the Orders module:

1. Set up tables>>Product Categories

2. Include any of the product categories abbreviations under the “Current Categories” label in the

Store_Product_Categories table that you would like to appear in the Online Marketplace.

Note: If an iMIS product has a category that does not appear in this list, it will not appear in the

Online Marketplace. Conversely, products with no category will appear in the Online Marketplace.

This will display on the right side of the Online Marketplace as links for customers to click to access each type

of product.

P a g e | 45


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

WEB CATEGORIES

You can use the iMIS Web Categories functionality in lieu of

using the STORE_PRODUCT_CATEGORIES table. The

ShowProductWebCategoriesLevel entry in the

STORE_SETTINGS table will control how many levels are

displayed. When clicking on an iMIS Web Category from the

right gutter, child products will not be displayed; only Master

Products will display.

You can link directly to Web Categories and the category will

be highlighted and expanded automatically. For example the

link

http://store.atsol.org/store/searchresults.aspx?categoryid=69

displays the category (69) expanded and highlighted by

default.

Web Categories are setup in iMIS under System Setup>>Setup commerce components>>Store home.

1. Plan your categories before you enter them – no sorting option in iMIS

2. Items must be set to Sell on Web (SOW)

3. Must have at least one product linked and set to Sell on Web

P a g e | 46


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Product_Categories_Addl

This table contains a list of additional items to show in the “Product Categories” section located in the sidebar

of the store. The code field should contain the text for each additional link, while the description field should

contain the relative link path. See the Event Links section of this document for link options.

Table: Store_Product_Purchase_Filters

Allows you to enter a product code and a view associated to filter who can purchase that product. The view

will return the ID numbers that can purchase this product.

Your view must return

one column called ID.

Here is a very basic

sample:

CREATE view

[dbo].[vwATSProdPurchaseFilterSample] as select ID from Name where Member_Type = 'M'

GO

P a g e | 47


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Product_SP_Pricing

This table contains the product code of any Orders product where the price is being calculated by a stored

procedure. The Code is the iMIS Product Code and Description is the name of your custom stored procedure.

The following

fields can be

added to your

stored

procedure. If they are specified, the parameters will be passed to your stored procedure.

1. @productcode – This is the product code of the product.

2. @btid – This is the bill to ID of the customer.

3. @stid – This is the ship to ID of the customer.

4. @qtyincart – This is the quantity of this product code that is in the cart not counting the number they

want to add.

5. @qtytoorder – This is the quantity that the person wants to add.

Stored procedures need to include up to 3 parameters and must be used in this order:

1. Price – the unit price to charge the person for the product.

2. OrderLineNote – note that will be stored in the Order_Lines.NOTE field.

3. DescriptionSuffix - text that will be appended to the Order_Lines.DESCRIPTION. It will appear on the

receipt and in iMIS (e.g. ‘Half Off’).

For example, you create a stored procedure to give only students a discount on a particular book. You could

use the Order_Lines.NOTE to trigger a Task Centre task.

If you only use one parameter in your stored procedure it will be the price, if you two it will be price and

‘reason’ and if you use three it will be price, ‘reason’, ‘description’.

Example Stored Procedure:

CREATE PROCEDURE [dbo].[sp_HalfMemberPrice_Reason_Description] @PRODUCTCODE VARCHAR(31) AS select price_1 * .5, 'Half_Price', ' (Half Price)' from Product where PRODUCT_CODE = @PRODUCTCODE GO

P a g e | 48


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Receipt_Subject_Lines

This table is used to control subject lines for receipt and confirmation letter emails.

Code Description

DFLT_EVENT_RECEIPT If confirmations are not enabled, the mask set in the

Description field will be used for the subject on the email

receipt for all events unless an event-type specific entry is

setup in this table.

DFLT_EVENT_CONFIRMATION If confirmations are enabled, the mask set in the

Description field will be used for the subject line on all

event confirmations unless an event-type specific entry is

setup in this table.

DFLT_EVENT_[EVENT_TYPE] This mask will be used for the subject line on all event

confirmations and receipts that match this entry’s event

type code. You can have several entries that match your

event types. Just replace [EVENT_TYPE] with the desired

event type (i.e. WEB, ANN, SEM).

DFLT_DUES_RECEIPT This mask will be used for the subject line on receipts for

products with a product type of DUES.

DFLT_DONATION_RECEIPT This mask will be used for the subject line on receipts for

product types of GIFT or VOL.

DFLT_SUBSCRIPTION_RECEIPT This mask will be used for the subject line on receipts for

product types of SUB.

DFLT_ORDERS_RECEIPT This mask will be used for the subject line on all product

orders.

P a g e | 49


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Merge Fields Available:

~ST_ID~ - Ship-to ID ~NUM_ITEMS~ - Number of items in order

~BT_ID~ - Bill-to ID ~EVENT_CODE~ - Event code

~ST_FULL_NAME~ - Ship-to Full name ~EVENT_TITLE~ - Event title

~BT_FULL_NAME~ - Bill-to Full name ~EVENT_START_DATE~ - Event start date

~ORDER_NUMBER~ - Order number

Example:

Email receipt:

P a g e | 50


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Registration_Validation

This table lists events and the name of a stored procedure that will limit registration to that event. This table

is typically used if the other methods of restricting registration (prerequisite functions, conflict coding,

restrictions by registration class and special grouping of functions) cannot be used.

The custom validation will execute when you press the “add to cart” button. At that time the stored procedure

will run and if the stored procedure returns a blank string, the registration will be allowed to be added to the

cart. If the stored procedure returns a non-blank string then the registration will not be added to the cart and

the person will not be able to complete the registration. The message from the stored procedure will be

displayed on the screen.

A general lookup table must be created called STORE_REGISTRATION_VALIDATION. The Code is the iMIS

event code and the Description is the name of a valid stored procedure that will be executed.

The stored procedure needs to be created. It MAY include the following parameters. The system will

automatically check your stored procedure to look for these parameters and if they are included in your stored

procedure, it will send the correct parameters:

ID – ID number of person that is being registered

BT_ID – Bill to ID number of the person that is being registered

EVENTCODE – iMIS Event Code

PRODUCTCODES – This is a pipe delimited “|” string of product codes that the person is trying to

register for. In some cases you can just search the string for the product code you are

looking for and in other situations you can parse it by using a SPLIT function to split

the string into individual parameters

P a g e | 51


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SAMPLE STORED PROCEDURE

Below is a sample stored procedure that looks to see if the person is trying to register for a function called

XTRA_WELCOME. First it checks to see if the person is trying to register for the function called

XTRA_WELCOME. If so it checks the first name of the person. In this stored procedure only people named

JOHN can register for this function. If the person’s first name in iMIS is John then the stored procedure returns

a blank. If the person is not named John then the validation returns a message.

CREATE PROCEDURE [dbo].[SP_DMAANNUAL_VALIDATION] (@BTID VARCHAR(10), @ID VARCHAR(10), @EVENTCODE VARCHAR(30), @PRODUCTCODES VARCHAR(1000))

AS

BEGIN

SET NOCOUNT ON

-- First split the product codes into a table

DECLARE @separator varchar(1)

SET @separator = '|'

DECLARE @separator_position INT -- This is used to locate each separator character

DECLARE @array_value VARCHAR(1000) -- this holds each array value as it is returned

DECLARE @PRODUCTCODETABLE TABLE (PRODUCT_CODE VARCHAR(50)) -- create a temp table to hold product codes

-- For the loop to work we need an extra separator at the end. We always look to the

-- left of the separator character for each array value

SET @PRODUCTCODES = @PRODUCTCODES + @separator

-- Loop through the string searching for separator characters

WHILE PATINDEX('%' + @separator + '%', @PRODUCTCODES) <> 0

BEGIN

-- patindex matches the a pattern against a string

SELECT @separator_position = PATINDEX('%' + @separator + '%',@PRODUCTCODES)

SELECT @array_value = LEFT(@PRODUCTCODES, @separator_position - 1)

-- This is where you process the values passed.

insert into @PRODUCTCODETABLE select @array_value

-- This replaces what we just processed with and empty string

SELECT @PRODUCTCODES = STUFF(@PRODUCTCODES, 1, @separator_position, '')

END

DECLARE @VALIDATION VARCHAR(1000)

DECLARE @FIRSTNAME VARCHAR(40)

DECLARE @WELCOMRECEPTION VARCHAR(31)

P a g e | 52


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SET @FIRSTNAME = (SELECT UPPER(NAME.FIRST_NAME) FROM NAME WHERE ID = @ID)

SET @WELCOMRECEPTION = (SELECT PRODUCT_CODE FROM @PRODUCTCODETABLE WHERE PRODUCT_CODE = 'XTRA_WELCOME')

IF @WELCOMRECEPTION <> ''

BEGIN

IF @FIRSTNAME = 'JOHN'

SET @VALIDATION = ''

ELSE

SET @VALIDATION = 'Only people named John can register for the welcome reception!'

END

SELECT @VALIDATION

SET NOCOUNT OFF

END

GO

P a g e | 53


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Search_Keyword_Exclude

This table contains the list of words to exclude when using the Tag Cloud. Please see the Tag Cloud section

for more information about this feature.

P a g e | 54


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Settings

A full table explaining each entry follows.

NOTE: To be compatible with the Online Marketplace checkout we recommend that any URL’s in

this table be prefaced with https://.

The Store_Settings table contains many of the configuration settings used by the Online Marketplace. The

majority of items in this table can be separated into one of four main categories:

CONFIGURATION (CONFIG)

The configuration section is used to set up options like frame duration and search exclusion terms. Many of

the “Config” options can be set to either an integer or a string value.

VISIBILITY (SHOW)

The “Show” parameters of the store settings table are used to toggle the visibility of a variety of store sections

and features. To show or use a particular item set the description field value to “true.” Conversely, to hide or

disable a particular item set the description field value to “false.”

INTEGER (INT)

The third section in the store settings table is the integer section. This section is used to set the product image

heights and widths that will be used throughout the store.

LABEL (LBL)

The final section in the store settings table is used to store label (text) information. All labels begin the letters

“lbl” (short for label), and each label contains the text that is used on the store web site.

P a g e | 55


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

STORE_SETTINGS TABLE


AllowAnonymousCartRetrieval

True or false True – Allows users to retrieve

abandoned cart item(s) by

storing a non-expiring cookie.

Cookies cannot be deleted for

this functionality to work.

False – Not allowed.

AllowCoupons

True or false True – Turns on the couponing

feature

False – No coupons allowed

AllowDuesJoinPayLater

True or false True – Turns on the feature to

allow someone to pay later

when joining

False – Pay later not allowed

when joining

AllowDuesRenewPayLater

True or false True – Turns on the feature to

allow someone to pay later

when renewing

False – Pay later not allowed

when renewing

AllowRegistrationAdditions

Note: iMIS 20.1.X.X and higher only

True or false True – Allows registrants to edit

registrations

False – Registrants are not

allowed to edit registrations

AllowRegisterSomeoneElse

True or false True – Turns on the global

setting to register someone else

from your company for all

events

False – Not allowed – controlled

at event level

CombineHandlingWithFreight

True or false True – Combines handling

charges with freight charges

False – Keeps charges separate

P a g e | 56


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigAdminPaymentSourceCode

Text This is the source code that will

be used on an order when using

the administrative payment

options. The source code must

be a valid source code in the

SOURCE_CODE general lookup

table in iMIS and is defaulted to

WEB.

ConfigAnonymousOrderID

ID number in iMIS This will be the ID number of

the Anonymous record created

for nonmember pricing before a

customer logs in.

ConfigAutoFrameDuration

Number of Milliseconds This is the number milliseconds

that the scrolling window frames

will hold before scrolling to the

next frame in the horizontal and

vertical scrolling areas for

automatic scrolling in specials

and recently viewed items.

ConfigAutoScrollDuration

Number of Milliseconds This is the number of

milliseconds that it takes to

scroll from one frame to another

in the horizontal and vertical

scrolling areas for automatic

scrolling in specials and recently

viewed items.

ConfigCouponManagerID


the Store Manager record in

iMIS that you will use to manage

your coupons. It is

recommended that you use your

MANAGER record for this.

ConfigDefaultCountryDatabase

Typically left blank for US

customers – see note.

The value in the Country table

for the default country. This is

used for freight. For many

clients in the United States, this

is blank and therefore they need

to leave it blank in the db.

P a g e | 57


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigDefaultCountryDisplay

Example: USA Value to display for the default

country in the database. For

example, they may set the

ConfigDefaultCountryDatabase

to blank but set the

ConfigDefaultCountryDisplay to

“United States”. Whatever value

they use will be displayed in the

dropdown of the country table

when calculating freight.

ConfigDefaultEventTimezone

Name of Time Zone (i.e.

Central Standard Time)

NOTE: The description of

the time zone must match

what’s listed in the Time

Zone Registry on the

server the Online

Marketplace is installed.

This can be found under

the following registry key:

HKEY_LOCAL_MACHINE\S

OFTWARE\Microsoft\Wind

ows

NT\CurrentVersion\Time

Zones.

This is the time zone that will be

used for your default events

ConfigDefaultSearchSortOrder

Number This is the number of the default

sort order for search results

acceptable values are as follows

0 – ProductMemberPrice

1 - ProductMemberPriceDesc

4 - ProductTitle

6 – PublicationDateDesc

7 - PublicationDate

P a g e | 58


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigDefaultShippingMethod

Name of Shipping Method

to be used to calculate

freight before someone

logs in

This table works in conjunction

with the

STORE_SHIPPING_METHODS

table. Order of selection is:

1 – Entry set here

2 – Default Shipping Method

setup in Orders module

3 – If 1 & 2 do not exist then

the first method in the

STORE_SHIPPING_METHODS

table is used

ConfigDonationsBannerURL URL URL of banner html to show on

the donations page

ConfigDuesAnnualStartMonth

Number Sets the default dues annual

start month. If 0, then it will

calculate based on the ‘First

Month of Fiscal Year’ setting in

iMIS.

ConfigDuesBillCompanyRecord Reserved for future use.

ConfigDuesCouponsIncludeVolItems

True/False

Default: false. The only is

applicable when there are

no product code or product

category restrictions on the

dues coupon.

True - Dues coupons will

include VOL items for dollars off

and percentage off coupons.

False - VOL dues items will not

be discounted when a dues

coupon is used.

ConfigDuesManagerID

ID number in iMIS ID record in iMIS that will

manage dues processes. It is

recommended that you use your

MANAGER record for this.

ConfigEmailCSSURL

URL of the CSS Stylesheet This is the URL of the CSS

stylesheet that will be included

in email receipts.

P a g e | 59


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigEventAutoAddGroupHeader

True or False – Default

setting is True

True – Automatically displays

the ‘Additional Programs’ and

‘Additional Information’ headers

between Sort Sequence groups.

False – Turns off these group

headers to allow for custom

group header creation in Events.

See Setup in Events section for

details.

ConfigEventDetailDisplayMode

Options: Linear, Tabs,

PanelsExpandAll,

PanelsExpandNone,

PanelsExpandFirst

Controls the mode of display of

the event detail on the Event

Detail Page.

ConfigEventDetailResourceGroup

Text – Name of Event

Resource Group

When set, any meeting

resources that match this

resource group will be displayed

on the event details page. This

can be used for adding things

like learning objectives and such

to the display.

ConfigEventDetailResourceType

Text – Name of Event

Resource Type

When set, any meeting

resources that match this

resource type will be displayed

on the event details page. This

can be used for adding things

like learning objectives and such

to the display.

ConfigEventEditRegUseOrderDate



setting is True

True – When a person edits

their registration the original

order date will be used to

calculate pricing.

False – When a person edits

their registration the current

date will be used to calculate

pricing.

P a g e | 60


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigEventEndDateMustBeInFuture


setting is True

This setting controls which

events display on the calendar

view. Events that span more

than two weeks do not display

on the calendar. This entry also

determines if an event should be

removed from the cart or if it

can be added to the cart.

ConfigEventFunctionDisplayMode

Options: Linear, Tabs,

PanelsExpandAll,

PanelsExpandNone,

PanelsExpandFirst

Controls the mode of display for

function detail on the Event

Registration page.

ConfigEventIgnoreMaxRegistrantsForEvent

True or False True: Maximum on Define an

Event screen is ignored. Only

function limits are enforced.

Registrants include all statuses

including Cancel &

Cancel/Transfer). Also, if there

is no Maximum set at the event

level but there is an auto-enroll

function that is full the event is

considered full.

False: Maximum on Define an

Event screen is enforced.

ConfigEventMemberRegClass

Valid Registrant Class in

iMIS

A valid registrant class in iMIS

that will determine the

registrant class that will be used

to display member pricing prior

to the person logging in.

ConfigEventNonMemberRegClass

Valid Registrant Class in

iMIS

A valid registrant class in iMIS

that will determine the

registrant class that will be used

to display non-member pricing

prior to the person logging in.

ConfigEventPasskeyEnabled

True or False True: If using Passkey an

image will show on the

Myorders.aspx page.

False: No Passkey functionality

enabled.

P a g e | 61


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigEventStartDateMustBeInFuture


setting is True

This setting controls which

events display on the calendar

view. Events that span more

than two weeks do not display

on the calendar. Setting this

entry to false will allow people

to register after the start date of

the event.

ConfigEventsBillCompanyRecord

True or False True – Sets the Bill To ID on all

registrations to the Company ID

of the registrant. If the person

is not linked to a company the

Bill To ID will be the ID of the

doing the registration.

False – Bill To ID of registrant

is set to person doing the

registration.

ConfigEventTimeConflicts


setting is True

True – Functions that occur at

the same date/time will be in

conflict and a person cannot

register for others at the same

date/time.

False – Overrides the date/time

conflict and allows people to

register for functions at the

same date/time.

ConfigGiftCardManagerID iMIS ID Number Reserved for future use.

ConfigManualFrameDuration

Number of milliseconds This is the number milliseconds

that the scrolling window frames

will hold before scrolling to the

next frame in the horizontal and


manual scrolling in promotions,

featured items, best sellers,

newest items and specials in the

highlight section.

ConfigGoogleAnalyticsAnonymizeIP

True or False True – Google Anonymizer code

will be added to the script that

gets added to the page

False – No anonymizer added

to page

P a g e | 62


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigGoogleAnalyticsEnhancedECommerce

True or False True – Google Analytics

Enhanced eCommerce Tags

added.

False – Google Analytics tags

not added.

ConfigGoogleAnalyticsTrackingID Google Analytics Tracking

ID

Enter the Google Analytics

Tracking ID for your website.

ConfigGoogleTagManager

True/False True – Turns on inclusion of

Google Tag Manager

False – Does not include Google

Tag Manager

ConfigGoogleTagManagerIdentifier

Number Obtained from Google (obtained

from

https://tagmanager.google.com)

ConfigManualScrollDuration

Number of milliseconds This is the number milliseconds

it takes to scroll from one frame

to another in the horizontal and


manual scrolling in promotions,

featured items, best sellers,

newest items and specials in the

highlight section.

ConfigOrdersBillCompanyRecord

True or false True – Sets the Bill To ID on all

orders to the Company ID of the

customer. If the person is not

linked to a company the Bill To

ID will be the ID of the person

placing the order.

False – Bill To ID of customer is

set to person ordering.

ConfigPaymentSourceCode

Source Code in iMIS

(Default is WEB)

Name of a source code in the

iMIS SOURCE_CODE General

Lookup/Validation table to set as

the default source code for all

transactions.

https://tagmanager.google.com/

P a g e | 63


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigPaymentSourceCodeParameter

Name of parameter to call

when setting a specific

source code. (Default is

PROMO)

When sending customers to a

specific page and to set a

specific source code to the

transaction, this is the name of

the parameter in the URL. For

example,

http://store.mysite.org/default.a

spx?PROMO=SPRING2013

ConfigPreviousReceiptDays

Number Number of days back a person

can see their receipts. Setting

this to 0 means no restriction.

There is also a link at the

bottom of the page if someone

wants to see all of their previous

orders.

ConfigProductInfoURLNewWindow

True or false If true clicking on product info

URL will open the link in a new

window. If set to false it will

open the link in the same

window.

ConfigProFormaOrderTypesThatDoNotAffec

tInventory

Pro-forma order types –

comma-delimited list

List of pro-forma order types

that do NOT affect inventory.

ConfigPromotionsManagerID


the record in iMIS that you will

use to manage your promotions

ConfigReceiptLogoURL

URL to logo URL of a logo that will show up

in the receipt. If it is blank there

will be no logo. Otherwise, this

logo will show up, in the upper

left hand corner of the receipt.

ConfigSearchExcludeCategories

Text This is a comma separated list

of categories. No products with

these categories will be shown

in the search results. Do not use

spaces between commas

ConfigSearchExcludeEventCodes


of event codes that will not be

shown in the search results. Do

not use spaces between

commas.

P a g e | 64


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigSearchExcludeEventTypes


of event types that will not be



commas

ConfigSearchExcludeProductCodes


of product codes that will not be



commas.

ConfigSocialPrimary

• ShareOnTwitter – for

www.Twitter.com

• LinkedIn – for

www.LinkedIn.com

• Delicious – for

www.Delicious.com

• Blogger – for

www.Blogger.com

• Digg – for

www.Digg.com

• Reddit – for

www.Reddit.com

• StumbleUpon – for

www.StumbleUpon.com

• MySpace – for

www.MySpace.com

• Tumblr – for

www.Tumblr.com

• ShareOnFacebook – for

www.facebook.com

• GoogleBookmarks – for

www.google.com/bookmar

ks

• MailTo – opens the user

machine’s mail client

• SendEmail – opens the

built-in Send E-mail form

in the browser

Determines the types and sort

order of the social networks that

show up on the screen at all

times. This is a comma delimited

list of the valid social networks.

http://www.twitter.com/

http://www.linkedin.com/

http://www.delicious.com/

http://www.blogger.com/

http://www.digg.com/

http://www.reddit.com/

http://www.stumbleupon.com/

http://www.myspace.com/

http://www.tumblr.com/

http://www.facebook.com/

http://www.google.com/bookmarks

http://www.google.com/bookmarks

P a g e | 65


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigSocialSecondary

Same list as

ConfigSocialPrimary and

• FacebookShare – creates

a Share button

• FacebookLike – creates a

Like button

• FacebookSend – creates

a Send button

• FacebookRecommend –

creates a Recommend

button

• GooglePlusOne

• LinkedInShare

Determines the types and sort

order of the social networks that

show up in the secondary

popup. This is a comma

delimited list of the valid social

networks.

ConfigSplitCartByEntity

True or false True – Enables multi-entities in

the Online Marketplace

False – Multi-entities not

enabled.

ConfigStoreBannerURL

URL to banner (i.e.

http://www.atsol.org/store

banner.html)

This is a URL to point to a

custom banner for the

marketplace. Recommended

size: 640x301. See the Store

Banner section for more

information.

ConfigStoreCSSUrl

URL This is the URL that allows you

to define the location of the

override style sheet for the

Online Marketplace. Used to

create custom styles and extend

branding from the overall site

wrapper to the Online

Marketplace elements or

override default values.

ConfigSyncSubDatesWithPrimaryDues

True or false

NOTE: Multi-year

subscriptions will not sync

correctly with single years

dues.

True – Subscriptions added to

the cart will synchronize with

the primary dues item’s dates.

False – Subscription dates will

be calculated according to the

billing cycle.

http://www.atsol.org/storebanner.html

http://www.atsol.org/storebanner.html

P a g e | 66


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ConfigVaultExpirationDays

Number This is the number of days that

an electronic document will be

able to be downloaded. After

that time people will need to

repurchase the item.

ConfigVaultRootPath

Server folder name

NOTE: Entry must include

trailing backslash –

c:\electronicdocuments\

This is the URL where electronic

documents need to be stored

that is outside of the root

website yet available to the web

server process via permissions.

ContinueShoppingURL

Text This is the url to go to when

someone clicks on the continue

shopping button

DuesChaptersIQA

Text This is the name of an IQA that

will have the four columns

identified above. If the IQA is

not provided, then the

SUGGESTED and SORT_ORDER

will not be used to control the

order of the items on the page.

DuesChaptersFilterByIQA

True or false This setting is only applicable if

the IQA is provided. This value

can be TRUE or FALSE. If TRUE

then any product codes in the

“other” section will only be

shown if their product code is

in the IQA. If their product code

is NOT in the IQA the item will

not be shown. This will allow

you to have another filtering

mechanism for people who join

or renew other than the billing

cycle. This will let you have the

same billing cycle for two

people but show different

product codes based on the

rows in the IQA query.

DuesJoinPayLaterButtonLink

Text URL of page a person will be

directed to after clicking the join

and pay later button

P a g e | 67


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


DuesMiscIQA








DuesMiscFilterByIQA


















DuesRenewPayLaterButtonLink

Text URL of page a person will be

directed to after clicking the

renew and pay later button

DuesJoinPayLaterButtonText

Text Button text when

AllowDuesJoinPayLater is set to

true

DuesRenewPayLaterButtonText

Text Button text when

AllowDuesRenewPayLater is set

to true

DuesJoinPayLaterNotice

Text Text that displays when

AllowDuesJoinPayLater is set to

true

P a g e | 68


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


DuesRenewPayLaterNotice


AllowDuesRenewPayLater is set

to true

DuesSectionsIQA








DuesSectionsFilterByIQA


















DuesSubsIQA








P a g e | 69


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


DuesSubsFilterByIQA


















DuesVolsIQA








DuesVolsFilterByIQA


















P a g e | 70


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


EmailAllReceipts – NOT USED 12/2012 True or false Sends separate emails for all

transactions.

EventSendConfirmationLetters

True or false True – Activates the Online

Marketplace Confirmation Letter

system.

False – Not turned on.

FreeHandlingwithFreeShipping

True or false True – This means that if the

shipping is free the handling will

also be free

False – This means that if the

shipping is free the standard

handling rates (if entered) will

apply.

FreightNote

Note (ie We cannot ship to

PO Boxes.)

This will be a note that you

enter about your shipping

(optional).

intCartImageMaxHeight

Number

Default Setting = 30

0 means no limit

Maximum number of pixels for

height of images in the

Payment, Checkout & View Cart

screens.

intCartImageMaxWidth

Number


0 means no limit


width of images in the Payment,

Checkout & View Cart screens.

intDetailsImageMaxHeight

Number

Default Setting = 0

0 means no limit


height of images in the Event

Registration and Product Detail

pages.

intDetailsImageMaxWidth

Number


0 means no limit


width of images in the Recently

Viewed, Featured Items, Best

Sellers, Newest Items & Special

Items sections.

IntEventGoogleMapHeight - NOT USED

06/2016 v. 2016.11

Number – Default is 420 Allows for resizing the height of

the Google map for events.

IntEventGoogleMapWidth - NOT USED

06/2016 v. 2016.11

Number – Default is 420 Allows for resizing the width of

the Google map for events.

IntMaxSearchResults - NOT USED

06/2014

Number Indicates the maximum number

of results displayed. A value of

0 (zero) indicates no limit.

P a g e | 71


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


intMaxTagCloudItems

Number


Sets the maximum number of

words to display in the Tag

Cloud

intSearchImageMaxHeight

Number This is the maximum number of

pixels for the height of an image

on the search results page

intSearchImageMaxWidth


pixels for the width of an image


intSearchRecordsPerPage Number This is the number of items per

page displayed in a search.

intThumbnailImageMaxHeight


pixels for the height of a

thumbnail picture

intThumbnailImageMaxWidth

Number


0 means no limit

This is the maximum number of

pixels for the width of a

thumbnail picture (in recently

viewed and specials)

lblAlreadyRegisteredForEvent

You have already

registered for this event.

To change your

registration, please contact

us by email at <a

href=mailto:[email protected]

g>[email protected]</a> or

call us at (888) 243-2263.

Customizable label for message

to customers already registered

for an event.

lblAmountDue

Text Label for text on Amount Due

line on receipts and confirmation

letters

lblBestTab Best Sellers Customizable label to identify

your Best Sellers section

lblBridgeNotSynchedMessage

Text Message that will be

displayed when a

transaction that is linked to

a bridge does not sync.

Default: Access to your

content is not available at

this time.

mailto:[email protected]


P a g e | 72


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblCannotCalcFreight

Example: Your order is

too large to calculate

freight, please contact the

association office.

Customizable message for

orders that freight cannot be

calculated for.

lblCartSummary Text Label for Cart Summary (Mini-

cart)

lblCheckout

Text – Default: Pay Now Text for the ‘checkout’ button

that takes you directly to the

payment screen when there are

no shippable items in the cart.

lblComplimentaryOrderButton

Text – Default: Place

Order

Allows you to change the label

on the Place Order button for

complimentary orders.

lblContinueShopping Text Text for ‘Continue Shopping’

button

lblCrosssell You might be interested in Customizable label used for

cross-sell items

lblDonations Text Text of Donations label

lblDues Text Text of Dues/Subscriptions label

lblDuesBillingCategory

Text

See the Dues Wizard

Header section.

This is a label that prefaces the

dues billing category. If the label

is blank or the billing category on

the record is blank, this line will

not display. Default value is

‘Current Billing Category’.

LblDuesChapterSubscribedText

Text This is the text for a header

that will show at the top of the

SUBSCRIBED/SELECTED section

of the display.

lblDuesChapterSuggestedText



SUGGESTED section of the

display

lblDuesChapterOtherText



Other text.

lblDuesListBillHeaderText Text Text displayed at the top of the

list billing page.

P a g e | 73


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblDuesMemberType

Text

See the Dues Wizard

Header section.


member/customer type. If the

label is blank neither the

member type nor label will

display. Default value is

‘Current Member Type’.

lblDuesMiscSubscribedText




of the display.

lblDuesMiscSuggestedText




display.

lblDuesMiscOtherText



Other text.

lblDuesPaidThroughDate

Text

See the Dues Wizard

Header section.


paid through date. If the label

is blank or the paid through

date is blank, this line will not

display. Default value is ‘Last

Paid Through Date’.

lblDuesProcessSomeoneElseButton

Text Text of label for button when

allowing someone to pay

someone else’s dues.

LblDuesSectionSubscribedText




of the display.

lblDuesSectionSuggestedText




display.

lblDuesSectionOtherText



Other text.

P a g e | 74


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblDuesSubSubscribedText

Text This is the text for a header that

will show at the top of the

SUBSCRIBED/SELECTED section of

the display.

lblDuesSubSuggestedText



SUGGESTED section of the display.

lblDuesSubOtherText


will show at the top of the Other

text.

lblDuesVolSubscribedText



SUBSCRIBED/SELECTED section of

the display.

lblDuesVolSuggestedText



SUGGESTED section of the display.

lblDuesVolOtherText


will show at the top of the Other

text.

lblEnterPayment Text Text for ‘Enter Payment’ button

lblErrorText

Text

Default: A copy of this

error has been sent to the

administrator. If this

occurred during checkout,

please contact the office

before resubmitting your

payment.

Custom note that displays when

an error occurs.

lbllblEventAdditionalDescription Text Label for Additional Description

field in the Staff Site

lblEventAddress Text Event Address label

lblEventCalendarButton

Text This is the text that will be

shown on the Event Calendar

Button

P a g e | 75


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblEventCalendarURL Text This is the url of the event

calendar

lblEventCategories

Text (i.e. Events) This is the text that will display

as the heading for the Events

category section

lblEventCoordinators Text Event Coordinators label

lblEventDescription Text Event description label

lblEventDetails

Text Text that displays at the top of

the event detail/registration

page

lblEventDetailsButton

Text This is the text that will be on

the button to show event

details.

lblEventDirections Text Event Directions label

lblEventEditRegistrationButton


Text

Default: Edit Registration

Label that controls text on the

Edit Registration button

lblEventError

Text

Default: This event is not

setup for taking

registrations yet. Please

come back soon to register

online.

Message displayed when there is

an error like no functions found.

lblEventFull

Text

Default: This event has

reached the maximum

number of registrants. We

are no longer taking

registrations for this event.

Message displayed when an

event is at capacity.

lblEventFunctionCategory


Text Label displayed when showing

the function Category field

lblEventFunctionCreditHours

Text This is the label that will be

shown for CEU’s (e.g., “CPE

hours:”). The default is “Credit

Hours:”

lblEventFunctionTrack


Text Label displayed when showing

the function Track field

lblEventLogin

Text

Default: You must be

logged in to register. After

logging in your browser

will return to this page.

Message displayed to prompt

login for registration.

P a g e | 76


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblEventLoginButton Text Label on Login to Register

button

lblEventNotes Text Event Notes label

lblEventRegisterButton Text (Register) Text on ‘Register’ button

lblEventRegisterSomeoneElseButton Text (Register Someone

Else

Text on ‘Register Someone Else’

button

lblEventRegisterSomeoneElseHeader

Text Text that will display above the

listing of people someone is

allowed to register after clicking

‘Register Someone Else’

lblEventRegistrationEditCutoffMessage

Text Text displayed when someone

tries to edit a registration that is

past the date to allow itinerary

changes in the Staff Site

lblEventRegistrationNotStartedMessage

Text Text displays when someone

tries to register for an event

prior to the registration start

date set in the Staff Site

lblEventSpeakers Text Label for Speaker Info

lblEventTitle Text Event Title label

lblEventTitleHeaderPrefix

Text Controls the ‘Event Registration’

text at the top of the

registration page before the

event title.

lblEventWebViewOnly

Text

Message displayed when the

event is set to view on web

only.

lblFeatured Featured Items Customizable label to identify

Featured Items section

lblFreight Freight Customizable label used to

identify freight charges

lblHTMLPageTitle Text This is the title that will be in

the browser window

lblHandling Handling Customizable label to identify

handling charges

lblHighlights Highlights Customizable label to identify

highlights section

lblLoginToCheckout Text Text for ‘Login to Checkout’

button.

lblMemberPrice Member Price Customizable label to identify

member price

P a g e | 77


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblNewestTab Newest Customizable label to identify

newest section

lblNonMemberPrice Non Member Customizable label for non-

member price

lblPayment Text Label for payment line on

receipts and confirmation letters

lblPayPalExpressItemDescription

lblPayPalExpressOrderDescription

lblProductAuthor Text Text that displays when Author

is displayed.

lblProductAvailableForDownload

Text Text that displays indicating a

product is an electronic

document

lblProductBackorder Text Text that displays when a

product is on backorder

lblProductBackorderEmailNote

Text Text that displays before the

email field for notification when

a product is no longer on

backorder

lblProductCatalogDescription Catalog Description Customizable label to identify

catalog description

lblProductCategories

Text This is the text that will display

at the top of the product

categories box

lblProductCode Text Text that displays before

displaying product code.

lblProductDate Text Text that will be displayed as a

label in front of a product date

lblProductDescription

Text This is the text that will be

displayed as a label in front of

the product description

lblProductDetails Text Label that displays at the top of

the product detail page

lblProductEdition Text Text that displays when

displaying the Edition field

lblProductInfo

Additional Product Info

(this is an example of what

you might use here)

Text that appears on the web

site that when clicked on, will

take you to the ProductInfoUrl

in the web options in iMIS for a

product.

P a g e | 78


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblProductISBNNumber Text Text that displays when

displaying ISBN Number field

lblProductMedia Text Text that displays when

displaying the Format field

lblProductOtherDescription Other Description Customizable label to identify

other description

lblProductPages Text Text that displays when

displaying the Pages field

lblProductPublisher Text Text that appears when

displaying Author field

lblProductTotalQtyAvailable


displaying quantity available for

a product

lblProductUnitOfMeasure Text Text that displays when

displaying Unit of Measure field

lblProductWebDescription Web Description Customizable label to identify

web description

lblPromotions

Text This is the text that will appear

above the promotions box on

the home page

lblReceiptBottomNote Text Text for note at bottom of

receipts

lblReceiptCompanyAddress

Text This is the company address

that will be displayed on the

receipt. This is optional if you

use graphics/logos in your

receipt stylesheet.

lblReceiptCompanyName

Organization name Customizable label used on

receipts. This is optional if you

use graphics/logos in your

receipt stylesheet.

lblRecommendations Text Label that appears at the top of

the recommendations section.

lblRegisterToCalculate

Text

Default: Register to

Calculate

Text displayed when the Online

Marketplace cannot determine

pricing before someone logs in.

lblRegistrationCancelled

Text Text displayed when someone

tries to register for an event and

their registration is cancelled.

P a g e | 79


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblRemovedItemNotice

Text If a product become unavailable

(e.g., deleted, set to a status

other than active, out of

inventory) then it is removed

from the cart and this text will

be displayed in the cart

summary (if visible) or at the

top of the cart display (for

checkout and payment screens)

lblReplacement Replacement Items Customizable label to view

replacement items

lblSearchHeaderText Text This is the text that prints in the

header of the search results

lblSearchResultsText

Text Text that displays at the top of

the search results page. Default

is Search Results.

lblSpecials Text This is the text that appears at

the top of the specials section

lblSpecialsTab

Text This is the text that appears on

the specials tab in the highlights

section.

lblStoreHomeButton Store Home Customizable label for store

home button

lblStoreSearchButton Search Store Customizable label for search

button

lblSubscriptionDescription Text Label for description of

subscription items

lblSubscriptionDetails Text Label at the top of the

subscription detail page

lblSubscriptionDetailsButton

Text Label for ‘Details’ button when

subscription items are shown in

the brief listing

lblSubtotal Desired label for subtotal

in cart – i.e. Subtotal:

Customizable label used to

identify subtotal charges

lblTagCloud Text – Default: Keywords Label for Tag Cloud box

lblTax Desired label for subtotal

in cart – i.e. Tax:


identify sales tax charges

lblTotal Desired label for total in

cart – i.e. Total:


identify total charges

lblUpsell Also Available Customizable label for upsell

items

P a g e | 80


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


lblViewAllOrdersButton

Text Button text displayed on ‘View

Previous Orders’

(myorders.aspx) page when a

limit is set with

ConfigPreviousReceiptDays

Setting to view all previous

orders.

lblViewCart

View Cart/Checkout Customizable label for the

buttons customers click to view

their cart or checkout

lblViewEventCalendar Example: Calendar Text for button to go to calendar

view

lblViewEventSchedule Example: Schedule of

Events

Text for brief event listing

lblViewEventList Example: List Text for full event listing

lblViewOrdersButton

View Previous Orders Customizable label for the

button customers click to view

past orders

lblWatermarkCopyrightStatement

Text Text that appears when

watermarking PDF files is

enabled.

lblYourPrice

Example: Your Price Label that displays on the

screen when you enable Your

Price

MaxBest Number (default 10) Maximum number of items to

display in Best Sellers

MaxFeatured Number (default 10) Maximum number of items to

display in Featured Items

MaxNewest Number (default 10) Maximum number of items to

display in Newest Items

MaxSearchResultsMessage - NOT USED

06/2014

Text Message displayed if the actual

number of results returned from

a search exceeds the number

defined in

ShowIntMaxSearchResults.

PaymentACH

True or false True – Allows customers to pay

by ACH

False – This feature is not

displayed

PaymentACHNote Text Text note to display on payment

screen

P a g e | 81


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


PaymentACHProvider

Text • PAYFLOWPRO (Default) – This is PayFlow Pros’s implementation of ACH that uses Telecheck. Based on the value of PaymentTelecheckType, this will either be handled as a SALES transaction or an Authorize/Delay capture transaction.

• AUTHORIZE.NET – This is Authorize.NETs implementation of ACH. This uses an Authorize/Delay capture solution and can void transactions when iMIS fails.

• BLUEPAYENSYNC – This is the setting to use for BluePay when using the AISP enSYNC’s Blue Pay Integration. This only supports a SALES transaction at this time. It will void transactions when iMIS fails.

PaymentACHShowCheckImage

No longer used as of 06/2018

True or false True – Displays an

informational image of a check

for completing ACH (electronic

check) payment (account

number, routing number, etc.)


displayed

PaymentACHTestMode

True or False True – ACH requests will be

sent to the provider in test

mode. This is only for

BLUEPAYENSYNC.

False – Transactions are sent in

live mode.

PaymentAdminOptions

True or false

True – Enables staff to select

desired cash account at

checkout for ‘check’ type

payment

False – Feature not enabled

PaymentCC

True or false True – Allows registrants to pay

by credit card


displayed

P a g e | 82


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


PaymentCCSaveCards

True or false

NOTE: Must have enSYNC

Online AutoDraft and ATS

license for this feature.

True – Allows customers to

save credit card data for future

use

False – Customers cannot save

credit cards for future use

PaymentCCSaveCardReqCVV

True or false

NOTE: Must have enSYNC

Online AutoDraft and ATS

license for this feature.

True – Requires entry of CVV

code on back of credit card

False – CVV code not required

at payment time

PaymentCCShowStreetAddress

True or False True - Shows line for street

address during payment entry

False – Does not show line for

street address during payment

entry

PaymentNotice Text Text note to display on payment

screen.

PaymentPayPalExpress

True or False True – Enables payment by

PayPal Express

False – No PayPal Express

payment option offered

PaymentPayPalExpressButtonText Text Text of button to select PayPal

Express payment type

PaymentPayPalExpressNote

Text Note displayed once PayPal

Express payment type is

selected

PaymentPurchaseOrder

Versons iMIS 15.2.1 and lower only


by purchase order for EVENTS

only


displayed

PaymentPurchaseOrderOrders

Versons iMIS 15.2.5 and higher only


by purchase order for Orders


displayed

PaymentPurchaseOrderEvents

Versons iMIS 15.2.5 and higher only


by purchase order for Events


displayed

P a g e | 83


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


PaymentTelecheckType

1 or 2 – default is 2 1 – Sales transction

2 – Authorize/Delayed Capture

transaction

Only used with PayflowPro

PaymentTypeACHLabel

Text

Default: Electronic

Check/ACH

Label for electronic check/ACH

payment type displayed on

payment screen

PaymentTypeAdminLabel

Text

Default: Administrator

Options

Label for staff-only administrator

option payment type displayed

on payment screen

PaymentTypeCCLabel

Text

Default: Credit Card

Label for credit card payment

type displayed on payment

screen

PaymentTypeGlobalPaymentsLabel

Text

Default: Global Payments

Label for Global Payments


payment screen

PaymentTypePayPalExpressLabel

Text

Default: PayPal Express

Label for PayPal Express


payment screen

PaymentTypePurchaseOrderLabel

Text

Default: Purchase Order

Label for purchase order


payment screen

PDFSecuritySecure True or False True – Enables PDF Security

False – Not enabled

PDFSecurityEncryptionSize 40 or 128 Size of encryption key for PDF

security.

P a g e | 84


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


PDFSecurityOptions

Valid Values:

• CANCOPYCONTENT -

Can copy the

document content.

• CANEDITCONTENT -

Can edit PDF

document content.

• CANFILLFORMFIELDS

- Can fill the form

fields.

• CANPRINT - Can print

the document.

• CANEDITANNOTATIO

NS - Can edit PDF

document

annotations.

Sets the values of the PDF

security settings. Those that are

included are set to TRUE,

otherwise they are set to false.

This is a string and can be

comma delimited.

NOTE: PDF files cannot have

any pre-existing security applied

to them for this feature to work.

PDFSecurityOwnerPassword

Text Password that will be applied to

PDF’s for security. It will be

required to change OWNER

options of the rendered PDF.

PDFSecurityUserPassword

Text Password that will be applied to

PDF’s for security. It will be

required to change USER

options of the rendered PDF.

PurchaseOrderNote

Text A note that displays when

purchase orders are enabled.

i.e. - Please email a copy of your

purchase order to

[email protected].

ReceiptAlwaysEmailDonations

True or false

By default if there is only

one receipt (order) then it

is sent by email.

True – Multiple emails will be

sent for multiple donations done

at the same time (different

distributions)

False – No receipt is emailed.

Customer is directed to the

Previous Orders page in the

Online Marketplace with only

current orders displayed to print

receipts

P a g e | 85


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ReceiptAlwaysEmailDues

True or false



is sent by email.


sent for multiple dues done at

the same time (mixed cart)






receipts

ReceiptAlwaysEmailEvents

True or false



is sent by email.


sent for multiple event

registrations done at the same

time (mixed cart)






receipts

ReceiptAlwaysEmailOrders

True or false



is sent by email.


sent for multiple orders done at

the same time (mixed cart)






receipts

ShowAddToCalendar

NOTE: For the EVENT_BEGIN_TIME

and EVENT_END_TIME fields the time

is set to be the start time of the first

function that is set to ‘Show on Web’

and the end time of the last function

set to ‘Show on Web’ in chronological

order. If there are no functions have a

time then it would be considered to

start at midnight.

True or false True – Allows registrants to add

an event to their Calendar


displayed

P a g e | 86


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowAddToCalendarBrief

NOTE: For the EVENT_BEGIN_TIME

and EVENT_END_TIME fields the time

is set to be the start time of the first

function that is set to ‘Show on Web’

and the end time of the last function

set to ‘Show on Web’ in chronological

order. If there are no functions have a

time then it would be considered to

start at midnight.

True or false True – Shows add to calendar

option on the search results

page


displayed

ShowAddToCartNotice

True or false True – This will show a notice

that someone has added

something to the cart when they

click on the ‘add to cart’ button.

False – This will not show a

notices that someone has added

something to the cart when they

click the ‘add to cart’ button.

ShowAutoTextBoxSearch

True or false True – Turns on auto-searching

feature


enabled

ShowBackorderEmail

True or false True – Turns on field to allow

customer to enter an email

address once item is back in

stock

False – This feature not

available

ShowBanner

True or false True – Turns on the banner

URL in the

ConfigStoreBannerURL

False – Banner not displayed

ShowBestTab

True or false True – Turns on the Best Sellers

tab

False – Best Sellers tab not

displayed

P a g e | 87


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowCalendarScheduleView

True or false True – Shows a brief listing of

events (Title, City,

State/Province, Date, Link to

Registration)

False – Schedule view not

displayed for events

ShowCalendarView

True or false True – Shows a calendar view

button in search results that

contain at least one event

False – Calendar view not

displayed for events

ShowComments

True or false True – Shows comments people

add about products

False – Product comments are

not displayed

ShowCoupon

True or false True – This turns on the feature

to allow someone to enter a

coupon.

False – This turns off the

feature to allow someone to

enter a coupon.

ShowCrosssell

True or false True – Allows for cross-selling

of your products if setup in iMIS

on each product

False – Cross-sell items not

displayed

ShowDonationsAtCheckout

NONE (default), ALWAYS

or ONCE

This setting controls how many

times the customer is taken to

the donations page before

checking out.

ShowDuesCategoriesList

True or false True – Turns on

Dues/Subscription box in right

gutter

False – Not displayed

ShowEventAdditionalDescription

True or false True – Turns on the display of

the Additional Description field

in the event setup in the Staff

Site

False – Additional Description

does not display

P a g e | 88


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowEventAdditionalDescriptionBrief

True or false

True – Turns on the display of

the Additional Description field

in the event setup in the Staff

Site on the search results pages

False – Additional Description

does not display

ShowEventCalendarToolTip

True or false True - tooltip displays when you

hover over an event in the event

calendar.

False - tooltip will not display

when you hover over an event

in the calendar.

ShowEventCategoriesList

True or false True – Shows event categories

on the store home page

False - Hides event categories

on the store home page

ShowEventCoordinators

True or false True – Shows event

coordinators on the event page

False - Hides event coordinators

on the event page

ShowEventCoordinatorsBrief

True or false True – Shows event

coordinators on the search

results page

False - Hides event

coordinators on the search

results page

ShowEventDatesBrief

True or false True - Shows event dates on

the search results page

False - Hides event dates on

the search results page

ShowEventDescription

True or false True - Shows event description

on the event page

False - Hides event description

on the event page

ShowEventDescriptionBrief

True or false True - Shows event description


False - Hides event description


ShowEventFunctionCategory


True or false True – Shows function category

False – Does not show function

category

P a g e | 89


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowEventFunctionCreditHours

True or false True - Shows CEU hours on the

event details page

False - CEU info not shown on

the event details page

ShowEventFunctionTrack


True or false True – Shows function track

False – Does not show function

track

ShowEventFunctionsAtCheckout

True or false True – Allows customer to

expand/collapse functions in a

registration in the Cart

False - Registrations in the Cart

are not expandable/collapsible.

ShowEventGoogleMap

True or false

NOTE: At least 2 fields on

the address must be

added for the map to

display

True – Displays a Google map

of the event location

False – No map displayed

ShowEventNotes

True or false True – Displays a Notes box in

Event Setup in iMIS

False – Notes not displayed

ShowEventNotesBrief

True or false True – Displays a Notes box in

Event Setup in iMIS in the brief

listing

False – Notes not displayed

ShowEventPricingBrief

True or false True – Displays Member &

Nonmember price in the brief

listing

False – Pricing not displayed

ShowEventPricingMini


Nonmember price in mini listings

– Featured Items, Highlights,

Special Items


ShowEventsMemberPrice

True or false True – Shows the member price

in the event detail brief,

highlights, recently viewed, and

specials

False - Member price not

displayed

P a g e | 90


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowEventsNonmemberPrice

True or false True – Shows the nonmember

price in the event detail brief,


specials

False - Nonmember price not

displayed

ShowEventSpeakers

True or false True – Displays Event Speakers

on Event detail page

False – Speakers not displayed

ShowEventSpeakersBrief


on Event brief page

False – Speakers not displayed

ShowEventSpeakersImage


photo on Event detail page

False – Speaker photos not

displayed

ShowEventsYourPrice

True or false True – Shows the YourPrice

fees in the event detail brief,


specials

False - YourPrice price not

displayed

ShowFeatured

True or false True – This shows the featured

items

False – This does not show the

featured items

ShowFRAppealsAtCheckout

True or false True – This shows Fundraising

Distribution items at checkout if

they are set to an Appeal type

listed in the

STORE_FUNDRAISING_APPEALS

table

False – No Fundraising items

are displayed

ShowFreight

True or false True – This shows the freight

options

False – This hides the freight

options

P a g e | 91


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowFRVOLDuesAtCheckout

True or false True – This shows VOL Dues

items at checkout if they are set

to Sell on Web

False – No VOL Dues items are

displayed

ShowGiftCard

True or false True – This shows the gift card

option for payment

False – This hides the gift card

option for payment

(not currently implemented)

ShowHandling

True or false True – This shows the handling

as a separate line item on the

receipt and checkout page.

False – This combines handling

with freight into one line on the

checkout page and on the

receipt.

ShowHighlights

True or false True – This shows the

highlights at the bottom of the

store home page

False – This hides the highlight

section at the bottom of the

store home page.

ShowHomeButton

True or false True - Show the Store Home

button

False - Store Home button not

displayed

ShowMasterProductDescription

True or false True – Shows the description of

Master Products

False – Master Product

description not displayed

ShowMasterProductDescriptionBrief


Master Products in the brief

listing (searchresults.aspx)

False – Master Product

description not displayed in the

brief listing (searchresults.aspx)

P a g e | 92


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowMasterProductSelectedDescriptions


selected product within Master

Products

False – Selected product

description not displayed

ShowOnlyYourPriceWhenLoggedIn

True or False True – When the person is

logged in, it will hide the

member and nonmember price

and only show the Your Price

value.

False – YourPrice not displayed.

ShowPersonalCoupons

True or false True – Enables display of

Personal Coupons

False – Personal Coupons not

displayed

ShowProductAuthor

True or false True – Shows product author

field from Publication

Demographics in iMIS

False – Author not displayed

ShowProductAuthorBrief

True or false True – Shows product author


Demographics in iMIS in the

search results

False – Author not displayed

ShowProductCatalogDescription

True or false True – Displays Catalog

Description of product from

Manage Inventory window in

iMIS

False – Catalog Description not

displayed

ShowProductCatalogDescriptionBrief

True or false True – This shows the catalog

description from iMIS in the

brief listing

False – Brief Description not

displayed

ShowProductCategories

True or false True – This shows product

category on the product detail

page

False – Product category not

displayed on product detail page

P a g e | 93


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowProductCategoriesBrief

True or false True – This shows the product

category on the ‘brief listing’

False – Product category not

displayed on ’brief listing’

ShowProductCategoriesList

True or False True – Displays the list of the

categories on the right gutter

False – Product category list in

right gutter not displayed

ShowProductCode

True or false True – Displays the iMIS

product code

False – Does not display

product code

ShowProductCodeBrief

True or false True – Shows the product code

on the brief page

False – Product code not

displayed in the brief listing

ShowProductDate

True or false True – Shows the product date

on the detail page

False – Product date not

displayed

ShowProductDateBrief

True or false True – Shows the product date

on the brief detail page

False – Product date not

displayed

ShowProductDescription

True or false True – Displays the Desc. field

of product from Mange

Inventory window in iMIS

False – Desc. Field not

displayed

ShowProductDescriptionBrief

True or false True – Shows the product

description on the brief page

False – Product description not


ShowProductDetrailImageZoom

True or false True – Allows for an image to

be zoomed out when moused

over

False – Zoom feature not

enabled

P a g e | 94


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowProductEdition

True or false True – Shows the Edition field

from Publication Demographics

on the detail page

False – Product Edition not

displayed

ShowProductEditionBrief

True or false True – Shows the Edition field


on the brief listing page

False – Product Edition not

displayed

ShowProductInfo

True or false When set to true this will show

the Product Info Link on the

brief listing of a product (search

results). This is the url that is

entered into the ProductInfoUrl


product.

ShowProductInfoBrief

True or false When set to true this will show

the Product Info Link on the

brief listing of a product (search

results) This is the url that is

entered into the ProductInfoUrl


product.

ShowProductISBN

True or false True – Shows the ISBN field


on the detail page

False – Product ISBN not

displayed

ShowProductISBNBrief

True or false True – Shows the ISBN field



False – Product ISBN not

displayed

ShowProductMedia

True or false True – Shows the Format field


on the detail page

False – Product Format not

displayed

P a g e | 95


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowProductMediaBrief

True or false True – Shows the Format field



False – Product Format not

displayed

ShowProductOtherDescription

True or false True – Displays the Other Desc.

field of product from Mange


False – Other Desc. not

displayed

ShowProductOtherDescriptionBrief

True or false True – Shows the Other Desc.

from iMIS on the brief listing

False – Other Desc. not

displayed

ShowProductPages

True or false True – Shows the Pages field


on the detail page

False – Product Pages not

displayed

ShowProductPagesBrief

True or false True – Shows the Pages field



False – Product Pages not

displayed

ShowProductPricingBrief


Nonmember price in the brief

listing


ShowProductPricingMini


Nonmember price in mini listings

– Featured Items, Highlights,

Special Items


ShowProductPublisher

True or false True – Shows the Publisher


Demographics on the detail

page

False – Product Publisher not

displayed

P a g e | 96


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowProductPublisherBrief

True or false True – Shows the Publisher


Demographics on the brief

listing page

False – Product Publisher not

displayed

ShowProductsMemberPrice

True or false True – Shows the member price

in the product detail, product

detail brief, highlights, recently

viewed, and specials

False - Member price not

displayed

ShowProductsNonmemberPrice

True or false True – Shows the nonmember

price in the product detail,

product detail brief, highlights,

recently viewed, and specials

False - Nonmember price not

displayed

ShowProductsYourPrice

True or false True – Shows the YourPrice fee

in the product detail, product

detail brief, highlights, recently

viewed, and specials

False - YourPrice not displayed

ShowProductWebCategoriesLevel

Number If set to 0, will not expand any

of the iMIS 15 Web Categories,

if set to 1, will expand the first

level and so on. When using

iMIS15 Web Categories products

that are set to inactive will not

display.

ShowProductWebCategoriesList

True or False True – Turns on iMIS Web

Categories. When this is set to

true items in

Store_Product_Categories and

Store_Product_Categories_Addl

do not display.

False – Web categories not

displayed.

P a g e | 97


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowProductWebDescription

True or false True – Displays the Web Desc.

field of product from Mange


False – Web Desc. not

displayed

ShowProductWebDescriptionBrief

True or false True – Shows the Web Desc.

from iMIS on the brief display

False – Web Desc. not

displayed

ShowPromotions

True or false True – Shows promotions on

the home page

False – Promotions not

displayed

ShowQRCode

True or false True – Shows QR codes on the

detail page

False – QR codes not displayed

ShowQuantityAvailable

True or false True – Shows number of

product available from iMIS

Inventory

False – Inventory quantities not

displayed

ShowQuantityAvailableBrief

True or false True – Shows quantity available

on the brief listing

False – Quantities not displayed

ShowRecentlyViewed

True or false True – Allows recently viewed

items to be displayed


available

ShowRecommendations

True or false True – Show recommendations

(meaning people who bought

this bought that)

False – Recommendations not

displayed

ShowRegisterSomeoneElseCompany

True or false True – Shows company name in

the ‘Register Someone Else’

display

False – Company not displayed

ShowRegisterSomeoneElseImage

True or false True – Shows image from

Picture tab in the ‘Register

Someone Else’ display

False – Image not displayed

P a g e | 98


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowRegisterSomeoneElseTitle

True or false True – Shows Title in the

‘Register Someone Else’ display

False – Title not displayed

ShowReplacement

True or false True – Allows for display of

replacement items for sold out

products if setup in iMIS on

each product

False – Replacement items not

displayed

ShowReviews

True or false True – Displays reviews of

products by other customers

False – Reviews are not

displayed for products

ShowReviewsBrief

True or false True – Shows customer reviews

on the brief display

False – Reviews not displayed

ShowSearchBox

True or false True - Shows search box

False - Search box not

displayed

ShowSearchEvents

True or false True – Turns on event search

box

False – Event search box is not

displayed

ShowSearchProducts

True or false True – Turns on product search

box

False – Product search box is

not displayed

ShowSearchSubscriptions

True or false True – If set to true, searches

include Dues/Subscription items.

This should only be turned on if

you are licensed for the Dues

Module of the Online

Marketplace.

False – Dues/Subscription

products are not searched

P a g e | 99


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


Sharing

True or false

If set to True there are

two Store_Settings that

must be set to determine

what social networks are

shown –

CONFIGSOCIALPRIMARY

and

CONFIGSOCIALSECONDAR

Y. Social network buttons

fall into two categories.

Primary Buttons and

Secondary Buttons. The

Primary Buttons are those

that always show on the

screen. The Secondary

Buttons are those buttons

that only show up when

you click on the down

arrow in the social

networking area.

You can determine the

number and the sort order

of these buttons by adding

the appropriate social

networking buttons to the

two store settings.

True – Turns on social network

sharing options

False – No social networking is

displayed

ShowSpecials

True or false True – Displays specials from

the STORE_SPECIALS general

lookup table

False – Does not display store

specials

ShowSpecialsTab

True or false True – Displays a special tab to

view Store Specials

False – No tab displayed

ShowStoreCheckoutMessage

Must be one of these

options: Never, Once,

Always

Determines when a customer

sees this popup message.

P a g e | 100


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


ShowStoreReceiptMessage



Always



ShowStoreWelcomeMessage



Always



ShowSubscriptionPricingBrief

True or false True – Displays subscription

product prices in the brief listing

False – Subscription pricing not


ShowTagCloud True or false True – Displays Tag Cloud

False – Tag Cloud not displayed

ShowTax

True or false True – Displays sales tax

charged

False – No sales tax displayed

ShowUnitOfMeasure

True or false True – Shows unit of measure

as setup in each product in

Orders

False – No unit of measure is

displayed

ShowUnitOfMeasureBrief

True or false True – Shows the unit of

measure on the brief listing

False – Unit of measure is not

displayed

ShowUpsell

True or false True – Allows for up-selling of

your products if setup in iMIS on

each product

False – Up-sell items not

displayed

ShowViewOrders

True or false True – Allows customer to view

past orders

False – Feature not available

ShowWatermarkPDFFiles

True or false True – Turns on PDF

watermarking

False – Watermarking not

enabled

P a g e | 101


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


StoreMessageIQA

Text Full path to and name of IQA to

be used with popups (see

ShowStoreWelcomeMessage,

ShowStoreCheckoutMessage,

ShowStoreReceiptMessage

settings)

URLAddRegistrantToIMIS

For example -

http://www.myassociation.

org/addregistrant.aspx

This is the url of a page that will

let you add someone to iMIS.

This is a url outside of the store.

The external webpage should be

able to add the person to iMIS

and return the person to the url

provided in the querystring.

URLEventImageNotFound

URL URL that will be shown if an

event image is not loaded into

iMIS

URLEventImagePrefix

URL

This is a prefix that will be

added to all event image URLs

that don’t start with http or

https (e.g.

https://www.myasssociation.or

g/). This means that an image

such as

images/myeventimage.jpg will

result in a URL of

https://www.myassociation.org

/images/myeventimage.jpg

URLPaymentNotice

URL

URL of a file that will include

text that can be displayed on

the payment screen. This file is

often used to display seals or

approvals from SSL vendors.

URLPersonImageNotFound

URL URL that will be shown if a

speaker does not have a photo

on their Customer record iMIS

on the Picture tab.

URLProductImageNotFound

URL URL that will be shown if a

product image is not loaded into

iMIS.

http://www.myassociation.org/addregistrant.aspx

http://www.myassociation.org/addregistrant.aspx

https://www.myasssociation.org/


P a g e | 102


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


URLReturnParamAddRegistrantToIMIS

For example -

http://www.myassociation.

org/addregistrant.aspx?ret

url

this is the querystring parameter

that is used by the external

program

URLSubscriptionImageNotFound

URL URL of subscription image to

display if one is not set on the

subscription/dues item. NOTE:

You cannot set this in iMIS

however; it can be done with

SQL in the Products table.

ViewOrderTypes

Options include:

MEETING,DUES,FR and

any of your Order Types in

the Orders Module such as

PF, REG, INV

Comma delimited list of order

types to display in ‘View

Previous Orders’

http://www.myassociation.org/addregistrant.aspx?returl



P a g e | 103


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Shipping_Methods

This table contains a list of available shipping options that a user may choose when checking out of the Online

Marketplace. The code field should specify the abbreviated name of the shipping method while the description

field should specify the full name of the shipping method. A list of all accepted shipping methods can be found

in the “SHIP_METHOD” general lookup table (find this entry in the drop down list). Only include shipping

methods that are available to web users, and be sure that the code is typed correctly.

We recommend that you check the ASI website (www.imis.com) to see if they’ve recently released a new Zip

Code file. You can find this under the Tech Support Community in the Downloads section. You can work with

your AiSP to import this updated zip code file or there are instructions for doing this yourself.

NOTE: If you are licensed for Real-time USPS Freight Calculations, please see the Real-time

United States Postal Service Freight Pricing section below for additional setup instructions.

http://www.imis.com/

P a g e | 104


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Specials

This table represents current Product specials that apply to the web store. The items in the table shown to the

right are not required and they are only included here for demonstrational purposes. Before adding any items

to this table, it is important to first create the product with its special price in iMIS. Once the product has been

created, it can be added to the Store_Specials table by specifying the product code in the code field and by

adding a brief description describing the special (for example “1/2 off this month only”) to the description field.

Once a special has expired, simply remove it from this table and it will no longer appear in the Online

Marketplace.

This will display in the Marketplace in the Highlights section under Specials or in the Specials section in the

right gutter. These are controlled by Store_Settings – ShowSpecials (right gutter), ShowSpecialsTab

(Highlights box)

P a g e | 105


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Specials_Events

This table represents current Event specials that apply to the Online Marketplace. The items in the table shown

to the right are not required and they are only included here for demonstrational purposes. Before adding any

items to this table, it is important to first create the Event with its special offer in iMIS. Clicking on the link will

take the customer to the specific page for that event where they can take advantage of your special. Once a

special has expired, simply remove it from this table and it will no longer appear in the web store.

This will display in the Marketplace in the Highlights section under Specials or in the Specials section in the

right gutter. These are controlled by Store_Settings – ShowSpecials (right gutter), ShowSpecialsTab

(Highlights box).

P a g e | 106


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Tax_Auth

This table determines how a customer will be charged sales tax. The priority of tax determination is

City/State, Zip Code then State. Here are some examples of setting up this table.

CODE Description (Values) What it does

Denver|CO Name of Tax Code –

City/State tax example:

DenCty

Any order with a ship to address in Denver, CO will be

charged the DenCty sales tax as setup in AR/Cash>>Set up

tables>>Tax Codes

ZIP|80202 Name of Tax Code – Zip Code

tax example: Denver

Any order with a ship to address with a zip code 80202 will be

charged the Denver sales tax as setup in AR/Cash>>Set up

tables>>Tax Codes

STATE|CO Name of Tax Code – Stat tax

example: CO

Any order with a ship to address with a state of CO will be

charged the CO sales tax as setup in AR/Cash>>Set up

tables>>Tax Codes

Each of the values in the Description field must be a valid Tax Authority in iMIS.

NOTE: If you are using this functionality you must setup a tax code in iMIS called NONE with a

rate of 0.0.

AR/Cash>>Set up tables>>Tax

codes

NONE

P a g e | 107


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Unbilled_Dues

The purpose of this is to identify what to do with dues items that are not billed as part of a join/renew in the Online Marketplace. The options are:

• Delete the subscription record • Inactivate it • Do nothing

The code is either the word DEFAULT, A product type (e.g., DUES, VOL) or a specific product code (e.g., ANNUAL). It will check in this order:

1. DEFAULT - if no other entries are entered it will find this code 2. PRODUCT_TYPE – for example DUES or VOL 3. PRODUCT_CODE – you have to prepend the product type to this entry in the gen table (e.g., VOL/PAC)

The description needs to be one of the following entries. D, I, N and that will designate what to do with the dues item that is not billed as part of the online marketplace (e.g., an old journal entry)

• D – At the end of the process DELETE the subscription record • I – At the end of the process leave the subscription record but set the status to I (Inactive) • N – Do nothing and at the end of the process leave the dues item as it was before the process started

NOTE: If this table does not exist the N option will be used on all unbilled items.

P a g e | 108


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Table: Store_Warehouses

This table will list the names of the warehouses and the order products will be ordered from them. Only used

if using iMIS Multi-Warehouse functionality.

The Code is the name of the warehouse and the Description is the order in which orders will be fulfilled.

P a g e | 109


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Tables: Cross-sell, Substitute, Up-sell

The following 9 tables all consist of a Code (meeting code or product code) and a comma delimited list in

Description field for up-sell/cross-sell/replacement items. If you need more than one value in the Description

enter each code separated by a comma without spaces. Displaying these options are driven by the

ShowCrosssell, ShowUpsell, ShowReplacement values in the STORE_SETTINGS table.

General Lookup/Validation Table Purpose

STORE_CROSSSELL_EVENT_TO_EVENT Cross-sell events to other events

STORE_CROSSSELL_EVENT_TO_PROD Cross-sell events to other products

STORE_CROSSSELL_PROD_TO_EVENT Cross-sell products to other events

STORE_SUBSTITUTE_EVENT_TO_EVEN Substitutes events to other events (yes, it is spelled without the

last T as it won’t fit in iMIS)

STORE_SUBSTITUTE_EVENT_TO_PROD Substitute events to other products

STORE_SUBSTITUTE_PROD_TO_EVENT Substitute products to other events

STORE_UPSELL_EVENT_TO_EVENT Up-sell events to other events

STORE_UPSELL_EVENT_TO_PROD Up-sell events to other products

STORE_UPSELL_PROD_TO_EVENT Up-sell products to other events

CROSS-SELL EXAMPLES

P a g e | 110


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SUBSTITUTE EXAMPLES

UP-SELL EXAMPLES

P a g e | 111


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

USER-DEFINED WINDOWS – FIELD OVERVIEW

The following is an overview of each of the user-defined tabs.

User-defined Table Description

ATS_Checkout_Windows This is window that will you allow you to display a pop-up after a person checks

out. For example, a survey could be presented

ATS_Dues This is used to manage all dues/subscription processes available in the Online

Marketplace

ATS_Shopping_Cart Store cart data

Coupons This table is used for you to setup all of your available coupons for the online

store

Product_ReviewComment Comments from previously-entered product reviews (Stored on each

commenter’s record in iMIS)

Product_Reviews Online product reviews from customers (Stored on each reviewer’s record in

iMIS)

P a g e | 112


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ATS_Checkout_Windows Tab

The ATS Checkout Window functionality allows web pages to be displayed to the user after the user has

finished the payment and has reached the receipt page of the online marketplace. The web page is presented

as a popup window and displays the content from any URL. This allows for a few scenarios that should cover

most needs, such as surveys for the user, registering at a third party site, or simply running code and closing

the window.

Another feature is to define is the logic to determine who sees the popup window. For example, you may only

want to display a survey once and if the user fills it out, never show it to that user again. This is accomplished

by creating SQL views in that database. With a little creativity, views can be scripted to check if a user has a

particular iMIS activity, or other database entry, such as a survey entry.

All data for ATS_Checkout_Windows will be stored on the record identified in the Store_Settings table under

the ConfigCouponManagerID setting.

IN DETAIL

The first thing that happens once the user has reached the receipt page is that a check is done to see if the

current user qualifies for any of the popup windows that have been defined. The views are listed in a custom

user-defined table called ATS_Checkout_Windows. If any views return the current user’s ID, then the popup

window is shown and the first URL (sorted in the table with a sort order value) is auto-navigated to.

The page that is navigated to can do anything a programmer writes it to do. As mentioned, this could be a

survey or a call to a web service to register the user at another site. The one requirement for pages to be

included in this system is that they must read the URL parameter named retURL and redirect the page to the

value of that parameter when the user submits the page. So in the example of a survey, there will likely be a

submit button. When that button is clicked, the code should save the survey results and then redirect the user

based on the retURL parameter.

When control is returned to the Checkout Window via the above redirect, the code then checks to see if user is

still qualifies for the next URL in the ATS_Checkout_Windows table by using the listed view and seeing if the

user’s ID is in the results. If so, then the process repeats. If not, the popup window is automatically closed.

This leaves the user on the receipt page.

FIELD What it does

Description Ignored by system, use to add a note for staff about what

this window does.

View Name SQL Server view name, view needs to return a set of iMIS

ID’s of the user’s that should see this popup window url.

URL The location of the page to display (or have run). Could be

an internal or external site.

Status Enter ‘A’ for active, any other value will define the status as

inactive. Inactive rows will be bypassed by the system.

Sort Order Number – All rows will be sorted by this entry. URL’s will

be navigated in the order based on this field.

P a g e | 113


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

NOTE: The destination page in the URL field will need to read in the retURL parameter that will be

automatically added to the URL entry. For example, if http://www.google.com is the entry, the system will go

to http://www.google.com?retURL=http://store.atsol.org/store/ modalwindows/checkoutmodalwindow.aspx.

BT_ID The bill to id of the shopping cart

ST_ID The ship to id of the shopping cart

SUBSCRIPTION_TRANS_IDS The transaction ids of any subscriptions purchased at checkout

DONATION_TRANS_IDS The transaction ids of any dues purchased at checkout

ORDERS_IDS The order numbers of any products or events purchased at checkout.

VIEWS

The individual SQL views that determine if a user should see a particular url merely needs to return the list of

eligible iMIS IDs. Your view must have a column named ID but you can alias other ID fields as ID (e.g. select

BT_ID as ID from Name...) For example, to show URL to everyone, every time they checkout, the view could

be defined as select ID from Name where STATUS = ‘A’. Or, to only show users the popup if they haven’t

completed a survey (determined if a ‘SURVEY’ activity exists for the user), the view would look like this select

ID from Name where ID not in (select ID from Activity where ACTIVITY_TYPE = ‘SURVEY’).

http://www.google.com/

P a g e | 114


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE

In this example, the customer is presented with a survey after their purchase:

P a g e | 115


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ATS_Dues Tab

This tab will be used to manage all dues and subscription processes available in the Online Marketplace. The

only entries in iMIS exist on the ConfigDuesMangerID entry in the Store_Settings General Lookup/Validation

table. Please review the Setup in Dues section of this document for further information.

P a g e | 116


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FIELD VALUE What It Does

TYPE JOIN/RENEW/SUB Describes the type of dues

management record this is. Renew

records will be checked first and if a

person cannot renew the system will

look through join records.

JOIN – this is a record that describes

someone who is trying to join.

RENEW – this is a record that

describes someone who is going to

renew their membership.

SUB – this is a subscription record

that is used by the subscription

module of the Online Marketplace.

BILLING_CYCLE A valid billing cycle name

from the iMIS Billing setup

This billing cycle name is the billing

cycle that will be used for this dues

management record to determine

what options a person will see when

going through the billing cycle

START_MEMBER_TYPE Any valid member type or

an Asterisk “*” as a

wildcard. A comma

delimited list of values can

also be used.

When searching for a match of dues

management records the system will

look for a specific match first and if it

cannot find one will look for a

wildcard.

START_BILLING_CATEGORY Any valid billing category

from iMIS or an Asterisk “*”

as a wildcard. A comma


also be used.





wildcard.

START_STATUS Any valid status from iMIS

or an Asterisk “*” as a

wildcard. A comma


also be used.





wildcard.

START_CHAPTER Any valid chapter from iMIS

or an Asterisk “*” as a

wildcard. A comma


also be used.





wildcard.

END_MEMBER_TYPE Any valid member type This is the member type that the

person will have at the end of the

join/renew process.

P a g e | 117


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


END_BILLING_CATEGORY Any valid billing category This is the category that the person

will have at the end of the

join/renew process

END_STATUS Any valid status, usually “A” This is the status that the person will

have at the end of the join/renew

process

END_CHAPTER Not used at this time – for

future use.

ELIGIBLE_TEXT Any text to be displayed on

the join/renew/sub page

This text will display on the dues

page if the person is eligible for the

operation. It can include instructions

on the process or any other

information.

NOT_ELIGIBLE_TEXT Any text to be displayed on


This text will display on the dues

page if the person is not eligible for

the operation. This will come up if

the person matches the dues

management record. For example, if

the person falls into the renew

record but has already renewed their

dues. (e.g., You are not eligible to

renew at this time, please contact

the office for more information.)

IS_COMPANY Checkbox that is checked or

not checked

This indicates that this dues

management record only applies to

company records and that eligibility

will be checked through the

COMPANY_AUTHORIZATION field.

COMPANY_AUTHORIZATION Name of SQL view and is

only applicable if the

IS_COMPANY field is

checked.

This is the name of a SQL view that

should contain two fields. ID and

CO_ID. ID is the ID number of the

person logged in and CO_ID is the

ID number of any company records

that the person is eligible to

join/renew for.

CUSTOMERTYPE_TEXT Any text to be displayed on


This text will display at the top of the

page in situations where the person

is eligible to join or renew for more

than one member type (e.g., a

student can renew as a student

P a g e | 118


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


member or renew as a professional

member)

BILLINGCATEGORY_TEXT Any text to be displayed on


Text that will be displayed if the dues

requires a selection of Billing

Category.

DUESPRODUCT_TEXT Any text to be displayed on


This text will display at the top of the

page in situations where the person

is eligible to choose between multiple

dues products (e.g., DUES_1YR,

DUES_2YR, DUES_3YR)

DUESPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked

If not checked, and only one dues

item is available to the person then

the dues product page will not show

(to select a dues product). However,

if this is checked, then the page will

always show even though there may

only be one option. This is will show

the single line item with the only

option pre-checked.

NUM_COMP_DUES Number Integer field to set the number of

complimentary DUES items.

CHAPTERPRODUCT_TEXT Any text to be displayed on

the chapter selection page

This text will be displayed on the

chapter selection page.

CHAPTERPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked.

If not checked, and only one chapter


the chapter product page will not

show. However, if this is checked,

then the page will always show even

though there may only be one

option. This will show the single line

item with the only option pre-

checked.

CHAPTERPRODUCT_ALLOW_CHANGE Checkbox that is checked or

not checked.

If checked, then the person will be

able to check/uncheck boxes on the

page based on all chapters in the

billing cycle. If the box is not

checked, then only the pre-checked

chapter option will be displayed and

shown.

MIN_CHAPTERS Any number 0 or above This indicates the minimum number

of chapters a person must select on

P a g e | 119


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


the chapter screen. If set to 0, then

no chapter selection is necessary.

MAX_CHAPTERS Any number 1 or above This indicates the maximum number

of chapters a person can select on

the chapter screen.

NUM_COMP_CHAPTERS Number Integer field to set the number of

complimentary CHAPT items.

SECTIONPRODUCT_TEXT Any text to be displayed on

the section selection page


section selection page.

SECTIONPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked.

If not checked, and only one section


the section product page will not

show. However, if this is checked

then the page will always show even




checked.

SECTIONPRODUCT_ALLOW_CHANGE Checkbox that is checked or

not checked.

When checked, allows the person to

change their SEC products during

join or renewal. When unchecked,

they are not allowed to change SEC

products.

MIN_SECTIONS Any number 0 or above This indicates the minimum number

of sections a person must select on

the sections screen. If set to 0, then

no sections selection is necessary.

MAX_SECTIONS Any number 1 or above This indicates the maximum number

of sections a person can select on

the section screen.

NUM_COMP_SECTIONS Number Integer field to set the number of

complimentary SEC items.

MISCPRODUCT_TEXT Any text to be displayed on

the MISC subscription

selection page


MISC subscription selection page.

MISCPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked.

If not checked, and only one MISC


the MISC product page will not

show. However, if this is checked,

the page will always show even


P a g e | 120


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org




checked.

MISCPRODUCT_ALLOW_CHANGE Checkbox that is checked or

not checked.


change their MISC products during


they are not allowed to change MISC

products.

MIN_MISC Any number 0 or above This indicates the minimum number

of MISC subscriptions a person must

select on the MISC screen. If set to

0, no MISC subscription selection is

necessary.

MAX_MISC Any number 1 or above This indicates the maximum number

of MISC subscriptions a person can

select on the MISC screen.

NUM_COMP_MISC Number Integer field to set the number of

complimentary MISC items.

SUBPRODUCT_TEXT Any text to be displayed on

the SUB selection page


SUB selection page.

SUBPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked.

If not checked, and only one SUB


the SUB product page will not show.

However, if this is checked then the

page will always show even though

there may only be one option. This

will show the single line item with

the only option pre-checked.

SUBPRODUCT_ALLOW_CHANGE Checkbox that is checked or

not checked.


change their SUB products during


they are not allowed to change SUB

products.

MIN_SUBS Any number 0 or above This indicates the minimum number

of SUB products a person must select

on the SUB screen. If set to 0, then

no SUB selection is necessary.

MAX_SUBS Any number 1 or above This indicates the maximum number

of SUB products a person can select

on the SUB screen.

P a g e | 121


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


NUM_COMP_SUBS Number Integer field to set the number of

complimentary SUB items.

VOLPRODUCT_TEXT Any text to be displayed on

the VOL selection page


VOL selection page.

VOLPRODUCT_ALWAYS_SHOW Checkbox that is checked or

not checked.

If not checked, and only one VOL


the VOL product page will not show.

However, if this is checked then the

page will always show even though

there may only be one option. This

will show the single line item with

the only option pre-checked.

VOLPRODUCT_ALLOW_CHANGE Checkbox that is checked or

not checked.


change their VOL products during


they are not allowed to change VOL

products.

CRITERIA Name of SQL View Name of SQL View that allows access

to the line in ATS_DUES. See the

Advanced Criteria section for more

information.

PROFILE Name of SQL View This is the name of a SQL view that

will prohibit a person from

completing a dues/subscription

process due to something missing

from their record (i.e. email

address). See the Advanced Criteria

section for more information.

P a g e | 122


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ATS_Payment_Options

This tab is used to configure the enSYNC Online AutoDraft options. See the enSYNC Online AutoDraft section

for full details about setting up and configuring this functionality.


Option_Code Required: Code for payment

option

This is a unique code to identify each

payment option allowed. For

example, 1M would be for 1 payment

per month, 3M would be for

quarterly payments, and so on.

Status A or I Sets rule to active (A) or inactive (I)

Payment_Plan_Header Text Text displayed on top of payment

plan page.

Term_Instructions Text

Explanation for section of current

year dues payment plans offered.

Sort_Order Number Order of display for each payment

option.

Option_Name Text Name of option offered. (i.e.

Monthly, Quarterly, Semi-Annual,

Annual)

Option_Instructions Text Text explaining payment options.

P a g e | 123


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


NOTE: There are 2 merge fields that

can be included with this text:

• ~amount~ -- Amount of each

payment in dollars and cents

• ~numpayments~ -- number of

payments (including current

payment)

Num_Installments Number Number of installments in the plan.

Surcharge_Per_Period Number Surcharge amount added to each

payment.

Surcharge_Product_Code iMIS Dues Product Code This is the iMIS dues product code to

charge a surcharge when someone

selects to do multiple payments.

This is typically a MISC dues item.

Draft_Day Number Day auto-draft will occur.

Product_Code_Restriction Not currently used. For

future development.

Product_Cat_Restriction Not currently used. For

future development.

Member_Type_Restriction Not currently used. For

future development.

Allow_Auto_Renewal Checkbox Check this box to allow for auto-

renew.

Require_Auto_Renewal Checkbox Check this box to require auto-

renewal. Members will be forced to

setup auto-renew.

Renewal_Instructions Text Text displayed at top of auto-renew

section.

Auto_Renewal_Text_Yes Text Text displayed on button for user to

select auto-renew.

Auto_Renewal_Text_No Text Text displayed on button for user to

opt out of auto-renew.

This table will most-likely have multiple rows – each row defines the payment plan offered.

P a g e | 124


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ATS_Shopping_Cart Tab

The ATS Shopping Cart is a utility table used by ATS. It can be used for reporting or research to see who has

what in their carts.

LIST OF THE SESSION DATA STORED:

• Session ID

• Cart Type

• Bill To

• Ship To

• Product Code

• Product Major

• Product Minor

• Product Type

• Fund Code

• Campaign Code

• Appeal Code

• Distribution Code

• Is Kit Item

• Kit Product Code

• Quantity

• Unit Price

• Note

• Dues Term

• Dues Effective Date

• Dues Member Type

• Dues Billing Category

• Tribute Code

• Tribute Text

• Tribute Person

• Session Date

• Date Added

P a g e | 125


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Coupon Tab

Use this tab to manage coupons. The only ID that will use this tab is the ID set on the

ConfigCouponManagerID entry in the Store_Settings general lookup table. Typically, this is the iMIS manager

record.

FIELD What it does

Coupon Code Code to be used in the Online Marketplace by customers at checkout (ie BIG10,

SEPT15). Coupon codes can now be mixed case and are not required to be entered in

all uppercase.

Coupon

Description

Description of coupon that is displayed on the web.

Coupon Category • There are several types of coupons that can be offered:

P a g e | 126


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FIELD What it does

o Dues – Discounts on Dues/Subscription products.

▪ NOTE: Dues coupons are not currently supported with the enSYNC

Online AutoDraft functionality. (See the enSYNC Online AutoDraft

section for more details about this feature.)

o Events – Discounts for event registrations

o Freight – Discounts to freight charges

o Handling – Discounts to handling charges

o Orders – Discounts to order products

o Shipping – Discounts to freight and handling combined. If the coupon is a

percent-off coupon, then the percent off will be taken off both freight and

handling. If the coupon is a dollars-off coupon then the dollars off will be

applied to the freight charge first and then any money remaining to the

handling charge. In addition, in the product code you can enter a freight

method (e.g., UPS) and the coupon will only be valid if the person selects

that freight method. You can use a comma delimited list of freight methods

to apply this to as well (e.g., UPS, FEDEX). If you leave the freight method

blank then the coupon will apply to all freight methods.

o SUB – Discounts to subscription (SUB) products. This can only be used for

subscription-only billing. If combined with other DUES products, use the

DUES category.

• Coupon categories can be combined to create multi-category coupons. Do not add

SHIPPING in conjunction with FREIGHT and/or HANDLING coupons.

Coupon Type Type of discount coupon will apply (Percent or Dollars off).

Coupon Value Number field – Enter the amount or percent off.

Status Status of coupon (Active, Inactive, Pending).

Start Date Date that coupon offer starts.

End Date Date that coupon offer ends. NOTE: The current date has to be LESS than the coupon

end date. So, a coupon with an end date of 11/1 will not be able to be used on 11/1.

Single Use Per

Person

Can a person only use this coupon once? Check box for yes.

Is Coupon

Stackable

Can this coupon be combined with other coupons?

Restricted to

Member Types

List of member types that can use this coupon. List member types separated by a

comma. NOTE: Do not put spaces between the commas when listing more than one.

Restricted to

Product List of product codes this coupon is restricted to. Do not put spaces between the

commas when listing more than one.

Wildcards: An asterisk (*) is allowed as a wildcard. Information and Examples:

Events: When restricting to an event you must list the Event Code/Function Code.

o Event_Code/* - Allows the coupon to be used for any function within the

designated event (i.e. AM2015/*)

P a g e | 127


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FIELD What it does

o */Function_Code – Allows the coupon to be used with any event that uses

the designated function (i.e. */REG_MAIN)

o NOTE: When using a wildcard on an event if you have a dollars-off coupon

and enter AM2019/* for the restriction, each function will be reduced by that

amount. Percent-off works the same way but each function is reduced by

the percentage.

Dues: List each dues product code unless the coupon is for chapters. Chapters must

have the product type (CHAPT) listed as well.

o CHAPT/* - Allows coupon to be used for any chapter product.

Orders: List each product code

o PRODUCT_CODE* - Allows any product(s) that start with the same

characters to be used with the coupon. (i.e. BOOK* or DUES*)

Shipping – List each shipping method to restrict a coupon to a specific ship method

o UPS* - Allows for a coupon to be used with any ship method that begins

with UPS

Freight - List each shipping method to restrict a coupon to a specific ship method

o UPS* - Allows for a coupon to be used with any ship method that begins

with UPS

Handling – Wildcards not available with Handling coupons.

SQL View – Enter the name of the SQL view that identifies which product(s) the coupon

can be applied against. The view must contain a column named PRODUCT_CODE and

have one row per unique product code.

Restricted to

Product Cat

List of product categories this coupon is restricted to.

Coupon Product

Code

Not Used as of September 2012. If your version of the Online Marketplace is prior

to September 2012 you will enter the name of the product, setup in Orders, for

Coupons.

Product Type Not Used

Maximum Uses

Per Product Code

Maximum uses per order for this coupon.

• If the value is set to 0 there is no limit.

• If the value is set to a number greater than 0 you will only be able to buy that many

(quantity) of products that match the restrictions (product category and product

code).

• The discount (dollars off or percent off) will be applied to the most expensive

eligible products first.

• Sometimes rounding will need to occur to have the order put into iMIS correctly. For

example, if you purchase a book and get $10 off but purchase 3 books, the unit

P a g e | 128


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FIELD What it does

price of all books needs to be adjusted and therefore the person may get $10.01 off

instead of $10.00 off.

o 3 Books @ $10 each

1 coupon for $10.00 off one book

o Results in 3 books for a total of $20.00 or $3.33 off per book. Meaning each

book is $6.66 each for a total charge to the customer of $19.98 or ($10.02

discount)

Maximum Orders Maximum number of orders for this coupon (i.e. First 50 orders get this offer).

Times Used So

Far

This field is automatically updated by web orders but can be manually advanced for

iMIS Desktop orders. NOTE: This field will only automatically update if you set a

maximum in the ‘Maximum Orders’ field.

Coupon Batch

Code

User-assigned batch code from the Coupon Generator

User Field 1 Tracking Code 1

User Field 2 Tracking Code 2

Source Code Used to identify coupons created in the Coupon Generator

Ship To ID

Restriction

This field can be used in two different ways to restrict a coupon

ID: Enter ID number(s) of records that the coupon is restricted to. Enter multiple ID’s

separated by a comma and no space.

SQL View: Enter the name of a SQL view to this field that selects the ID’s that are

eligible to use the coupon. This can be very powerful in that you can really write your

own rules for coupon usage.

This screenshot shows where your customers will enter the coupon code in the checkout cart.

P a g e | 129


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 130


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

COUPON GENERATOR

The Online Marketplace

includes a coupon

generator for creating

groups of coupons in

mass. This tool is in the

Administrative Portal.

To access the Administrative Portal go to <YourStoreURL>/store/admin/storeadmin.aspx (i.e.

http://www.atsol.org/store/admin/storeadmin.aspx). If you are not already logged in you will be taken to a

login page. Once logged in, any user with the ATSStoreAdmin Access Keyword will be directed into the

administrative portal. Click on the Maintenance tab, then Coupons and Coupon Generator to access the screen

to create coupons.

NOTE: This is not recommended for creating single coupons, but for creating many coupons at

one time.

http://www.atsol.org/store/admin

P a g e | 131


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ADDITIONAL FIELDS IN THE COUPON GENERATOR:

• Coupon Count – Number of coupons to create.

• Coupon Generation Method – Method for naming coupons.

P a g e | 132


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLES OF COUPON GENERATION METHODS:

STATIC VALUE

Select this option to assign the same code

to all coupons.

View in iMIS:

P a g e | 133


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

RANDOM ALPHA NUMERIC

Provide a length for the

coupon code in the Coupon

Length field.

Results:

P a g e | 134


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

View in iMIS:

P a g e | 135


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SEQUENTIAL WITH MASK

Provide a starting sequence

number, sequence length,

coupon prefix and suffix.

NOTE: The maximum

length for a Coupon

Code is 11. This

includes Sequence

Number, Prefix and

Suffix.

P a g e | 136


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Results:

P a g e | 137


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

View in iMIS:

P a g e | 138


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Product Review Tab

This tab stores all product reviews as they are entered by customers on your site.

• PRODUCT_CODE – Product code of reviewed store item.

• RANK – 1 through 5 review ranking.

• TITLE – Title of review.

• DESCRIPTION – Actual text review.

• REVIEW_DATE – Date/time of review.

You must be logged in to review products:

P a g e | 139


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Once logged in you can review any

product

The review is stored on the

ID number of the person

who entered the review in

the Product Reviews tab.

P a g e | 140


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Product Review Comment Tab

This tab stores all product comments as

they are entered by your customers.

• REVIEW_SEQN – Sequence number

of the review this comment is for.

• COMMENT – Comment text.

• COMMENT DATE – Comment

date/time.

• HELPFUL – Was this helpful (1 for

yes, 0 for no).

• PRODUCT_CODE – iMIS product

code that was reviewed.

Your customers will be able to add

comments to reviews once logged into

the Marketplace.

Comments are stored on

the customer’s record

under the Product Review

Comments tab.

P a g e | 141


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ACTIVITY SETUP

The Online Marketplace uses activities for some functionality. Those activity types are: BO_EMAIL,

CONFLETTER, Coupon_Use, Donation, Promotion and SHIPPING activities. Activity Types are setup on

install/upgrade.

BO_EMAIL

This activity type is used to store backorder information when a customer would like to purchase an item that

is not in stock.

The customer will see that

the product is out of stock

and have the ability to enter

their email address for

notification when inventory is

available.

P a g e | 142


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Once you add inventory to the product you can pull a list of each person with the BO_EMAIL activity and the

desired product to notify them that it is now available.

The BO_EMAIL activities are stored on the Anonymous record if the person isn’t logged in. If they are, it will

be stored on their record.

P a g e | 143


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CONFLETTER

The purpose of this

activity record is for

storing confirmation

letters from the Online

Marketplace

confirmation letter

system. These

activities will be

automatically generated

from the Confirmation

Letter feature and

stored in the Store

Manager record in iMIS.

P a g e | 144


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

COUPON_USE

The purpose of this activity record is to log each time a user uses a coupon when checking out of the Online

Marketplace. These activities will automatically be created on the purchaser’s record in iMIS.

As your customers use coupons, a COUPON_USE activity will be created on their record. If a person registers

someone else or pay’s someone else’s dues the COUPON_USE activity will be written to the ID of the person

that did the registration or paid the dues but the ID of the registrant or member will be stored in the UF_3

field of the activity.

P a g e | 145


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 146


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

DONATION

In order to report on the

tribute selections users

make, there will be activities

created for each donation

that has a tribute.

Sample Donation Activity:

P a g e | 147


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PROMOTION

The purpose of this activity is

to create entries for

promotional ads. They can be

used for association ads on the

website or can also be created

for ad sales to manage online

ads.

Once this activity is setup, you

will create different

PROMOTION activities that

contain specific information for

your ads. For association-

specific ads, you will use one

Store Manager ID (designated

by you) to store all of these

activities. Below is an

explanation of each field:

• Description – Enter a description of your ad

• Start Date – Start Date of the ad running

• End Date – Date ad will stop running

• URL – URL to ad

• ImageURL – URL to the image for your ad

• IsFillerAd – If this field is set to 1 then it is a filler ad, if it is set to 0 then it is NOT a filler ad

• IsPopupAd – If this field is set to 1 then the ad will open in a new window

P a g e | 148


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE

Here is an example of what the activity will look like on your designated record in iMIS:

Promotions display in the top product bar in the Marketplace.

P a g e | 149


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SHIPPING

The SHIPPING activity will allow you to manually create Activities on records to allow a customer to track the

shipment of their order(s). Once a SHIPPING activity is added to a record with the carrier, tracking number,

order number and date they will be able to click and track their shipment from the ‘View Previous Orders’

page. Currently, only DHL, FedEx, UPS and USPS are supported.

EXAMPLE ACTIVITY:

P a g e | 150


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

VIEW PREVIOUS ORDERS PAGE:

P a g e | 151


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SETUP IN AR/CASH

Credit Card Types

The credit card types listed in “AR/Cash” >> “Set up module” are the types that will be available in the

shopping cart.

P a g e | 152


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Batch Control

Enable Batch Control – Batch Control in iMIS must be turned on.

1. AR/Cash>>Set up module>>Batch Control

2. Click Edit and selection the batch naming option you prefer

3. Click Save

Terms

If a record has a different payment term than the default payment term setup in AR/Cash the term on the

individual’s record for Orders only.

Payment Type Labels

The labels for payment types are configurable with the following settings in the Store_Settings general

lookup table.

Code Description (Values) What it does

P a g e | 153


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PaymentTypeACHLabel

Text

Default: Electronic

Check/ACH

Label for electronic check/ACH


payment screen

PaymentTypeAdminLabel

Text

Default: Administrator

Options

Label for staff-only administrator

option payment type displayed

on payment screen

PaymentTypeCCLabel

Text

Default: Credit Card

Label for credit card payment

type displayed on payment

screen

PaymentTypeGlobalPaymentsLabel

Text

Default: Global Payments

Label for Global Payments


payment screen

PaymentTypePayPalExpressLabel

Text

Default: PayPal Express

Label for PayPal Express


payment screen

PaymentTypePurchaseOrderLabel

Text

Default: Purchase Order

Label for purchase order


payment screen

Below is a screenshot of how the payment type labels display on the payment page (screenshot does not

include PayPal Express or Global Payments).

P a g e | 154


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PayPal Express Setup

The Online Marketplace supports payment via PayPal Express. This section explains the setup to enable this

feature.

STORE_SETTINGS

There are several Store_Settings for PayPal Express:

• lblPayPalExpressItemDescription – This is a description that will display in the Item Description in

the PayPal Order Summary. It cannot itemize the items from the cart.

• lblPayPalExpressOrderDescription – This description is used for where the order came from. For

example, ‘ABC Association Checkout’.

• PaymentPayPalExpress – True/False setting. When set to True, PayPal Express payment is

enabled.

• PaymentPayPalExpressButtonText – Text that displays for customer to select PayPal Express

payment type.

• PaymentPayPalExpressNote – Note displayed after customer selects PayPal Express payment type.

SETUP IN CREDIT CARD AUTHORIZATION

A new credit card authorization account will also need to be setup in iMIS for your PayPal Express account.

1. AR/Cash>>Set up module>>Credit Card Auth

2. Click New to setup a new gateway

a. Gateway: Custom

b. Select Immediate Authorization

c. Account Code: PAYPALEC

d. Account Description: PayPal Express Checkout

e. Administrator’s Email: Email address on your PayPal Express account

f. Partner: leave blank

g. Host URL: www.sandbox.paypal.com (test transactions) or www.paypal.com (live transactions)

h. Host Port: 0 or leave empty

i. Vendor: API Signature for your PayPal account

j. Username: API Username for your PayPal account

k. Password: API Password for your PayPal account

l. Timeout: 0 or leave empty

m. Proxy Server Address: leave empty

n. Proxy Server UserId: leave empty

o. Proxy Server Port: leave empty

p. Proxy Server Password: leave empty

q. Verify Proxy Server Password: leave empty

r. Click Save

http://www.sandbox.paypal.com/

http://www.paypal.com/

P a g e | 155


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CASH ACCOUNT SETUP

You’ll need to setup a cash account for PayPal Express.

1. AR/Cash>>Set up tables>>Cash accounts

2. Click New

a. Code: PAYPAL

b. Title: PayPal

c. Type: Credit Card

d. Account: Desired GL account code

e. Entity: Desired entity code (optional)

f. CC Auth Account: PAYPALEC

g. Click Save

P a g e | 156


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CHECKOUT

As your customers check out they will select PayPal Express as the payment type:

After clicking the PayPal Express Checkout button (configurable with Store_Setting

PaymentPayPalExpressButtonText) they will be directed to the PayPal checkout

P a g e | 157


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Customers are then re-directed back to the Online Marketplace and displayed the receipt.

P a g e | 158


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PayPal TeleCheck Setup

The Online Marketplace supports payment via PayPal TeleCheck. This section explains the setup to enable this

feature. You need to make sure your PayPal account includes this feature as well. Check with PayPal to verify

this is part of your account setup.

STORE_SETTINGS

There are several Store_Settings for PayPal Express:

• PaymentACH – True/False setting. When set to True, customers are allowed to pay by electronic

check.

• PaymentACHNote – Text note that displays on payment screen after selecting ACH payment type.

• PaymentACHShowCheckImage – True/False setting. When set to true, displays an informational

image of a check for completing ACH (electronic check) payment (account number, routing

number, etc.).

• PaymentTelecheckType – 1 or 2 – Your PayPal Telecheck account type will be 1 or 2.

o Type 1 accounts process transactions as a Sale

o Type 2 accounts process transactions like credit card transactions (Authorization, Delayed

Capture/Void). See the Credit Card Processing section for details.

CASH ACCOUNT SETUP

You will need to setup a cash account in iMIS for processing electronic checks. It must be a ‘credit card’ type

account that points to your PayPal processor.

BATCH_SETTINGS

Batch_Setting that control ACH payments will also need to be configured. Those settings are:

• BatchCashAccountCheck – Name of the cash account in iMIS used for Online Marketplace ACH

payments. This must be a cash, cash account.

• CashAccountCheck – Name of the cash account in iMIS setup for ACH payments. This must be a cash,

cash account.

• CashAccountCheckProcessor – Name of the cash account in iMIS setup for ACH payments. This must

be a credit card cash account linked to your payment processor.

P a g e | 159


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PAYMENT SCREEN EXAMPLE:

NOTE: The Drivers License Number field requires the entry to be state code with the number and no

dashes or spaces. ATS recommends you use the PaymentACHNote entry in the Store_Settings general

lookup table to display a note on this page explaining this requirement.

Staff Only Payment Options

This functionality allows staff who use the impersonate functionality in the Online Marketplace to select a

specific cash account and optionally a specific batch at checkout. The payment is processed as a check and

the transaction shows as paid in iMIS. This is typically used in a lockbox situation where the organization has

already received the payment through the bank.

Additionally, staff will also have the option to enter a purchase order for a product or registration when the

PaymentPurchaseOrdersEvents and PaymentPurchaseOrderOrsders Store_Settings are set to false for

customers.

NOTE: Staff must impersonate the customer through the administrative portal for this feature to appear,

once enabled.

STORE_SETTINGS

There is only one Store_Setting:

• PaymentAdminOptions – True/False setting. When set to True staff will have the option to select a

specific cash account at payment time.

P a g e | 160


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

STORE_ADMIN_PAYMENT_OPTIONS

This general lookup table contains the codes of the cash accounts you want available for these transactions.

It is required that these are all ‘cash’ cash accounts and not credit card cash accounts. See the Tables:

Store_Admin_Payment_Options section for detailed information about setting up this table.

When impersonating a customer in the Online Marketplace the staff member will be presented with an

Administrator Options radio button on the payment screen that allows them to select one of the cash

accounts from the Store_Admin_Payment_Options general lookup table. The batch created will use the cash

account selected and the transaction will be recorded as paid in iMIS.

In addition, you can set a specific source code for these transactions using the

ConfigAdminPaymentSourceCode entry in the Store_Settings general lookup table. This is the source code

that will be used on an order when using the administrative payment options. The source code must be a

valid source code in the SOURCE_CODE general lookup table in iMIS and is defaulted to WEB. See screenshots

on the next page.

P a g e | 161


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Example Payment:

1. Select Administrator Options

2. Select Cash Account

3. Select Batch (Optional)

4. Enter check number or note in the Note field.

P a g e | 162


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Blue Pay Payment Gateway

The Online Marketplace supports usage of the CCS and enSYNC Blue Pay dlls in the ATS Online Marketplace.

Each gateway should be setup per the instructions from each respective company. The ATS Online

Marketplace does NOT include the respective dll files or entries in the config files.

In general, this will likely require

• Placement of the Blue Pay dll(s) into the Bin folder of the ATS Webservices. Remember that these

should be backed up somewhere. They may be deleted during an upgrade to the ATS Online

Marketplace and will need to be replaced for Blue Pay to work in the store.

• Placement of additional line(s) in the ATS Webservices web.config. These are typically entries in the

PaymentGatewayServices section.

• Placement of additional entries in the ATS Webservices appsettings.config. There may be some

entries required for error trapping or configuring the dll.

When using these alternative gateways you will need to make sure that your gateways are properly setup in

iMIS.

BLUE PAY ACH

ACH payments through Blue Pay are supported in the Online Marketplace. The following entries in the

Store_Settings general lookup table will need to be configured.

• PaymentACHProvider

o PAYFLOWPRO (Default) – This is PayFlow Pros’s implementation of ACH that uses Telecheck.

Based on the value of PAYMENTTELECHECKTYPE, this will either be handled as a SALES

transaction or an Authorize/Delay capture transaction.

o AUTHORIZE.NET – This is Authorize.NETs implementation of ACH. This uses an Authorize/Delay

capture solution and can void transactions when iMIS fails.

o BLUEPAYENSYNC – This is the setting to use for BluePay when using the AISP enSYNC’s Blue

Pay Integration. This only supports a SALES transaction at this time. It will void transactions when

iMIS fails

• PaymentACHTestMode

o True/False – when set totru, ACH requests will be sent to the provider in test mode. This only

applies to Blue Pay enSYNC.

P a g e | 163


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SETUP IN ORDERS

The Web Order Type under Orders>>Set up module>>Web must be set to PF. PF is a pro-forma order type

that is set on all web orders. They are then converted to regular orders using the iMIS desktop.

Where Product Information Displays

The following example will show you where some of the fields in iMIS displays in the Online Marketplace.

Most of the fields in the Manage Inventory window are can be displayed using the ‘Show’ entries in the

Store_Settings General Lookup/Validation table. Also, the labels displayed for each field are configurable using

the ‘lbl’ entries in the Store_Settings General Lookup/Validation table.

P a g e | 164


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Freight by Weight - United States Shipping Setup

This section only applies if you use Freight by Weight for freight determination. Additionally, depending on

how countries are stored in iMIS will drive how zone tables are setup.

Country On Customer Record Country on Zone

Blank Blank

United States United States

USA USA

Zone Table Setup (Orders>>Set up tables>>Zones)

Store_Settings

Code Description What it does

ConfigDefaultCountryDatabas

e

Typically left

blank for US

customers – see

note.

The value in the Country table for the default country.

This is used for freight. For many clients in the United

States, this is blank and therefore they need to leave it

blank in the db.

ConfigDefaultCountryDisplay

Example: USA Value to display for the default country in the database.

For example, they may set the

ConfigDefaultCountryDatabase to blank but set the

ConfigDefaultCountryDisplay to “United States”.

Whatever value they use will be displayed in the

dropdown of the country table when calculating freight.

The Store_Shipping_Methods general lookup table will be where you indicate which of your shipping methods

are allowed in the Online Marketplace. Types must exist in the iMIS standard general lookup table

Ship_Method.

P a g e | 165


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Multi-Warehousing

The Online Marketplace does support iMIS Multi-Warehousing functionality. See the Section ‘Table:

Store_Warehouses’ for specific information.

Shipping Tracking

The Online Marketplace can track shipping through SHIPPING activities that are manually added to iMIS

customer records. See the Section ‘Activity Type: SHIPPING’ for specific information.

Stored-Procedure Pricing for Products

The Online Marketplace is setup to allow for stored-procedure pricing on products. Your stored procedure can

contain the following parameters. Any parameters that you specify will be sent by the Online Marketplace to

your stored procedure.

Parameter Name Description

@PRODUCTCODE This is the product code of the item

@BTID This is the Bill to ID of the shopping cart

@STID This is the Ship to ID for the item being purchased

@QTYINCART This is the quantity of this item in the cart. It could also be acquired through SQL in

the stored procedure.

@QTYTOORDER This is the quantity of this item that the person would like to order. Currently always

1

The stored procedure needs to return a single price. That price should be rounded to two digits.

Stored procedures need to include up to 3 parameters and must be used in this order:

4. Price – the unit price to charge the person for the product.

5. OrderLineNote – note that will be stored in the Order_Lines.NOTE field.

6. DescriptionSuffix - text that will be appended to the Order_Lines.DESCRIPTION. It will appear on the

receipt and in iMIS (e.g. ‘Half Off’).

For example, you create a stored procedure to give only students a discount on a particular book. You could

use the Order_Lines.NOTE to trigger a Task Centre task.

If you only use one parameter in your stored procedure it will be the price, if you two it will be price and

‘reason’ and if you use three it will be price, ‘reason’, ‘description’.

Example Stored Procedure:

P a g e | 166


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CREATE PROCEDURE [dbo].[sp_HalfMemberPrice_Reason_Description] @PRODUCTCODE VARCHAR(31) AS select price_1 * .5, 'Half_Price', ' (Half Price)' from Product where PRODUCT_CODE = @PRODUCTCODE GO

CREATE THE GENERAL LOOKUP TABLE

First you must create the General Lookup table called STORE_PRODUCT_SP_PRICING.

• Stored procedure pricing for products can be defined for all products using a “DEFAULT” value or on a

product by product basis.

• For each product that you want to execute a stored procedure, enter the product code as the CODE in

the general lookup table. The Description should be the name of a stored procedure to be executed to

calculate the price.

• If there is not an entry for a product code, the Online Marketplace will look for a code of DEFAULT. The

entry of DEFAULT will be used for all other products that do not have individual lines for the product

code. If there is no DEFAULT entry, then no stored procedure pricing will be calculated for the product.

P a g e | 167


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE OF A SIMPLE STORED PROCEDURE:

This example will calculate the product price at half of the Member Price.

SET ANSI_NULLS ON

GO


GO

CREATE PROCEDURE [dbo].[sp_HalfMemberPrice]

@PRODUCTCODE VARCHAR(31)

AS

select PRICE_1 * .5 from Product where PRODUCT_CODE = @PRODUCTCODE

GO

HOW PRICING IS DISPLAYED FOR STORED-PROCEDURE PRICING PRODUCTS:

In the Online Marketplace you can define three types of pricing to display. Each of these can be shown or

hidden based on store settings.

1. Member Price: Determined by the Member Price field as entered in the Manage Inventory screen.

2. Nonmember Price: Determined by the Non-Member price field as entered in the Manage Inventory

screen.

3. Your Price: If you have stored procedure pricing setup as described earlier, that is the price that will

show up in the Your Price field. Otherwise, the system will look at the currently logged in user (or

anonymous user if you are not logged in) to display in the Your Price field. Your Price is always the

price that is put into the cart.

Purchase Orders

Starting with iMIS versions 15.2.5 and higher you can allow your customers to pay for an order by purchase

orders. The PaymentPurchaseOrderOrders setting in the Store_Settings General Lookup/Validation table

controls this. To enable purchase orders set this setting to true.

P a g e | 168


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PDF Watermarking & Security

PDF Watermarking functionality allows you to watermark

electronic PDF files that are available in your Online

Marketplace. There are two settings in the Store_Settings

table that control this:

• ShowWatermarkPDFFiles: This is a True/False

setting to turn on or off this feature. Setting this

to true turns it on.

• lblWatermarkCopyrightStatement: This is the

statement that will print along with the

customer’s name, company, order number and

order date.

NOTE: Watermarks cannot be applied to any

encrypted PDF.

See an example to the right:

PDF SECURITY:

These are the Store_Settings for assigning security to PDF’s.

PDFSecurityEncryptionSiz

e

40 or 128

Size of encryption key for PDF security.

PDFSecuritySecure True – Enables PDF Security

False – Not enabled

PDFSecurityOptions Sets the values of the PDF security settings. Those that are included are set

to TRUE, otherwise they are set to false. This is a string and can be comma

delimited.

NOTE: PDF files cannot have any pre-existing security applied to them for

this feature to work.

Valid Values:

• CANCOPYCONTENT - Can copy the document content. • CANEDITCONTENT - Can edit PDF document content. • CANFILLFORMFIELDS - Can fill the form fields. • CANPRINT - Can print the document.

P a g e | 169


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

• CANEDITANNOTATIONS - Can edit PDF document annotations.

PDFSecurityOwnerPassw

ord

Password that will be applied to PDF’s for security. It will be required to

change OWNER options of the rendered PDF.

PDFSecurityUserPasswor

d

Password that will be applied to PDF’s for security. It will be required to

change USER options of the rendered PDF.

P a g e | 170


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Newest Items

There is a section on the Online Marketplace homepage to display newest items. Newest items are

determined by the Publication Date set on the product in the Publication demographics window. The

Store_Settings ShowNewestTab (turns on Newest tab) and LblNewestTab (label for Newest tab) control this

feature.

From Orders>>Manage Inventory select

the desired product and click the

Publication button. Note: To enable the

Publication button you must check the

‘Use Publication Demographics’ box on

the item’s category under Orders>>Set

up tables>>Product categories.

Newest Tab:

P a g e | 171


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Web Categories

The Online Marketplace supports iMIS web categories. There are two Store_Settings that control this.

1. ShowProductWebCategoriesList – When set to true the Product Category section in the right gutter

switches to a tree-like view using the iMIS web categories and disables the use of the category search

by the category set on the product.

2. ShowProductWebCategoriesLevel – This number determines the number of levels expanded in the

category tree by default.

Prior to iMIS 20.2 web categories can be managed in the iMIS Desktop under System Setup>>Set up

commerce web components>>Store home.

We have created an interface in the Online Marketplace Administrative Portal for managing web categories

since the interface in the iMIS Desktop was removed in version 20.2. To access this interface go to your

administrative portal and under Products>>Products Audits and Tasks>>Manage Web Categories:

Tab Description:

P a g e | 172


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Information: Brief description of this functionality.

Add New Category: Add new web categories.

Manage Category Products: This is where you add or remove products from each category by selecting a

category from the tree above and using the arrow buttons to move from ‘Products not in Category’ to

‘Products in Category’. There is a checkbox to include inactive products if needed.

Edit/Update Category: Lets you update category title, description or online status.

P a g e | 173


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Deleting a Category: If a category has no products assigned to it, it is eligible to be deleted in the Edit/Update

tab. The delete button displays in this scenario.

Reports: Contains on listing of products not in a category

NOTE: There is limited functionality to re-order the web categories by dragging and moving them up or down.

P a g e | 174


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

How Products are Displayed

This describes how products are displayed based on the product status and web setting:

Status Web Option Description

Active Not on Web Will not display on store, message states: product not found

Active View on Web Will display, but cannot add to cart

Active Sell on Web Displays and can add to cart

Inactive ANY Will not display on store, message states: product not found

Order Processing in iMIS

Here are the steps you’ll need to follow in iMIS to process your orders that come from the web. All orders first

appear in iMIS as a Pro Forma or Quote. These quotes will need to be converted to Orders to finalize

processing and create transaction records.

1. Review and Post Batches

a. Transaction records are not written in iMIS until batches are posted

i. AR/Cash>>Manage Batches>>Highlight Batch

1. Click Print Selected to review the batch entries

ii. After reviewing your batch, select Post Selected to post your batch

2. Convert Quotes to Orders – All orders will come into iMIS as Quotes and will need to be converted to

orders.

a. Orders>>Process Orders>>Print Quotes

i. Highlight desired quotes and click the Convert button

ii. This will print the quotes to the screen. You don’t need to print them just close the

report

iii. NOTE: If you don’t need this stage for other quotes, you can go to Orders>>Set up

module>>Order Staging and uncheck the ‘Print Quote’ box under Pro Forma Orders and

then this step is eliminated.

b. Orders>>Process Orders>>Convert Quotes

i. Highlight desired quotes and click the Convert button

3. Once orders have been converted you can then move them through the stages needed (as setup in

your iMIS database for the order type)

a. Orders>>Process Orders

i. Print Pick Lists

ii. Print Shipping Papers

iii. Ship Orders

iv. Invoice Orders

P a g e | 175


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

REAL-TIME UNITED STATES POSTAL SERVICE FREIGHT PRICING

(ADD-ON MODULE)

This is an add-on module to the Orders Marketplace for calculating USPS real-time freight pricing. You must

be licensed for this from ATS in order to use this functionality. Currently, the following ship methods have

been configured:

• USPS (12 ounces or less)

• USPS Priority Flat Rate Envelope (less than

4 pounds)

• USPS Priority Flat Rate Box (less than 70

pounds)

• MediaMail (less than 70 pounds)

• International Flat Rate Priority Box (less

than 20 pounds)

• International Flat Rate Priority Envelope

(less than 4 pounds)

International limits can vary by country.

Note: To request another ship method, please submit an enhancement request by sending an

email to [email protected].

You will need to obtain a license from the USPS to use their web tools. You can do this here:

https://secure.shippingapis.com/registration/. Make a note of the UserId they assign you.

https://secure.shippingapis.com/registration/

P a g e | 176


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Setup the Shipping General Lookup Tables

You will need to add a few General Lookup/Validation tables for this feature of the Online Marketplace.

TABLE: SHIP_METHOD

This standard iMIS General Lookup table

must contain a list of all shipping

options in iMIS (Desktop and Online).

The code field should specify the

abbreviated name of the shipping

method while the description field

should specify the full name of the

shipping method.

TABLE: STORE_SHIPPING_METHODS

Be sure that all of your online shipping

methods are listed here. This allows

you to have other methods for only iMIS

desktop processing. A list of all

accepted shipping methods can be

found in the SHIP_METHOD General

Lookup table (find this entry in the drop

down list), along with their accepted

abbreviated name. Only include shipping

methods that are available to web

users, and be sure that the abbreviated name is typed correctly.

P a g e | 177


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: STORE_USPS_EXTERNAL_SETTINGS

These are the settings that

communicate with USPS.


SHIPFROMZIP Origination Zip Code Zip code you are shipping from

USERID UserID given to you from

USPS

Tells the USPS who you are

USE_EXTERNAL_USPS True or False True – Enables US shipping rate calculations

False – Does not enable US shipping rate

calculations

USE_EXTERNAL_USPS_INTL True or False True – Enables International shipping rate

calculations

False – Does not enable International shipping

rate calculations

TABLE: STORE_USPS_INTL_SHIP_METHODS

International Setup for USPS:

CODE Description

(values)

What it does

USPS_PRIORITYMAILINTERNATIONALFLATRATEBOX_CODE USPS_FIFRB Code used for Int’l Priority

Flat Rate Box

USPS_PRIORITYMAILINTERNATIONALFLATRATEENVELOPE_C

ODE

USPS_PIFRE Code used for Int’l Flat Rate

Envelope

P a g e | 178


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: STORE_USPS_SHIP_METHODS

US setup for USPS:


MEDIAMIALW MEDIAMAIL Code for MediaMail

USPSW USPS Code for USPS First Class Parcel

USPS_PFLEW USPS_PFLE Code for USPS Priority Flat Rate Envelope

USPS_PRIOW USPS_PRIOR Code for USPS Priority Flat Rate Box

TABLE: STORE_USPS_MAX_WEIGHT

This table allows you to set a maximum weight

restriction for a ship method. This shipping method will

not appear in the cart when an order is over this

maximum weight. The Code in this table refers to the

Ship Method and the Description is the weight in pounds

(partial amounts are allowed such as .50). This code

must already exist in either the

STORE_USPS_INTL_SHIP_METHODS or the

STORE_USPS_SHIP_METHODS table.

NOTE: For USPSW the weight of the order must be 12 ounces or less.

P a g e | 179


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SETUP IN EVENTS

Event Functions

ATS has designed the following function prefix codes to allow functions to display differently. These prefixes

are added to the registration function codes. For example, instead of using MAIN for your Main Registration

you would now use REG_MAIN.

REG_ FUNCTIONS

Functions with the REG_ functions need to have a Sort Sequence below 1000, will be displayed with radio

buttons, and the registrant can only select one. At least one of these is required.

QUESTION FUNCTIONS

You can also create questions directly in the staff site that display in the Online Marketplace. Creating

questions in the staff site is the preferred method.

QSTO_

Function displays a textbox under the description and filling out the textbox is optional; prefix is shorthand for

"question optional".

P a g e | 180


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

QSTR_

Function displays a textbox and is required. Required functions can display with a different color.

CHECKBOX FUNCTIONS

Please note that you cannot use these prefixes if your registrants can select more than one of a function. This

is basically a yes/no option.

CBXO_

Function displays a checkbox next to the description and the checkbox is optional.

CBXR_

Function displays a checkbox and the checkbox is required. Required functions can display with a different

color.

INFORMATIONAL FUNCTIONS

NFO_

Function is an information only item. This is useful for displaying messages and notices. This does not show

date and time. NOTE: MEMO Functions also function like NFO_ Functions.

NFOT_

P a g e | 181


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Function is an information only item. This is useful for displaying messages and notices. This does show date

and time.

EMERGENCY CONTACT FUNCTION

EMRG_

Function will display emergency contact text boxes for the user to fill out. NOTE: This data can only be

saved in user-defined fields designated in the app_settings file and is the same for each event. It is

recommended that you use a QSTO_ function for this purpose.

P a g e | 182


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

GROUP FUNCTIONS

GRPR_[CODE]

Function displays as a group label, with a selection from the group being required. Functions following this

function will be considered a group if their function code starts with [code]. For example, GRPR_BRK01 would

define a group, with the title being displayed as the label. Functions following this that start with BRK01_

would be part of that group; i.e. BRK01_SES01 and BRK01_SES02.

GRPO_[CODE]

Function displays as a group label, with a selection from the group being optional. Otherwise, it works like

GRPR_.

When deciding what codes you will use for your groups keep in mind that any other function(s) that start with

that same letter or code will be included in your group. We recommend at least 3 characters. For example, if

you create a GRPO_A function for your ‘A’ sessions and then follow with functions A_1, A_2, A_3 any other

function code that starts with the letter A would be included in that group so it might be better to use a

naming convention like this: GRPO_ASSESS with following functions of ASSESS_1, ASSESS_2, ASSESS_3.

P a g e | 183


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

NOT USING FUNCTION PREFIXES

If you decide not to use the prefixes as described above your functions will display on the web if the ‘Show

this function on the Web?’ box is checked. However, not using the prefixes means that the functions will not

follow the same rules. For example, you can create a function called MAIN_MON and give it a Sort Sequence

of 100 and it will display in the Main Registration section but it will not function like other functions with a

REG_ prefix where only one of that type can be selected. You can auto-select a function by checking the

Automatic Option box in iMIS.

USING YOUR OWN FUNCTION PREFIXES

If your organization already uses a different function prefix naming schema you can override the Online

Marketplace settings by using the Store_Event_Function_Prefixes General Lookup table.

This table allows for the use of pre-defined function prefixes to function like ATS Function Prefixes. The

description is a comma delimited list of your custom functions that will have the same functionality as the one

in the CODE. See the ‘Setup in Events’ section of this document for an explanation of all ATS Function

Prefixes.

P a g e | 184


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

PRE-REQUISITE FUNCTIONS

The General Lookup table STORE_EVENT_FUNCTION_PREREQ contains entries for function(s) and which

function a person must sign-up for before they are able to register for that function.

Example

Your event (DMAANNUAL) has the following REG_ functions defined:

• REG_MAIN – full conference registration

• REG_MON – Monday-only registration

• REG_TUE – Tuesday-only registration

• REG_WED – Wednesday-only registration

You have a Welcome Reception that will be held on Monday (Function Code: XTRA_BANQ) and you only want

people who have signed up for REG_MAIN or REG_MON to see that function. The entry in the

STORE_EVENT_FUNCTION_PREREQ table would look like this:

• Code: DMAANNUAL/XTRA_WELCOME

• Description: REG_MAIN,REG_MON

Once that entry is made in the table then the only registrants that will wee the XTRA_WELCOME functions are

those that either sign up for REG_MAIN or REG_MON.

CUSTOM REGISTRATION VALIDATION

Currently the ATS Online Marketplace provides several ways to help guide the registrant to select the correct

options. Those include prerequisite functions, conflict coding, restrictions by registration class, and special

grouping of functions. If your validation needs aren’t met by any of these methods you can create a custom

validation of the registration through the use of a stored procedure. The

STORE_REGISTRATION_VALIDATION general lookup table will allow you to restrict registration based on

custom rules. Please refer to the section ‘Table: Store_Registration_Validation’ for detailed information and an

example stored procedure.

P a g e | 185


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FUNCTION BEHAVIOR

NOTE: Functions work the same way functions do in the iMIS Desktop. All of your functions

must have pricing setup, even if they are complimentary (check the Comp box).

FUNCTION LOGIC

• If the registration class has pricing it will be used • If a Default Price is setup (non-zero or complimentary) the default pricing will be used • If the person meets neither of the above two scenarios they will not be able to register for the

FUNCTION • If the person has no functions available to their registration class they will receive an error message

that they are unable to register for the EVENT • Functions that have the ‘Automatic Option’ box checked will be selected by default. • Functions that have no pricing for the registrant class of the person logged in will not display. • Any ‘required’ functions have a style applied to them in the style sheet that can display them

differently.

This can be VERY POWERFUL – You can ask questions of just members or just non-members. Some examples are:

• Create a ‘Speaker Lunch’ function with only pricing for the Speaker registrant class that only speakers can see.

• If a CBXO function (one of the ATS function prefixes listed above), is not set to complimentary for the registration class, the person will not be able to register for the function. In addition, if the Default Price is set to complimentary then anyone registering will see the question.

NOTE: All events must have an

early and regular cutoff date.

P a g e | 186


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SORT SEQUENCE

The Online Marketplace uses the Sort Sequence field in the function to help determine its placement on the

registration screen.

Any functions with a Sort Sequence under 1000 and a function prefix of REG_ (or designated alternate

function prefix) are considered ‘registration’ functions. These functions will display as radio buttons and

selection of one is required.

Functions with a Sort Sequence over 999 will be in conflict (displayed as radio buttons) in the following

scenarios:

• The date/time conflicts and the ConfigEventTimeConflicts entry in the Store_Settings table is set to

True.

• Two or more functions share a conflict code.

Functions on receipts and confirmations will print in order of the Sort Sequence set on each function.

P a g e | 187


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EVENT SECTION HEADERS

If the

CONFIGEVENTAUTOADDGROUPHEADER

entry in the Store_Settings table is set

to True (default) the behavior is function

grouping headers will be displayed as

follows:

• Additional Programs (before the first function that is 1000 or greater)

• Additional Information (before the first function that is 2000 or greater)

When the

CONFIGEVENTAUTOADDGROUPHEADER

in the Store_Settings table is set to

False, you have the ability to setup your

own group headers within an event.

Create a function in the Event that will display your desired header text – the Type for this function must be MEMO. The function code and title can be whatever you like. What you enter into the DESCRIPTION field will be what is displayed in the section header on the website. These functions must be set to show on the web.

Here is an example of a Memo function with a sequence number of 0. The description will be added immediately below the ‘Registration: Registrant Name’ line. NOTE: if the ConfigEventAutoAddGroupHeader is set to false this memo function MUST have a sort sequence of 0 to display the registrant’s name.

P a g e | 188


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Event Question Manager

The ATS Online Marketplace can utilize questions setup in iMIS using the Survey Questions.

iMIS 15-20.2.1.235: Once in Define an Event, click More>>Web Setup Wizard. Questions are defined on the

Survey tab.

iMIS 20.2.26.3109 and higher: Questions are defined in the Staff Site.

• Questions that are assigned to a function will be displayed directly below that function.

• Questions that are not assigned to a function will display after all functions.

• Functions set as an ‘Automatic Option’ will display the questions immediately

• Functions that are not set as an ‘Automatic Option’ will not display questions until the function is

selected.

• Any question setup will display.

EXAMPLE

Question assigned to a function called

GOLF asking the person’s handicap:

This displays in the Online Marketplace

like this:

Because the question is required it

displays with a different color.

P a g e | 189


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

An optional question not linked to a function would look like this:

In iMIS:

Online Marketplace:

Function set without

‘Automatic Option’

selected does not display

the question(s) until the

function is selected:

P a g e | 190


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Event Description Display

There are 2 different description fields you can use in the setup of your events. Depending on which one

you want to display there are different Store_Settings to control this.

To display the Description field from the iMIS Desktop use the ShowEventDescription and

ShowEventDescriptionBrief settings by setting them to true.

To display the Additional Description field from the Staff Site setup use the ShowEventAdditionalDescription

and ShowEventAdditionalDescriptionBrief settings by setting them to true.

The ‘brief’ settings show on search results where the other description setting displays on the event detail

page so you could have 2 different descriptions and perhaps the desktop description displays in search

results (brief) and the staff site description is used for the event detail page. In this scenario your settings

would look like this:

• ShowEventDescription – false

• ShowEventDescriptionBrief – true

• ShowEventAdditionalDescription – true

• ShowEventAdditionalDescriptionBrief - false

Labels: The labels settings for either of these are:

• Desktop: lblEventDescription

• Staff Site: lblEventAdditionalDescription

If either description field has no text in it the label will not display.

Event Image Display

Both RiSE and iMIS Desktop share the same field for iMIS for event image URLs. The Desktop uses a full URL

while RiSE uses a URL relative to the RiSE site. To support this functionality a Store_Setting has been added

to support this.

• URLEventImagePrefix – This is a prefix that will be added to all event image URLs that don’t start

with http or https (e.g. https://www.myasssociation.org/). This means that an image sucha as

images/myeventimage.jpg will result in a URL of

https://www.myassociation.org/images/myeventimage.jpg.

Event Resource Web Display

NOTE: As of September 2013 the ConfigEventDetailResourceGroup and

ConfigEventDetailResourceType Store_Settings has been phased out. This functionality is being

expanded with the addition of the Store_Event_Function_Resources and

Store_Event_Meeting_Resources general lookup tables.

The ConfigEventDetailResourceGroup and ConfigEventDetailResourceType settings in the STORE_SETTINGS

table have been phased out and replaced with the following Store_Settings.


P a g e | 191


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CONFIGEVENTDETAILDISPLAYMODE

EXAMPLE OF TABS ON EVENT DETAIL PAGE

P a g e | 192


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CONFIGEVENTFUNCTIONDISPLAYMODE

EXAMPLE OF EXPANDING PANELS FOR FUNCTION DETAIL

VALID ‘DESCRIPTION’

VALUES

The valid ‘Description’ values

for these 2 settings are:

Value Behavior

Linear displays all resources in a linear display on the Event Detail page

Tabs displays each resource ‘Type’ in a tabbed format

PanelsExpandAll displays each resource in a collapsible panel and all are expanded by default with this

setting

PanelsExpandNone displays each resource in a collapsible panel and all are collapsed by default with this

setting

PanelsExpandFirst displays each resource in a collapsible panel and only the first is expanded by default.

The first setting is controlled by the resource’s Sort Order

Function resources popup in the format of the designated when clicking on the Function Title.

P a g e | 193


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SETUP EVENT RESOURCES

Under Events>>Set up tables>>Event

resources setup the different resources.

We recommend using the STAFF Type.

• The Item Sort Order will

determine what order each

resource is displayed.

•

• Each resource you want to display

online will need to be added to

either the

Store_Event_Meeting_Resources

or

Store_Event_Function_Resources

general lookup table.

o Code = Title displayed for

resource section (panel,

tab, etc.)

o Description = Resource

Type|Resource Group

• You may also use a wildcard character of a percent sign. For example a description of STAFF|WEB%

would result in pulling groups named WEB1 and WEB2 from the STAFF type into the same tab or

panel.

P a g e | 194


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

In this example, on the REG_MAIN

function in our event we entered the

information in these resources. You can

enter these resources on any function

within your event

The values were set for each resource.

P a g e | 195


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

This is how the

information displays after

clicking on the function

name.

P a g e | 196


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

GENERIC RESOURCES

The ATS Online Marketplace also includes a number of KEYWORDS that have special meaning. For example, if

you want to display the event address in a tab, you can add a meeting resource and use the special code of

ADDRESS. By doing that, you can control the sort order and position of the address in your display.

NOTE: You do not need to re-enter the information (i.e. Address) into the resource, the code will

pull it from the Event Address window.

The following keywords are reserved. This means if you make the CODE in meeting resources match these

words, the text for the page will be pulled from other sources than the Event Resources. These items will

display even if you have the corresponding configuration turned off in the Store_Settings table. In other

words, this supersedes those settings.

Meeting Resources CODE Meaning Label comes from

ADDRESS Event address LBLEVENTADDRESS

DIRECTIONS Event driving directions LBLEVENTDIRECTIONS

NOTES Event notes LBLEVENTNOTES

COORD Event coordinators LBLEVENTCOORDINATORS

DESC Event Description LBLEVENTDESCRIPTION

UF1 Event User field 1 Event Setup










P a g e | 197


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE OF EVENT ADDRESS:

Event Resource Group and Item created:

• The first Type entry creates the

name of the resource group to

display

• Each resource within that Type

displays if data exists for that

field. Blank resources do not

display

Resource added to

Store_Event_Meeting_Resources general

lookup table:

P a g e | 198


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Add the address to your event setup:

Address Tab display on event detail page:

TIP: You could also include other

resources in the STAFF|ADDRESS

group that would display along with

the address. For example,

Transportation information, driving

directions (DIRECTIONS), etc.

P a g e | 199


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Displaying Speaker Information

Details about your speakers can be displayed along with your event information. There are five settings in the

Store_Settings table that control this functionality:

Setting What it does

ShowEvent Speakers shows event speakers on the detail page. Set to False if using functionality

above

ShowEventSpeakersBrief shows event speakers on the Search Results page

ShowEventSpeakersImage Show/Hide speaker images if ShowEventSpeakers is turned on

lblEventSpeakers Label to display

URLPersonImgageNotFound this URL will display a graphic when a photo does not exist on a speaker’s

record in Customers

Setting these options to True will display

speaker names and optionally speaker

photos. Any speaker within your event

will be displayed, regardless of the

function they are assigned to. Name,

company name, and optionally picture

will be displayed. You will need to create

an Event Resource to assign a speaker to

your event. This is done in iMIS under

Events>>Set up tables>>Event

Resources:

P a g e | 200


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Within your function you can then

assign an ID to this speaker resource:

To display pictures you need to have a

picture in the person’s record in

Customers:

P a g e | 201


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

To display all speakers you can utilize

the Store_Event_Meeting_Resources

and Store_Event_Function_Resources

tables. Using % as a wildcard will

display all speakers for an event and/or

function:

Example of speakers displayed when

added to

Store_Event_Meeting_Resources table.

Example of speakers displayed for a

function when added to the

Store_Event_Function_Resources table.

P a g e | 202


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Example of speaker information in the

Event Brief Listing

(ShowEventSpeakersBrief = True):

Sample of speaker information on the

Event Detail Page (ShowEventSpeakers =

True):

P a g e | 203


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Guest Functions

Setting a function up as a Guest Function

in iMIS will allow your registrants to

create guest badges while registering.

You will check the Guest Function box

and then set the number of guests

allowed for this function in the ‘Max

Registrations per Registrant’ box.

When a registrant selects a Guest

Function they are presented with a

window to create the guest badges:

P a g e | 204


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Click + to add each badge:

Badges are editable until the registrant

checks out. The badges are stored in the

Badges window in iMIS.

Guest Badges

You can control what fields are displayed and how they can be edited by using the

Store_Event_Guest_Badge_Fields general lookup table. Each entry in this table can be set to one of the

following options:

• READONLY – displays existing value from iMIS but does not allow changes

• EDIT – displays existing value and allows editing

• REQUIRED – same as EDIT but the field must have a value

Fields Available:

AddressLine1 InformalName

AddressLine2 LastName

AddressLine3 MiddleName

City PostalCode

Company Prefix

Country StateProvince

P a g e | 205


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

DelegateNumber Suffix

Designations Title

FirstName

The information collected creates an Order_Badge record and is visible on the Badges screen in the iMIS

desktop.

P a g e | 206


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Register Someone Else Functionality

The ATS Online Marketplace has the ability to let your customers register themselves as well as other people

at their company for your events. Here are the features and settings needed for this functionality.

ALLOWREGISTERSOMEONEELSE

When this entry in the STORE_SETTINGS General Lookup/Validation table is set to true then this functionality

is allowed for all events. If set to False, you can control this functionality within each event in the staff site

with the ‘Allow registering others’ checkbox.

• This feature of the Online Marketplace allows a person at a company to register other individuals at

their company (they have the same Company ID). If you need different functionality than this, you

can create a view to select the desired list – see the General Lookup/Validation Table –

STORE_EVENT_REG_AUTHORIZATION.

• Will not allow someone to edit an existing registration. (iMIS 20.0.X.X and lower only)

• Will not allow someone to register someone that is already registered.

• Will not allow someone to register a company record (can be over-ridden by using a custom view).

• Additional settings:

o lblEventRegisterSomeoneElseHeader – Text that displays above the listing of people someone is

allowed to register for an event.

o ShowRegisterSomeoneElseCompany – True shows the person’s company

o ShowRegisterSomeoneElseImage – True shows the person’s photo

o ShowRegisterSomeoneElseTitle – True shows the person’s title

o ShowRegisterSomeoneElseImage – True/False – if set to true a person’s image will display in

the ‘register someone else’ list. If this is set to true and a person does not have a picture the

URLPersonImageNotFound image will be displayed.

P a g e | 207


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

STAFF SITE SETUP:

DESKTOP - WEB OPTIONS WINDOW:

REGISTRANT SELECTION LIST

When you click the ‘Register Someone

Else’ button you are displayed a list of

people you are eligible to register.

There is also a Filter box to search.

Text entered in this box uses ‘contains’

when searching so any characters are

search throughout the fullname.

P a g e | 208


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

When a person can register a large number of people we display a progress bar so they will know that the

Marketplace is loading the list.

P a g e | 209


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Bulk Registration

If your event only has one function and no questions the register someone else screen displays with

checkboxes next to each person’s name to select and add all to the cart at the same time.

If you have questions you need to ask you need to make them all required, and it will force you to go

through each registration individually and add each one to the cart.

P a g e | 210


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Edit Registration

Click Edit Registration:

P a g e | 211


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Already selected functions are highlighted, and only available functions are able to be selected. You can also

edit guest badges.

P a g e | 212


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Other Information – Event Setup

• When the Online Marketplace determines price ranges for events it finds the highest and lowest priced

function and displays that range. It only considers functions that are marked ‘Show this function on

the web?’ and have a Sort Sequence under 1000.

• If the begin and end date for the event are the same only one date is displayed. If the begin and end

time is the same for all functions then the time is displayed, otherwise only the date is displayed.

• Member pricing is based on member type alone. Status is not considered when determining pricing.

• Allowing your registrants to pay by purchase order is allowed. Based on your iMIS version, the

following Store_Settings control this functionality:

o iMIS 15.2.1 and Lower – PaymentPurchaseOrder – set to true to enable purchase orders

o iMIS 15.2.5 and Higher – PaymentPurchaseOrderEvents – set to true to enable purchase orders

• Tracking ID number of the person that created a registration in Order_Meet.REGISTERED_BY_ID (iMIS

20.1.X.X and higher only).

• Track and Category fields are displayed with functions (iMIS 20.0.X.X and higher only).

• Events with only one function will display an add to cart button on searchresults.aspx unless the event

is full. NOTE: On versions below 20.0.X.X the iMIS Business Objects do not support this and will show

an add to cart button even if the limit on the event is full. It is recommended to set limits on the

functions, which is supported.

• If someone has a registration in their cart and does not check out but comes back later to finish the

registration and the event has reached its maximum, the registration will be removed from the cart.

NOTE: On versions below 20.0.X.X the iMIS Business Objects do not support this and will not remove

the registration from the cart even if the limit on the event is full. It is recommended to set limits on

the functions, which is supported.

• Functions will print on receipts and confirmations based on the Sort Sequence set on each function.

• For a Google map to display on an event at least 2 fields on the event address must be filled out.

• If a URL contains an invalid event code the following message will be displayed:

o This event is not setup for taking registrations yet. Please come back soon to register online.

Schedule of Events Listing

This is the listing that displays when the SHOWCALENDARSCHEDULEVIEW Store_Setting is set to True.

Other Store_Settings that affect this view:

P a g e | 213


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

• LBLVIEWEVENTCALENDAR –

Label on the Calendar button as

shown to the right

• LBLVIEWEVENTSCHEDULE –

Label for the ‘Schedule of Events’

as shown to the right

• LBLVIEWEVENTLIST – Label on

the List button as shown to the

right

P a g e | 214


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Event Registrant Class Determination in iMIS 15

Registration classes determine the price a

person will pay for a function within an

event. In iMIS 15.0, 15.1 and 15.2.0, you

need to set the ‘Registrant Class

Determination’ option in the Web Setup

Wizard. In the Define an Event window

go to More>>Web Setup Wizard. Here

you will choose the method for

determining registration classes:

• Map Type – this means that you

must have a registrant class setup

for each member type

• Member/Non-Member – this

means you must have an ‘M’ and

‘NM’ registrant class setup with

pricing. The member/nonmember

is then determined from the

Customer Type table in iMIS. If

the ‘Is a Member’ box is checked,

the person receives member

pricing, if not, they receive

nonmember pricing.

• Stored Procedure – this allows you

to create custom rules for

determining a person’s registrant

class. See the following section

for more information about

creating pricing stored procedures.

In iMIS 15.2.5 and higher this information

is consolidated under More>>Web Options:

P a g e | 215


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Event Stored Procedure Pricing

iMIS allows for either using a registrant’s member type to be passed through as the registrant class or pass

through member/nonmember (M/NM) as the registrant class based on the registrant being a current member

(or not). With the ATS online marketplace, a third option is available, stored procedure pricing.

Stored procedure pricing provides a completely customizable method for calculating registrant classes. For

example, if a business rule stated that members that have 3 or more years of continuous membership get a

$100.00 off the normal member registration fee for the annual conference, then a store procedure could be

programmed to determine if a given registrant qualified and set the registrant class to one that has the

discount built into the registration fees.

Each event can have a unique stored procedure, in the case pricing is calculated a different way. Or, each

event can share the same stored procedure; letting you leverage the programming effort across all events.

Any event that isn’t set up to use stored procedure pricing will use the standard iMIS calculation based on the

event module setting; i.e. pass through member type or member/nonmember.

TO UTILIZE STORED PROCEDURE PRICING

There are two requirements:

1. Create and add the stored procedure to SQL server

2. Map the event code to the name of the stored procedure.

P a g e | 216


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CREATE AND ADD THE STORED PROCEDURE

The stored procedure must accept, as parameters, the event code and the contact ID. It must also have a

single return value that is the registrant class code. Below is a simple stored procedure that determines M or

NM as the registrant class. This example can be used as a baseline for building a custom stored procedure;

note that it is beyond the scope of this document to explain the process of creating and modifying stored

procedures.

CREATE PROCEDURE [dbo].[sp_EVENTPRICING]

@ID varchar(30),

@EVENTCODE VARCHAR(100)

AS

BEGIN

DECLARE @REGCLASS VARCHAR(100)

SET @REGCLASS = 'NM' -- Assume NM unless we find out ID is for a member

DECLARE @CURRENT VARCHAR(30)

SET @CURRENT = (SELECT ID FROM Name WHERE MEMBER_RECORD = 'true' AND STATUS = 'A' AND ID = @ID)

IF @CURRENT = @ID

SET @REGCLASS = 'M'

SELECT @REGCLASS

END

P a g e | 217


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Add to Calendar Functionality

The Online Marketplace can allow registrants to add events and functions to their email calendar. After a

person registers for an event they will be able to add the event, the individual functions they registered for or

both the event and functions to their email calendar from the ‘View Previous Orders’ page.

EXAMPLE

After registration, the customer can

navigate to their ‘View Previous Orders’

page and see the event(s) they have

registered for. They will see a ‘Calendar’

button to use this functionality.

After clicking the Calendar button they

will see the options for adding items to

their calendar:

NOTE: The Add to Calendar feature creates a multi-event ICS file that is opened by the users

email client. The user experience can vary for different email clients.

P a g e | 218


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Confirmation Letter System

The Online Marketplace has a

confirmation letter system built into the

administrative portal that allows you to

create custom confirmation letters on a

meeting-by-meeting basis, by event type

or one generic confirmation for all events.

In addition to automatically sending these

confirmations to registrants through the

Online Marketplace there is also

functionality to email these to registrants

who mail/fax in their registrations.

In the Web Options for an event a staff

ID number can be set. If this field has an

ID number in it, this ID will receive copies

of all confirmation letters via email.

P a g e | 219


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

The Confirmation Letter System is turned

on by a setting in the Store_Settings table

called EventSendConfirmationLetters:

To access the Administrative Portal go to your store /store/admin/storeadmin.aspx (i.e.

http://www.atsol.org/store/admin/storeadmin.aspx).If you are not already logged in you will be taken to a

login page. Once logged

in, any user with the

ATSStoreAdmin Access

Keyword will be directed

into the administrative

portal.

CONFIRMATION LETTER

MANAGEMENT

Click on Events then

Expand Confirmation

Letters. Click on

Confirmation Letter

Management:


P a g e | 220


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CHANGE GLOBAL SETTINGS

Allows you to turn the Confirmation Letter System on and off. This is the same as changing the

EventSendConfirmationLetters setting in the Store_Settings General Lookup table.

SET HOW TEMPLATES ARE APPLIED TO EVENTS

Allows you to set separate confirmation letters for each of your events. Items in red indicate that there has

been no letter setup for that event.

EDIT TEMPLATES

Allows you to create and edit letters to assign at a global, event type or event specific level.

ASSIGN MEETING SPECIFIC TEMPLATES

Allows you to assign and edit confirmation letters. The Event list is a listing of all of your events in iMIS that

are set to ‘Allow Online Registration’, the End Date is in the future and have a Status of Active.

P a g e | 221


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 222


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SET HOW TEMPLATES ARE APPLIED TO EVENTS

This screen allows you to

set a system wide

confirmation or a

confirmation based on the

Event Type in iMIS. After

creating your templates,

select an available one from

the drop-down.

TEMPLATE EDITOR

Click the ‘Create/Edit Template

Confirmation Letters’ button’

This will bring you to the list of existing

templates and also a button to create a

new template. Click Edit to make changes

to an existing template or click ‘Create a

New Template Letter.’

P a g e | 223


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

This will direct you to the WYSIWYG

editor:

You can enter and format text as well as

insert fields from iMIS:

P a g e | 224


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

You can select the fields from iMIS from

the ‘Insert iMIS Field...’ button. The full

list of fields can also be viewed from the

top of the editor by expanding the

legend:

EXPLANATION OF EVENT TIME FIELDS

Field Explanation

EVENT_BEGIN_DATE event begin date entered into iMIS

EVENT_END_DATE event end date entered into iMIS

FIRST_BEGIN_DATE the date of the chronological first function that is set to show on the web and has a

date/time

FIRST_BEGIN_TIME the time of the chronological first function that is set to show on web and has a

date/time

LAST_END_DATE the date of the chronological last function that is set to show on the web and has a

date/time

LAST_END_TIME the time of the chronological last function that is set to show on web and has a

date/time

If there are no functions that have a time then it would be considered to start at midnight.

You can view your template in Design,

HTML and Preview view. When you save

your template it will be available to assign

to any event:

P a g e | 225


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Click ‘Go Back to Confirmation Letter

Home Page’ to assign the template to an

event. Click the Set button to select a

template confirmation letter to be sent.

You can also create an Event Specific

Letter but it will not be available to use as

a template for other events.

Confirmation letter templates are stored

in iMIS under your Coupon Manager

record. They are stored as CONFLETTER

activity. The HTML is stored as an

attachment to the activity.

P a g e | 226


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CONFIRMATION LETTER DELIVERY

Click the ‘Confirmation Letter Delivery’ button to access the area where you can generate email confirmations

for those registrations that do not come in through the Online Marketplace (i.e. mail or phone-in registrations).

You can click Preview to see the template confirmation. When you click ‘Review/Send’ you will be displayed a

list of people that have registered but have not received a confirmation. The

Orders.CONFIRMATION_DATE_TIME is used for determining if a person should be selected; if this field is

NULL for the registration they will be selected. If a confirmation has been generated from iMIS, a person

would not be selected.

The Reprint button will allow you to resend all confirmations to any registrant with an email address.

P a g e | 227


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SETUP IN DUES

This section will explain the setup options for dues/subscriptions. You must define each dues/subscription

process in the ATS_Dues user-defined table on the record set as the ConfigDuesManagerID in the

Store_Settings general lookup table.

Setup a row for every end member type scenario. This means that for every process (join, renew,

subscription) you will have an entry in the ATS_Dues table for the end result of the process (End Member Type

field). If a nonmember can join as different types of members you will need an entry for each type of member

the nonmember can join as. A description of each field is in the ‘ATS_Dues Tab’ section of this document.

The Billing_Cycle field refers to a billing cycle setup in iMIS under Billing>>Set up module>>Billing Cycles.

Dues products sort by Payment Priority.

NOTE: you will need to select all of your products in the product column as the ‘Other Billing

Instructions’ checkboxes are not recognized.

The values available for the Type field are JOIN, RENEW or SUB.

P a g e | 228


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Join

EXAMPLE OF A NONMEMBER JOINING THE ORGANIZATION

NOTE: All END_STATUS must be set to A.

P a g e | 229


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

The Online Marketplace uses a wizard-type approach for dues with each product type (DUES, CHAPT, SEC,

SUB, MISC, VOL) are their own screen in the join/renew. Here is an example of a JOIN with chapter selection.

P a g e | 230


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Renewal

For RENEW cycles the records in iMIS must first be billed before a person would be eligible to renew. Without

a balance due they would receive the NOT_ELIGIBLE_TEXT message for that RENEW entry.

EXAMPLE OF RENEW ENTRY

P a g e | 231


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Chapters

If you use ‘Chapter’ products but don’t call them chapter, the prompt setup in iMIS under Customers>>Set up

module>>General>>Chapter Prompt will now display when an error is displayed upon chapter selection.

Display in the Online Marketplace:

NOTE: If the option

CHAPTERPRODUCT_ALLOW_CHANGE is set to false

and CHAPTER_ALWAYS_SHOW is set to false then the

chapter selection page will not be shown and

existing chapter Subscription records will

automatically be added to the cart but only if the

product codes are selected in the billing cycle.

P a g e | 232


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Company Dues/Pay Someone Else’ Dues

Some organizations have company memberships. This scenario is accommodated with the ‘Is Company’ and

‘Company Authorization’ fields. When you check the ‘Is_Company’ box it means that this JOIN or RENEW is

only for Company records in iMIS. Company records are identified in iMIS when you check the ‘Is a Company’

box on the Customer Type table for that customer type under Customers>>Set up module>>Customer Types.

When the Is_Company box

is check on a dues process

you also need to enter the

name of a SQL view that

will identify who in iMIS is

eligible to complete this

process on behalf of the

company. This view will

contain two fields: ID and

CO_ID where the ID is the

record that can act on

behalf of the company.

This functionality can also be used to allow someone to pay someone else’s dues. Check the ‘Is Company’ box

and enter the name of the view that identifies the ID’s that one ID can pay. We recommend you test your

view to not return any blank values in the CO_ID column.

P a g e | 233


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE

An example view that allows anyone with the same company name to pay dues for anyone at the company

looks like this (the ID is the payer and the CO_ID is the payee):

USE [OnlineMarketplace]

GO

/****** Object: View [dbo].[vwATSPayDuesSomeoneElse] Script Date: 02/21/2014 14:06:00 ******/

SET ANSI_NULLS ON

GO


GO

CREATE VIEW [dbo].[vwATSPayDuesSomeoneElse]

AS

select n2.id as ID, n1.id as CO_ID

from name n1, name n2

where n1.company = n2.company

and n1.company <> ''

and n2.status = 'A'

and n1.status = 'A'

GO

In addition, there is a Store_Setting –

lblDuesProcessSomeoneElseButton that

lets you customize the text on the button

when renewing multiple people.

Also, you must enter a value in the

URLDuesApplication entry in the

Store_Settings table. If you’re not using

a separate join/renew application use

~/dues.aspx for this setting.

After clicking, the person is taken back to

the list of names to select the dues

payment:

P a g e | 234


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 235


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Subscriptions

Subscription cycles can also be setup for customers to add or renew subscription products. The Store_Setting

ConfigSyncSubDatesWithPrimaryDues controls how subscription paid through are handled. If set to true,

subscriptions added to the cart will synchronize with the primary dues item’s dates. If set to false, the

subscription dates will be calculated according to the billing cycle.

The SUB entries only require the Type, Billing_Cycle, Start_Member_Type, Start_Billing_Category,

Start_Status, Start_Chapter, Eligible_Text and Not_Eligible_Text fields be completed. Optionally, you can

enter the name of a SQL view to further restrict access.

First, is a check to see if the product is in the ATS_DUES table. If it is eligibility is to subscribe/renew is based

on the billing cycle.

SUBSCRIPTION EXAMPLE

P a g e | 236


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 237


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Non-eligible

You will also need to create a default JOIN entry for people that are ineligible to join.

NON-ELIGIBLE EXAMPLE:

P a g e | 238


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Settings

The ‘First Month of Fiscal Year’ in the AR/Cash module must be set to something other than zero. This is in

iMIS under AR/Cash>>Set up module.

The STORE_UNBILLED_DUES General Lookup/Validation table contains settings for identifying what to do with

dues/subscription items that are not billed as part of the join/renew in the Online Marketplace. Please refer to

the section ‘Table: Store_Unbilled_Dues’ for detailed setup information.

P a g e | 239


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ADVANCED CRITERIA

Dues Rollup – this General Lookup/Validation table allows you to combine multiple dues products to display

them as one item on the Dues Summary page, in the shopping Cart and on the receipt. See the section Table:

Dues_Rollup for an explanation of how to setup.

Store_Dues_Kits – this General Lookup/Validation table allows you to combine multiple dues products

together that will display as one line item during the join/renew process. VOL items are excluded from this.

Only available for join/renew (dues.aspx not subscription.aspx). See the section Table: Store_Dues_Kits for an

explanation of how to setup.

Criteria – The Criteria field allows you to add additional custom dues criteria to an entry in the ATS_DUES

table beyond Member Type, Billing Category and Status. You will add the name of a SQL view to the Criteria

field that contains the ID’s of the people allowed to use that line item. An example of how this could be used

would be to limit access to a product by a person’s country. This is limited to JOIN/RENEW only (no SUB).

Example:

SET ANSI_NULLS ON GO


GO

CREATE view [dbo].[vDuesCriteria_Country] as

select ID from Name where COUNTRY<>''

GO

You then add the name of the view to the Criteria field in the desired entry in ATS_DUES. This will eliminate

any of the ID’s not selected in the view from being able to join/renew on that entry.

P a g e | 240


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Profile – The Profile field will contain the name of a view that will prevent people from continuing through the

dues process. The view needs to have two columns: ID and NOTE. The ID is the iMIS ID number of the

person paying dues and the NOTE is a message that will be displayed on the screen. If the person is not in the

view then they will be able to continue through the dues process. If they are in the view they will be stopped

and the message will be displayed. Here is an example view that would stop people from joining/renewing if

they don’t have an email address on file.

Example:

SET ANSI_NULLS ON GO

SET QUOTED_IDENTIFIER ON GO

CREATE view [dbo].[vDuesProfileCheck] as

select id as [ID], 'You must have an email address on file to join or renew. <a href="http://www.atsol.org">Click here</a> to edit your profile and add an email address. <br /><br />(This is an example for demonstration purposes

only and the link should go to your profile editing tool.)' as Note from name where name.email = ''

GO

The screen will display when the system identifies the specific line in the ATS_DUES table the person is

selecting. For example, you may have a restriction on people who join as a student that you don’t have on

people who join as a professional member. Therefore, the check will not happen until after the person selects

the member type that they want to join as.

P a g e | 241


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Cart Behavior

If a person adds dues to their cart but does not check out on the same day the following rules apply:

• If dues in the cart are over 30 days old they are removed.

• If using Start Date Control, the Marketplace compares the iMIS setting to the current date vs. the day

dues were added to the cart. If that is less than the iMIS setting the dues are removed from the cart.

Renewal Logic

The Marketplace uses the following rules to determine if someone can renew.

• If a record is set as a ‘member’ customer type but has no billed DUES dues product they will not be

allowed to join or renew.

• Look at all items in the billing cycle for that line item in ATS_DUES (except VOL items which are

excluded).

• If any of those products in the billing cycle are also in the person’s subscription collection and the

line has a status of A (Active), check to see if the following conditions exist. If one exists for each

subscription record they will be able to renew.

o Has a balance due

o Marked complimentary

o Subscriptions.BILL_THRU is greater than or equal to the Name.PAID_THRU

o If a subscription item has a bill through date greater than or equal to the contact

paid through date and the amount billed is 0 and the balance due is 0.

• If a person has one or more of their dues items paid a generic message will display that they are not

eligible and to contact the office.

P a g e | 242


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Dues Wizard Header

There are 3 entries in the Store_Settings general lookup table that control what can be displayed in the

header of the dues join/renewal wizard. This header is displayed on every screen through the dues wizard

process.

• lblDuesBillingCategory – This is a label that prefaces the dues billing category. If the label is blank or

the billing category on the record is blank, this line will not display. Default value is ‘Current Billing

Category’.

• lblDuesMemberType – This is a label that prefaces the member/customer type. If the label is blank

neither the member type nor label will display. Default value is ‘Current Member Type’.

• LblDuesPaidThroughDate – This is a label that prefaces the paid through date. If the label is blank or

the paid through date is blank, this line will not display. Default value is ‘Last Paid Through Date’.

P a g e | 243


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Dues Product Sorting

• When offering multiple customer types during a join or renew you can control the order in which the

customer types are displayed using the Store_Member_Type_Sort_Order general lookup table.

• When offering choices for category during a join or renew you can control the order in which the

categories are displayed using the Store_Dues_Category_Sort_Order general lookup table.

• Dues items will be printed on receipts based on the Payment Priority. This can be set on each product.

Long Titles for Member Type and Category

P a g e | 244


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

If the standard iMIS description/title for member type and category are not long enough you can utilize the

Store_Dues_Category_Descriptn (sic) and Store_Member_Type_Description general lookup tables to expand

these descriptions.

Pre-select Member Type and/or Category When Starting Dues.aspx

A member type and/or category can be pre-selected when initiating the dues.aspx page by appending the

member type and/or category to the URL. If you specify a member type and/or category combination on the

querystring, and the person is eligible for that membership, the option will be pre-selected, and the next

button will be clicked.

For example, if a person clicks on a link to join as a student, and the student member type is STU, you can

create a link such as this: https://yourstore.org/store/dues.aspx?customertype=STU. This can be useful when

used in combination with the Profile and Criteria fields in the ATS_DUES.

Options to append to the dues.aspx querystring:

• Dues.aspx – no customer type or billing category will be pre-selected

• Dues.aspx?CUSTOMERTYPE=M (where M is the member type to pre-select)

• Dues.aspx?CUSTOMERTYPE=M&BILLINGCATEGORY=ELEC (where M is the member type and ELEC is the

category to pre-select)

• Dues.aspx?BILLINGCATEGORY=ELEC (where ELEC is the category to pre-select)

Dues Product Prerequisites

When joining or renewing it may be desired that a subsequent product is only displayed after one is

selected. For example, you may want to offer a chapter journal or special chapter donation to only display

is the person selects that chapter first. Product types are displayed in this order in the dues wizard: Dues

(DUES) >> Chapters (CHAPT) >> Sections (SEC) >> Miscellaneous (MISC) >> Subscriptions (SUB) >> Voluntary

(VOL). This means that a product code with a product type of CHAPT can be a prerequisite for a product

code with a product type of SEC but not the other way around. In addition, a product cannot be a

prerequisite for a product with the same product type. For example, a MISC product cannot be a

prerequisite for another MISC product.

Overall, items are shown in the dues wizard as follows:

1. In the billing cycle

2. Not filtered by the IQA dues filtering options

3. Has a prerequisite

There is a general lookup table that controls the prerequisites called Store_Dues_Product_Prereq. The code

is the product code that needs a prerequisite set. The description is a comma-delimited (no spaces) list of

the product code(s) that are considered prerequisites.

In the highlighted example below, a person would only see the DENVOL (VOL product) if they first selected

the DENVER (SEC product) first.

https://yourstore.org/store/dues.aspx?customertype=STU

P a g e | 245


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 246


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Exclude VOL items from Dues Coupons

There is an entry in the Store_Settings general lookup table called ConfigDuesCouponsIncludeVolItems. It is a

True/False setting. If set to true, dues coupons will include VOL items for dollars off and percentage off

coupons. When set to false, VOL dues items will not be discounted when a dues coupon is used. The default

for this setting is false. The only is applicable when there are no product code or product category restrictions on

the dues coupon.

Blank Category

iMIS does not require a member to have a category. Some organizations need to offer members the option

to select a blank or non-blank category. You can do this by adding a blank entry into the Category general

lookup table where the description is what you want displayed to the person joining/renewing.

The ATS_DUES table must also be configured for a blank and a non-blank category for the join or renew so

that the option can be displayed. A row with the non-blank selections will be added as well as one with the

End Billing Category field set to blank.

P a g e | 247


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 248


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Join/Renew and Pay Later

This functionality will allow a person to join or renew and opt to pay later. When someone clicks the pay

later button the following actions occur on the record:

• Member type will be change to the new member type selected during the dues process.

• Join date will be changed to the current date if they are joining.

• Paid through date is not updated.

• Subscription records will be updated based on selections during the join/renew. Dues that are not

part of the process or opted out of during the process will be handled based on the setup of the

Store_Unbilled_Dues general lookup table.

o Subscriptions.BILL_BEGIN – set to the first date of the term

o Subscriptions.BILL_THRU – set to the last date of the term

o Subscriptions.BILL_AMOUNT – set to the amount billed for the item

o Subscriptions.BALANCE - set to the amount billed for the item

o Subscriptions.STATUS - set to ‘A’ for active

The following Store_Settings controll the process:

• AllowDuesJoinPayLater - True/False setting that when set to true the pay later button

displays on the dues summary screen for joins.

• AllowDuesRenewPayLater - True/False setting that when set to true the pay later button

displays on the dues summary screen for renewals.

• DuesJoinPayLaterNotice – Text that displays to the user when joining and pay later option

is enabled.

• DuesRenewPayLaterNotice – Text that displays to the user when renewing and pay later

option is enabled.

• DuesJoinPayLaterButtonText – Text on button to pay later on a join.

• DuesRenewPayLaterButtonText – Text on button to pay later on a renewal.

• DuesJoinPayLaterButtonLink – URL of the page a person joining will be taken to on the

button click.

• DuesRenewPayLaterButtonLink – URL of the page a person renewing will be taken to on the

button click.

P a g e | 249


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

After clicking the Join and Pay Later or Renew and Pay Later button the person will be taken to the page

identified on the DuesJoinPayLaterButtonLink or DuesRenewPayLaterButtonLink respectively.

Staff Site record view:

Desktop record view with subscription detail:

P a g e | 250


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

List Billing

This functionality allows anyone at a company to log in and pay dues for billed company members. It will

allow the selection of members to select for payment without going through the dues wizard and will just

add the billed item(s) to the cart.

There is one Store_Setting that controls the text at the top of this screen called lblDuesListbillHeaderText.

P a g e | 251


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Accessing the Dues List Bill page is done on the dueslistbill.aspx page. Add an entry to the

Store_Dues_Categories_Addl table to offer this functionality.

P a g e | 252


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Dues Product Grouping, Sorting, and Filtering

These settings allow the dues screens will be split in up to three sections. Those sections are as follows:

SUBSCRIBED/SELECTED These are the product codes that were on the

persons record before they start the process or ones

that were added as part of the join/renew process.

Once an item is selected, it will be in this section.

SUGGESTED These are items that have TRUE set in the

suggested section below. In addition, any VOL items

that have a suggested giving amount will be put

into this section even if the value in the SUGGESTED

column of the IQA.

OTHER These items are the product codes that are not in

the SELECTED or SUGGESTED sections.

The sort order of items on the screen will be determined as follows:

1. Selected – Has the item been selected.

2. Suggested – Has the item been suggested.

3. Sort Order – provided by the IQA, if the IQA is provided.

4. Payment Priority – This is the payment priority as defined in iMIS on the billing product code.

5. Title – This is the Title of the product in iMIS.

All IQA’s need to have four columns.

ID iMIS ID of the person that dues are being paid for

PRODUCT_CODE The Product code of the item in iMIS. Remember

that Chapters are prefaced with “CHAPT/”

SUGGESTED This can be TRUE or FALSE. If TRUE, the item will

show in the SUGGESTED section of the display

SORT_ORDER This is a number and can designate the sort order of

the item on the page. This will allow you to

manually control the sort order or to use a module,

like the ATS GeoCoding, to determine the proximity

of the person to chapter (in the case of chapters or

sections).

STORE_SETTINGS

P a g e | 253


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Chapters

DUESCHAPTERSIQA This is the name of an IQA that will have the four

columns identified above. If the IQA is not

provided, then the SUGGESTED and SORT_ORDER

will not be used to control the order of the items on

the page.

DUESCHAPTERSFILTERBYIQA This setting is only applicable if the IQA is provided.

This value can be TRUE or FALSE. If TRUE, then any

product codes in the “other” section will only be

shown if their product code is in the IQA. If their

product code is NOT in the IQA the item will not be

shown. This will allow you to have another filtering

mechanism for people who join or renew other than

the billing cycle. This will let you have the same

billing cycle for two people but show different

product codes based on the rows in the IQA query.

LBLDUESCHAPTERSUBSCRIBEDTEXT This is the text for a header that will show at the

top of the SUBSCRIBED/SELECTED section of the

display.

LBLDUESCHAPTERSUGGESTEDTEXT This is the text for a header that will show at the

top of the SUGGESTED section of the display

LBLDUESCHAPTEROTHERTEXT This is the text for a header that will show at the

top of the Other text.

Sections

DUESSECTIONSIQA This is the name of an IQA that will have the four




the page.

DUESSECTIONSFILTERBYIQA This setting is only applicable if the IQA is provided.








P a g e | 254


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org



LBLDUESSECTIONSUBSCRIBEDTEXT This is the text for a header that will show at the


display.

LBLDUESSECTIONSUGGESTEDTEXT This is the text for a header that will show at the


LBLDUESSECTIONOTHERTEXT This is the text for a header that will show at the


Miscellaneous

DUESMISCSIQA This is the name of an IQA that will have the four




the page.

DUESMISCSFILTERBYIQA This setting is only applicable if the IQA is provided.










LBLDUESMISCSUBSCRIBEDTEXT This is the text for a header that will show at the


display.

LBLDUESMISCSUGGESTEDTEXT This is the text for a header that will show at the


LBLDUESMISCOTHERTEXT This is the text for a header that will show at the


Subscriptions

DUESSUBIQA This is the name of an IQA that will have the four



P a g e | 255


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


the page.

DUESSUBSFILTERBYIQA This setting is only applicable if the IQA is provided.










LBLDUESSUBSUBSCRIBEDTEXT This is the text for a header that will show at the


display.

LBLDUESSUBSUGGESTEDTEXT This is the text for a header that will show at the


LBLDUESSUBOTHERTEXT This is the text for a header that will show at the


Volunteer

DUESVOLSIQA This is the name of an IQA that will have the four




the page.

DUESVOLSFILTERBYIQA This setting is only applicable if the IQA is provided.










LBLDUESVOLSUBSCRIBEDTEXT This is the text for a header that will show at the


display.

P a g e | 256


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

LBLDUESVOLSUGGESTEDTEXT This is the text for a header that will show at the


LBLDUESVOLOTHERTEXT This is the text for a header that will show at the


EXAMPLE IQA – SUGGESTED CHAPTER

CREATE VIEW

[dbo].[VW_CHAPTER_SUGGESTIONS] AS

SELECT

NAME.ID,

PRODUCT.PRODUCT_CODE,

CASE WHEN LEFT(NAME.ZIP,5) = ZIP_CODE.ZIP AND PRODUCT.PRODUCT_MINOR = ZIP_CODE.CHAPTER

THEN 'TRUE' ELSE 'FALSE' END AS SUGGESTED,

1 AS SORT_ORDER

FROM

NAME,

PRODUCT,

Zip_Code

WHERE

NAME.STATUS = 'A'

AND NAME.COMPANY_RECORD = 0

AND PRODUCT.PRODUCT_MAJOR = 'CHAPT'

AND ZIP_CODE.ZIP != ''

AND LEFT(NAME.ZIP,5) = Zip_Code.ZIP

and (PRODUCT.PRODUCT_CODE != 'CHAPT/COLORADO' OR NAME.STATE_PROVINCE = 'CO') -- Colorado

chapter is only available to people who live in colorado

GO

The IQA must have an optional filter on the ID field.

P a g e | 257


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE: CHAPTER SUGGESTIONS

P a g e | 258


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLE: VOL ITEMS NO IQA

When not using any filtering or IQA with VOL dues products, they will display as recommended if there is a

price set on the product (recommended amount). If there is no price they display as additional items:

P a g e | 259


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

enSYNC Online AutoDraft

The ATS Online Marketplace supports the enSync Online AutoDraft module. You must own the module from

enSYNC and there is an additional license key from ATS that must be installed. This functionality allows you

the ability to offer payment plans for dues payments as well as the saving of credit card information for

future use by your customers. This section explains the setup and configuration of this feature for use with

the Online Marketplace.

The options available are monthly, quarterly, biannual (twice a year), and annual.

Only dues products with Renewal Months of 12 are allowed.

NOTE: Dues coupons are not currently supported with this feature. Coupons for other modules (i.e. Events,

Orders) can be used in conjunction with dues with a payment plan in the cart but dues coupons are not

allowed and will be removed from the cart if added.

CONFIGURATION & SETUP

There is a new user-defined table that is used for configuring options displayed at payment time. The only

entries in iMIS exist on the ConfigDuesMangerID entry in the Store_Settings General Lookup/Validation table.

If you are charging a surcharge you will want to add that product to the billing cycle(s) for renewals.

ATS_PAYMENT_OPTIONS


Option_Code Required: Code for payment

option

This is a unique code to identify each

payment option allowed. For

example, 1M would be for 1 payment

P a g e | 260


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


per month, 3M would be for

quarterly payments, and so on.

Status A or I Sets rule to active (A) or inactive (I)

Payment_Plan_Header Text Text displayed on top of payment

plan page.

Term_Instructions Text

Explanation for section of current

year dues payment plans offered.

Sort_Order Number Order of display for each payment

option.

Option_Name Text Name of option offered. (i.e.

Monthly, Quarterly, Semi-Annual,

Annual)

Option_Instructions Text Text explaining payment options.

NOTE: There are 2 merge fields that

can be included with this text:

• ~amount~ -- Amount of each

payment in dollars and cents

• ~numpayments~ -- number of

payments (including current

payment)

Num_Installments Number Number of installments in the plan.

Surcharge_Per_Period Number Surcharge amount added to each

payment.

Surcharge_Product_Code iMIS Dues Product Code This is the iMIS dues product code to

charge a surcharge when someone

selects to do multiple payments.

This is typically a MISC dues item.

Draft_Day Number Day auto-draft will occur.

Product_Code_Restriction List of restricted dues

products

This is a comma-delimited list of

product codes that can use this

payment plan. You can use a

wildcard such as CHAPT/* for

matching. When specified, the

payment plan will only be allowed if

the products for that person are ALL

included in this list. If the person

has any product code in their

join/renewal that is NOT in this list

then they will not be able to select

that payment plan. A blank value

P a g e | 261


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


means that this feature will be

ignored.

Product_Cat_Restriction List of restricted product

categories

This is a comma-delimited list of

product categories (product type

code) that can use this payment

plan. The possible entries are DUES,

CAHPT, SEC, MISC, SUB, VOL.

When specified, the payment plan

will lonely be allowed if the products

for that person have product type

codes that are included in this list. If

a person has any products in their

join/renewal that has a product type

code that is NOT in this list then they

will not be able to select this

payment plan. A blank value means

this feature is ignored.

Member_Type_Restriction List of member type codes This is a comma-delimited list of

member type codes that can use this

payment plan. You can use a

wildcard such as M* for matching.

Some possible uses for this are to

have different plans available to

different member types (i.e. the

monthly payment plan is not

available to students). In addition

you have the same type of plan (i.e.

monthly) and have different text or

surcharges based on member types

as well. For example, you can add a

line in ATS_PAYMENT_OPTIONS with

an OPTION_CODE of 1M (for

monthly) and limit that to all

member types except student

members. Then add a link with a

OPTION_CODE of 1MSTU and make

that available to students only. Each

line can have its own text and

surcharges or no surcharge.

Allow_Auto_Renewal Checkbox Check this box to allow for auto-

renew.

P a g e | 262


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


Require_Auto_Renewal Checkbox Check this box to require auto-

renewal. Members will be forced to

setup auto-renew.

Renewal_Instructions Text Text displayed at top of auto-renew

section.

Auto_Renewal_Text_Yes Text Text displayed on button for user to

select auto-renew.

Auto_Renewal_Text_No Text Text displayed on button for user to

opt out of auto-renew.

This table will most-likely have multiple rows – each row defines the payment plan offered.

STORE_SETTINGS

There are numerous Store_Settings that also control this functionality:


ConfigDuesMangerID iMIS ID ID number of record that controls all

options for payment options.

Typically, this is the iMIS manager

ID.

PaymentCCSavedCards True/False

*Only for use with Online

Auto_Draft

True: Displays credit cards saved in

Auto-Draft at payment time.

False: Does not display cards saved

in Auto-Draft.

PaymentOnlineAutoDraftEnabled True/False

*Only for use with Online

Auto_Draft

True: Indicates Online Auto-Draft is

enabled.

False: Indicates Online Auto-Draft

is not enabled.

PaymentPlanAvailableButtonText Text Text displayed on button in cart to

open payment plan window.

PaymentPlanDisclaimerText Text Text on the button that will appear

up on the payment screen when

someone can select a payment plan.

PaymentPlanEditButtonText Text Text displayed on button in cart to

edit payment plan.

P a g e | 263


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org


PaymentPlanHasPaymentPlanText Text Text that displays when a person

tries to renew online but already has

a payment plan.

EXPLANATION OF FIELDS:

EXAMPLES

ENROLL IN ONLINE AUTODRAFT

Here are some example screenshots of the user experience.

Once the user has gone through the dues join/renewal wizard in the Online Marketplace and has dues in the

cart they will be displayed a button to add a payment plan and if Online Auto-Draft is configured and

enabled they will also see saved payment methods available as well as the ability to add a new credit card.

P a g e | 264


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 265


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

When the user clicks the ‘Add a payment plan’ button they are presented the payment options configured in

the ATS_Payment_Plans table.

P a g e | 266


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Once the options are saved, they are returned to the cart screen where they can either edit their payment

plan selection or continue the checkout process.

ALREADY ENROLLED IN AUTODRAFT

If a member attempts renew online but is already enrolled in AutoDraft they are displayed the text in the

PaymentPlanHasPaymentPlanText entry in the Store_Settings general lookup table.

P a g e | 267


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SAVE CREDIT CARDS

In addition to offering payment plans for dues payments you can also allow saving of credit card

information. There are 2 Store_Settings that control this functionality.

• PaymentCCSaveCards – True/False setting to enable/disable saving of credit cards that are displayed

in the payment screen for quicker checkout.

• PaymentCCSaveCardReqCVV – True/False setting to enable/disable the requirement of the CVV

number on the back of the credit card. If set to false, to not require the credit card will be charged

without sending the CVV number that may result in additional credit card fees.

When a customer goes to checkout they are presented their saved credit cards for use at checkout.

LICENSING CHECK

In the administrative portal under the Verify page is a check for licensing. If the ATS license for enSYNC

Online AutoDraft is not in place a warning will display:

If the enSYNC Online AutoDraft license is not valid payment plans and the ability to save/retrieve credit

cards is disabled.

P a g e | 268


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

DONATIONS

There are two different options for donations in the Online Marketplace. The donation page is donation.aspx.

1. Allow Voluntary (VOL) Dues Items

2. Allow Fund Raising Items

Fund Raising options require purchasing the Donations Module for the Online Marketplace from ATS and that

you own the iMIS Fund Raising and eDonation modules.

There are a few Store_Settings that control donations:

• ConfigDonationsBannerURL – This is the URL to a custom html banner on the donation.aspx page.

• lblDonations – label that displays on the donation.aspx page.

• ReceiptAlwaysEmailDonations – True/False setting. True will email the person a receipt after each

donation. False will not email a receipt but direct them to the myorders.aspx page to self-manage their

receipts.

• ShowDonationsAtCheckout – None, Always or Once are the options for this setting that controls how

many times during a session a person is directed to the donation.aspx page before going to the

checkout page.

• ShowFRAppealsAtCheckout – True/False setting. True shows any Distribution Codes assigned to the

appeals entered in the Store_Fundraising_Appeals general lookup table. False shows no Fund Raising

Distributions.

• ShowFRVOLDuesAtCheckout - True/False setting. True shows any VOL Billing products set to ‘Accept

Payments on the Web’ on the donation.aspx page. False displays no VOL Billing products.

P a g e | 269


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

VOL Dues Product Setup

In iMIS go to Billing>>Set up module>>Products.

1. Create product(s) with a Product Type of VOL.

2. Set the Member/Nonmember price to the suggested donation price (optional).

3. Check the ‘Accept Payments on the Web’ box.

4. Pay Priority controls the sort of these products on the donation.aspx page.

5. Optional – Setup the Store_Donation_VOLProductCodes general lookup table to limit VOL products

displayed. See the section Table: Store_Donation_VOLProductCodes for more information about setup.

P a g e | 270


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Fund Raising Product Setup

In iMIS go to Fundraising>>Set up tables>>Distributions and premiums

1. Create a new distribution.

2. Set the Appeal to one of your Appeals in the Store_Fundraising_Appeals General Lookup table (see

Table: Store_Fundraising_Appeals, Table: Store_Fundraising_Mappings and Table:

Store_Fundraising_Options for more information about setup).

3. The Gift Amount will be the suggested amount.

P a g e | 271


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Donation Page

Donation.aspx

P a g e | 272


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ONLINE MARKETPLACE BEHAVIOR

This section describes how the Marketplace reacts to specific activities.

Store Banner

The Online Marketplace can display a banner on the homepage. This is typically a piece of HTML content

approximately 640 x 301. This can be static content can be used to promote your organization or it can be

scrolling content that rotates to display multiple items.

The ConfigStoreBannerURL entry in the Store_Settings general lookup table will contain the URL to your

store banner.

EXAMPLES

Static Banner

Rotating Banner

P a g e | 273


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Responsive Design

ATS has implemented additional stylesheet components to support responsive design. Many tables have been

changed to div tags. The site will still function the way it has in the past. If you have customized your styles in

the override.css file then some of those styles may need to be modified as some of the elements have

changed their class name to accommodate the responsive design. Please plan to review your site when it gets

upgraded. There are still some interior components that are using tables and they will be changed to div’s in

future releases.

Add to Cart Modal Window

When a customer adds an item to the cart the will see a pop-up that displays their cart summary and

options to continue shopping, view cart/checkout, or pay now.

Checkout, Receipt, and Welcome Messages

This feature allows you to specify a title and text for a popup box based on the iMIS ID number of the person

logged in and an IQA query.

STORE_SETTINGS THAT CONTROL THIS FEATURE:

• StoreMessageIQA – Full path and name of IQA query. If the person is not logged in they will not see

any of the messages. If they are, they will see the message defined in the IQA. The query must have

four fields. The first filter must be a required filter on the iMIS ID number.

o ID – iMIS ID of the person and must be the first required filter

o TITLE – title that will show up at the top of the popup box

o MESSAGE – message that will display in the popup box

o LOCATION – location and type of page that the message will be shown on. This can have one

of three values and must be set to one of these: CHECKOUT, RECEIPT, WELCOME.

• ShowStoreCheckoutMessage - This can be set to NEVER, ONCE, or ALWAYS. If set to NEVER it will not

show at all. If it is set to ONCE or ALWAYS, and the IQA is specified, and there is a row in the IQA for

the person with a location of CHECKOUT, then the message will show on the receipt page. If set to

P a g e | 274


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ONCE it will show once per browser session with a cookie. When the person closes the browser, the

cookie will be reset, and it will be shown again. Setting it to ALWAYS will result in it being shown on

all checkout pages. As a best practice we recommend setting this to ALWAYS.

• ShowStoreReceiptMessage - This can be set to NEVER, ONCE, or ALWAYS. If set to NEVER it will not


the person with a location of RECEIPT, then the message will show on the receipt page. If set to




• ShowStoreWelcomeMessage - This can be set to NEVER, ONCE, or ALWAYS. If set to NEVER it will not


the person with a location of WELCOME, then the message will show on the receipt page. If set to




SAMPLE SQL VIEW FOR BUSINESS OBJECT/IQA:

The following is an example of a SQL view that can be made into a business object and then IQA. The view

suppresses the store anonymous user record (ConfigAnonymousUserID Store_Setting), in some cases. It will

show a welcome message to people who first visit the site, then a message to join if the person is not a

member and goes to the checkout page, and finally, a thank you message on the receipt page.

create VIEW [dbo].[vw_ATS_StoreMessage] as

SELECT Name.ID,

'Save Now!' as TITLE,

'You could save by becoming a member. Click <a href="/dues.aspx">here</a> to find out more!' as MESSAGE,

'checkout' as LOCATION

FROM Name

WHERE Name.ID != '285'

AND Name.MEMBER_RECORD = 0

AND NOT EXISTS (SELECT * FROM ATS_SHOPPING_CART CART WHERE CART.ID = Name.ID

AND CART.ST_ID = Name.ID AND CART.PROD_TYPE = 'DUES')

UNION

SELECT Name.ID,

'Thank you for your purchase!' as TITLE,

'We appreciate your business!' as MESSAGE,

'receipt' as LOCATION

FROM Name

UNION

P a g e | 275


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SELECT NAME.ID,

case when Name.ID != '285' then 'Thank you for visiting our store. Login to get the best member pricing!'

else 'Thank you for visiting our store, ' + case when Name.INFORMAL <> '' then Name.INFORMAL else

Name.FULL_NAME end + '!' end as TITLE,

'Check out our specials!' as MESSAGE,

'welcome' as LOCATION

FROM Name

IQA SETUP:

P a g e | 276


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 277


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLES:

When a non-logged in person first comes to the Marketplace, they would see this:

Logged in user welcome message:

P a g e | 278


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Nonmember checkout message:

Receipt message:

One-Click Checkout

Customers with items in their cart that have no fee and do not require shipping or tax will be presented

with a button to immediately checkout. After clicking the place order button, they will see the receipt.

This is an excellent option for free PDF documents or free webinars. To change the label on the Place Order

button update the lblCheckout setting in the Store_Settings general lookup table.

Use Parent Company Pricing

When ‘Use Parent Company Pricing’ is enabled in iMIS under Customers>>Set up

module>>General>>Advanced the following rules apply:

P a g e | 279


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

1. Works only with Orders and Events (no Dues/Donations).

2. The individual will always see pricing based on the company member type, even if the company is a

nonmember and the individual is a member.

3. Stored procedure pricing will always override member/nonmember pricing for products and events

whether this is enabled or not.

4. If a company is a nonmember and the company has dues in the cart, individuals linked to the company

also qualify for member pricing.

Staff Processing: Impersonation/On Behalf Of

Staff can impersonate iMIS contacts from the administrative portal. When a contact is impersonated,

navigating back to the store processes transactions as if the user were logged in themselves. Additionally,

the staff site buttons can be modified to hold On Behalf Of to process transactions in the Online

Marketplace.

Once logged into the administrative portal (see the section Table: Access_Keywords section in this

document for additional information), click the Impersonate logging in as someone link.

P a g e | 280


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Enter the ID of the record you want to impersonate, or for testing purposes you can select a random ID from

the list presented.

A notification will display indicating the ID being impersonated.

Next, click the Store Home button to return to the Online Marketplace and perform transactions. A

notification bar will display indicating to the staff person who they are impersonating. Any transactions

processed will send email receipts/confirmations to the iMIS record being impersonated.

P a g e | 281


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

The iMIS staff site can also be modified to honor the On Behalf Of functionality.

Buttons in the staff site are then modified to go to the Online Marketplace to shop rather than using the

RiSE store/cart.

Staff Email Notifications and Error Reporting

The Online Marketplace can generate emails to staff based on activity in the Online Marketplace. ATS staff

can assist you with these settings.

• Events - set the ‘Event Contact’ under More>>Web options to the ID of the staff person you want to

receive copies of all registrations.

• All Online Marketplace Transactions – there is an entry in the appSettings.config file where the Online

Marketplace is installed. Edit this entry to add the email address(es) you want to receive email copies

of all receipts generated from the Online Marketplace:

P a g e | 282


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

o <add key="EmailBCCAddresses" value="[email protected]"/>

• As of September 2019, the ErrorstoEmail entry in the appSettings.config file has been deprecated and

there are many new error reporting settings. These are explained below:

o 

o <add key="ATS.Utilities.ErrorHandler.EnableAutomaticErrorReporting" value="false" />

▪ When true, will enable ELMAH to handle all uncaught exceptions, and log them silently

to the central ATS WCF service/ELMAH database. Also, enabling this flag allows for

custom error reporting by ELMAH, Windows Event Log, and/or E-mail.

▪ Default value is false. Parameter is not required.

o <add key="ATS.Utilities.ErrorHandler.LogToELMAH" value="false" />

▪ When the global EnableAutomaticErrorReporting (above) is true AND this is true,

enables logging to ELMAH via the ATS WCF service.

▪ Default value is true. Parameter is not required.

o <add key="ATS.Utilities.ErrorHandler.LogToWindows" value="false" />


enables logging to the Windows Event Log.


o <add key="ATS.Utilities.ErrorHandler.WindowsLogSource" value="Miscellanous" />

▪ Sets the Source to be used in the Windows Event Viewer for log entries. Requires

EnableAutomaticErrorReporting and LogToWindows to be "true". Entries are logged

under the custom ATS application, so that should be configured on the server before

enabling this option, or an error may occur.

▪ Default value is "Miscellaneous". Parameter is not required.

o <add key="ATS.Utilities.ErrorHandler.WindowsLogEntryType" value="Information" />

▪ Sets the default Event Viewer entry type to be used in the Windows Event Viewer for

log entries. Requires EnableAutomaticErrorReporting and LogToWindows to be "true".

Entries are logged under the custom ATS application, so that should be configured on

the server before enabling this option, or an error may occur.

▪ Default value is "Information". Parameter is not required. Valid options are: Error,

FailureAudit, Information, SuccessAudit, Warning.

o <add key="ATS.Utilities.ErrorHandler.LogToEmail" value="false" />


enables logging to an e-mail. The SMTP parameters will be used from the system.net

settings in the web.config.


o <add key="ATS.Utilities.ErrorHandler.EmailToAddress" value="" />

▪ Sets the e-mail address to which error reports should be sent. This parameter may be

a semi-colon or comma-separated list of e-mail addresses. This parameter will only be

used if EnableAutomaticErrorReporting and LogToEmail are set to "true".

▪ There is no default value - if EnableAutomaticErrorReporting and LogToEmail are

"true" and this setting is not set, a SettingsPropertyNotFoundException will be thrown.

o <add key="ATS.Utilities.ErrorHandler.EmailSubject" value="Error Occurred in a Web

Application" />

▪ Sets the subject for the e-mail error reports. This parameter will only be used if

EnableAutomaticErrorReporting and LogToEmail are set to "true".

P a g e | 283


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

▪ Default value is "Error Occurred in a Web Application". Parameter is not required.

P a g e | 284


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Your Price

Your Price functionality allows you to choose how pricing is displayed. Your Price shows the price of the person

logged in. If no one is logged in then Your Price is the price of the anonymous user. People have the ability to

turn Member Price, Non Member Price, and Your Price on/off. This can be used in situations where the client

only has one price in the database. In addition, there is also a parameter called

ShowOnlyYourPriceWhenLoggedIn. When set to true, it will only show the Your Price value if the person is

logged in and automatically hide the nonmember and member price. This will show the Your Price even if Your

Price is turned off in the other settings.

These entries in the STORE_SETTINGS table control all of the pricing display options:

Entry Purpose

LblYourPrice this is the label that displays on the screen when you enable Your Price

ShowProductsMemberPrice true/false – if true shows the member price in the product detail,

product detail brief, highlights, recently viewed, and specials

ShowProductsNonmemberPrice true/false – if true shows the nonmember price in the product detail,

product detail brief, highlights, recently viewed, and specials

ShowProductsYourPrice true/false – if true shows Your Price in the product detail, product detail

brief, highlights, recently viewed, and specials

ShowEventsMemberPrice true/false – if true shows the member price in the event detail brief,

highlights, recently viewed, and specials

ShowEventsNonmemberPrice true/false – if true shows the nonmember price in the event detail brief,

highlights, recently viewed, and specials

ShowEventsYourPrice true/false – if true shows Your Price in the event detail brief, highlights,

recently viewed, and specials

ShowOnlyYourPriceWhenLoggedIn true/false – if true, and the person is logged in, it will hide the member

and nonmember price and only show the Your Price value

P a g e | 285


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

EXAMPLES

This example shows the Online

Marketplace home page before a person

has logged in:

This example shows the Online

Marketplace home page after a person

has logged in:

P a g e | 286


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Personal Coupons

Personal coupons allows you to display coupons that a customer is eligible for on the view cart page. There

are several Store_Settings that control the behavior of this functionality.

▪ ShowPersonalCoupons – True/False setting to turn on this functionality.

▪ lblCoupon – Word(s) that will be using in the Marketplace when referring to the

coupon. Default value is ‘Coupon.’

▪ lblPersonalCouponHeader – Header text for the coupon popup for personal coupons.

Default value is ‘Personal Coupons.’

▪ lblPersonalCouponInstructions – Text displayed on the coupon popup for personal

coupons. Default value is ‘Select coupons by checking the box next to the coupon.’

▪ lblPersonalCouponFooter – Footer text for the coupon popup for personal coupons.

Default value is ‘Select APPLY to add these coupons to your cart.’

▪ lblPersonalCouponLinkText – Text that displays on the view cart page to pop-up

personal coupons box. Default value is ‘View Personal Coupons.’

P a g e | 287


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Only coupons that include the customer’s ID in the Ship To ID Restriction field in the coupon will be

displayed. Coupons with nothing in the Ship To ID Restriction field will not be displayed in the personal

coupons box.

ATS also has a webservice that can create coupons based on an IQA. Please email [email protected] for help

with this utility.

Restricted by ID:

ID’s can also be listed as a comma-separated list.


P a g e | 288


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

The customer will be presented with this view:

They check the box(es) of the coupons they want to apply to the cart and click Apply.

NOTE: In order for someone to add multiple coupons to their cart each coupon must be marked as ‘Is

Stackable.’

P a g e | 289


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SEARCHING IN THE ONLINE MARKETPLACE

There are several different ways to perform searches in the Online Marketplace:

• Using the Search box • Using the Tag Cloud • Using Auto Search

Searching Products in the Marketplace

This is a list of fields in iMIS that are searched when a customer performs a search on the site:

• DESCRIPTION

• WEB DESCRIPTION

• CATALOG DESCRIPTION

• OTHER DESCRIPTION

• TITLE

• PRODUCT CODE

• AUTHOR

• PUBLISHER

• ISBN

• FORMAT

Searching Events in the Marketplace

This is a list of fields in iMIS that are searched when a customer searches for an event. It will search for all

words (in any order) in:

• TITLE

• DESCRIPTION

• NOTES

• ADDRESS

• EVENT CODE

In addition, it will search for all words in the following for each function. If one function in the meeting is set

to Show on Web and contains the search words, then the meeting will be returned in the search results.

• DESCRIPTION • TITLE • SPEAKER NAMES

Search Results Display Control

The Store_Setting IntSearchRecordsPerPage is where you will enter a number that controls how many results

are returned per page on a search. If the results are greater than that number the customer will be displayed

with current page, previous page and page number indicators to browse the results.

P a g e | 290


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Tag Cloud

Tag Cloud functionality allows you to show most popular words in a

cloud with weighting for more frequently used words. The Tag Cloud

will create a list of words from iMIS Products and Events. It searches

all searched fields including authors and presenters. Words that appear

more frequently will be displayed with a larger font.

In the Administrative Portal you can create the custom table and stored

procedure to build the cloud. To access the Administrative Portal go to

your store /store/admin (i.e. http://www.atsol.org/store/admin). If you

are not already logged in you will be taken to a login page. Once

logged in, any user with the ATSStoreAdmin Access Keyword will be

directed into the administrative portal.

Click On the Setup link and click Verify:


P a g e | 291


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Click Create to build the table and stored procedure.

You will also need to create the Store_Search_Keyword_Exclude General Lookup table to exclude words you

do not want included in your Tag Cloud. This can also be created from this same screen. In the ‘Optional

General Lookup Tables’ section click the Edit button next to the Store_Search_Keyword_Exclude entry and you

will be taken to a screen to manually create entries in the table. You can also create this in iMIS under

Customers>>Set up tables>>General Lookup/Validation.

In addition, click the ‘Add Top 150 English Words’ button to add the most common words in the English

language. This list is compiled from http://www.world-english.org/english500.htm.

http://www.world-english.org/english500.htm

P a g e | 292


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

ADMINISTRATIVE PORTAL TABLE UPDATES

Create entries in STORE_SEARCH_KEYWORD_EXCLUDE General Lookup Table. Click Add New Record:

Enter the word to be excluded in the

Code box and leave the Description

blank. Click Insert to complete the

action.

There are also several entries in the Store_Settings General Lookup table that help manage the Tag Cloud:

• SHOWTAGCLOUD when set to true will show the tag cloud (Boolean: Default true)

• LBLTAGCLOUD label that will show at the top of Tag Cloud (String: Default Keywords)

• INTMAXTAGCLOUDITEMS maximum number of cloud keywords to display (Number: Default 30)

CUSTOM FUNCTIONS

There are two custom functions required for this functionality to work: ATS_GETCHARACTERS and

ATS_STRIPHTML. These are typically created by ATS or your iMIS reseller on new installation but you can

also create these from the Administrative Portal under Setup>>Verify.

P a g e | 293


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Auto-Searching

You can also turn on the ‘Auto-Search’ functionality in your Online Marketplace. This will use the Search

button and as customers type letters into it a drop-down will display of the possible items they could be

searching for. This functionality uses the same settings, tables, stored procedures and functions as the Tag

Cloud above with the addition of the Store_Setting entry below which turns on this functionality.

You must create the ATS_CONTENT_KEYWORDS custom table as explained in the previous section - Tag

Cloud.

Store_Setting – SHOWAUTOTEXTBOXSEARCH – Set this to true to enable your Search box to display a drop-

down of possible searches as customers type letters into the Search box.

NOTE: The Auto-Search drop-down will not display until 3 letters are typed into the search box.

P a g e | 294


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

HOW IMAGES WORK

The default image for a product’s detail is the main image. If it doesn’t exist then we look for a thumbnail image and use that. If it doesn’t exist the default image (URLProductImageNotFound) entered into Store_Settings is used.

For Best Sellers, Featured Items, Newest Items, Search Results, etc., the default is the thumbnail image if it exists. If it does not then we look for the full image. If that doesn’t exist then the default image (URLProductImageNotFound) entered into the Store_Settings is used.

IMMEDIATE ADD TO CART

Immediate Add to Cart functionality allows you to distribute a URL that will automatically add an item or items

to a person’s cart. This functionality exists for Orders and Events only. By appending

addtocart.aspx?id=PRODUCT_CODE the product will be dropped into the cart when the person clicks on the

link you provide.

Product (Orders) Examples:

www.yourstore.org/store/addtocart.aspx?id=BOOK1 will add Book 1 to the cart.

www.yourstore.org/store/addtocart.aspx?id=BOOK1,BOOK2 will add Book 1 and Book 2 to the cart.

• If you add a product to the cart and the person already has that item in the cart the quantity will be

increased by 1 unless it exceeds the available inventory.

Registration (Events) Examples:

www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN will add the REG_MAIN function for the

Webinar 1 event to the cart.

www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN,WEBINAR2/REG_MAIN will add the

REG_MAIN function for the Webinar 1 and Webinar 2 events to the cart.

• If you add a registration to the cart and the person already has that event in their cart, the original

functions for the event will be removed and the one you reference in your URL will be added.

• Any functions you have setup as required will be ignored using this functionality.

• Event codes (not including the function code) cannot be longer than 10 characters in the querystring.

Billing Item Examples:

www.yourstore.org/store/addtocart.aspx?id=CHAPT/DALLAS will add the Dallas Chapter to the cart.

www.yourstore.org/store/addtocart.aspx?id=FINC will add the Billing product FINC (SEC) to the cart.

http://www.yourstore.org/store/addtocart.aspx?id=BOOK1

http://www.yourstore.org/store/addtocart.aspx?id=BOOK1,BOOK2

http://www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN

http://www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN

http://www.yourstore.org/store/addtocart.aspx?id=CHAPT/DALLAS

http://www.yourstore.org/store/addtocart.aspx?id=FINC

P a g e | 295


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

• Billing item types included: CHAPT, MISC, SEC, SUB, VOL

• Rows must be included in the ATS_DUES user-defined table for each individual product you will use.

See the section Setup in Dues for more information. This is not designed to work for a join or renewal

as this process does not update Member Type or Paid Through Date. It only adds a new item to the

person’s subscription collection (i.e. add a chapter or section, make a donation, subscribe to journal).

Include a Coupon:

You can also include a coupon code with addtocart.aspx.

www.yourstore.org/store/addtocart.aspx?id=BOOK1,10OFF will add Book 1 and the 10OFF coupon to the cart.

www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN,WEB15 will add the REG_MAIN function

for WEBINAR1 and the WEB15 coupon to the cart.

www.yourstore.org/store/addtocart.aspx?id=CHAPT/DALLAS,FREECHAPT will add the Dallas chapter and a

coupon for a free chapter to the cart.

If an item should not be in the cart because the person is not eligible to buy it, the event is over, or some

other reason, the standard Online Marketplace functionality will remove the item from the cart and display the

standard ‘this item has been removed from your cart for the following reason...’ message.

If a person adds an item to the cart and does not check out but comes back later and something on their

record changes what they should be charged for an item(s), the item(s) in their cart will be re-priced.

http://www.yourstore.org/store/addtocart.aspx?id=BOOK1,10OFF

http://www.yourstore.org/store/addtocart.aspx?id=WEBINAR1/REG_MAIN,WEB15

http://www.yourstore.org/store/addtocart.aspx?id=CHAPT/DALLAS,FREECHAPT

P a g e | 296


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SOURCE CODES

The Online Marketplace allows you to setup Source

Codes for tracking transactions. All of your source codes

must exist in the iMIS SOURCE_CODE General

Lookup/Validation table.

Once defined in the SOURCE_CODE table, there are two

STORE_SETTINGS to control behavior:

• ConfigPaymentSourceCode – This is the name of the source code that will be set as the default source

code on all transactions in the Online Marketplace. The default is set to WEB.

• ConfigPaymentSourceCodeParameter – This is the name of the parameter to be used in the URL to set

a different source code for transactions. Default is PROMO.

You could send out an emailing that includes a link to a specific product in your Online Marketplace and

include in the URL the source code to assign to the transactions from that link.

http://store.mystore.org/default.aspx?PROMO=SPRING2013 – This link would direct a person to the Online

Marketplace home page and assign the source code on any transactions as SPRING2013.

http://store.mystore.org/registration.aspx?eventcode=ANNUAL&PROMO=SPRING2013 – This link would direct

a person to the page for the Annual Meeting and assign a source code of SPRING2013 to any transactions that

result.

http://store.mystore.org/default.aspx?PROMO=SPRING2013

http://store.mystore.org/registration.aspx?eventcode=ANNUAL&PROMO=SPRING2013

P a g e | 297


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

GOOGLE ANALYTICS ECOMMERCE TAGS

The Online Marketplace can support tracking via Google Analytics. There are several Store_Settings that need

to be configured to turn this feature on:

ConfigGoogleAnalyticsAnonymizeIP

True or False True – Google Anonymizer code will

be added to the script that gets added

to the page

False – No anonymizer added to page

ConfigGoogleAnalyticsEnhancedECommerce

True or False True – Google Analytics Enhanced

eCommerce Tags added.

False – Google Analytics tags not

added.

ConfigGoogleAnalyticsTrackingID Google Analytics

Tracking ID

Enter the Google Analytics Tracking ID

for your website.

ConfigGoogleTagManager

True/False True – Turns on inclusion of Google

Tag Manager

False – Does not include Google Tag

Manager

ConfigGoogleTagManagerIdentifier

Number Obtained from Google (obtained from

https://tagmanager.google.com)

The following tags are being tracked:

IMPRESSIONS

• Featured Items

• Best Sellers

• Newest Items

• Product Recommendations (people who bought this bought that)

• Upsell

• Cross-sell

• Search Results

• Calendar Views

PRODUCT DETAIL

• Products

• Events

• Subscriptions

ADD TO CART

• Products

• Events

https://tagmanager.google.com/

P a g e | 298


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

• Subscriptions

• Dues

• Donations

OTHER

• Remove From Cart

• View Cart

• Checkout

• Payment

• Purchase

P a g e | 299


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TESTING YOUR MARKETPLACE SETUP

A very important part of implementing your online marketplace is testing its functionality. Here are some

suggested tests.

• Process a transaction using each type of credit card you accept.

• Enter a meeting registration

• Enter a product order

o Enter an order for a kit item

• Enter a dues payment

• Enter donations with and without tributes

• Enter combination transactions:

o Registration, Order, Dues Payment, Donation

o Registration, Order

o Registration, Dues Payment

o Registration, Donation

o Test each combination of offerings from your marketplace

• Test a transaction with a coupon payment

• Be sure to finalize the transactions in iMIS by posting batches and invoicing orders to ensure the

transactions complete the way you expect them to.

• When testing and making setting changes you may need to recycle the application pools to see the

changes immediately.

THINGS TO KNOW ABOUT IMIS WEB TRANSACTIONS

• Product orders are created as Pro-Forma (quotes)

o You must convert them from quotes to orders (Orders>>Process Orders>>Convert Quotes)

o Until the batch is posted, the Trans records are not created.

• For dues payments, you must post your batch before you see the payment transactions and paid thru

date advancement.

• For event registrations, you must post your batch before you see the registration transactions created.

• If events have negative-fee functions it is allowable to let someone checkout but it will not credit the

credit card, rather it will create a credit on the account for future refund.

• Coupons will never create a cart with a credit balance. If the full amount of a coupon cannot be used

the amount of the coupon is reduced.

P a g e | 300


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

CREDIT CARD PROCESSING

The Online Marketplace has an entry in the appSettings.config file called CCDEMOMODE. When this is set to

True no credit card processing takes place; nothing is sent to your payment processor at all and all

transactions will succeed without error. When the CCDEMOMODE is set to True a message is displayed on all

screens indicating this setting. The message can be dismissed for testing but ultimately a live store must

have the CCDEMOMODE set to false. An application pool recycle is required after making this change.

Store Pages:

Admin Portal:

Standard Processing

The processing of credit cards in the Online Marketplace uses the following steps. The reason for the three-

step process is to minimize the amount of charges on a client’s credit card when processing errors occur.

1) Authorization – This authorization at PayPal authorizes that the credit card has enough money on it. If

someone wants to make a $100 purchase then the Online Marketplace makes a call to PayPal to

determine if there are enough funds. If there are, we move to step 2. If not, then PayPal returns an

error code (e.g., declined) and that is presented to the web user with the information. Inside of PayPal

you will see a corresponding Authorization with a status of Declined. If for some reason the system is

not able to connect to PayPal the end user will receive an error on the screen and an email will be sent

to the ‘errrorsto’ email setup in the configuration with the details about the error.

2) Process the payment and transaction in iMIS. In this step, the Online Marketplace takes the

authorization code returned from iMIS and creates a transaction in iMIS. That could be a product order,

event registration, dues payment, or donation. The system will attempt to contact the iMIS database

which will return a success or failure status. A failure status can occur when the server cannot contact

your iMIS server, when there is a problem with the transaction (e.g., someone just deleted a product),

or if there is a problem with the purchasers record (a corrupt iMIS record). These are some of the

P a g e | 301


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

items that can return a bad status code. If a bad status code is returned from iMIS an error is

displayed to the person on the screen and the credit card authorization is VOIDED. In this case where

there is an error PayPal will result in Authorization and a Void. In unusual situations the error is fatal

enough that the void cannot be sent to PayPal. Upon successful completion though the process moves

on to the third step.

3) Delayed Capture. In the case of a successful step 2, a Delayed Capture request is sent to PayPal. In

this situation the funds are actually charged to the card and the transaction is complete. It is rare but

can happen that the delayed capture cannot be processed. In this situation an error is displayed to the

person and an email is sent to the staff member(s) identified in the appSettings.config file setup in the

configuration with details about the error. See the Staff Email Notifications and Error Reporting

section to configure these important settings.

Other Factors

Other factors that affect this processing include server performance and connectivity issues. If for example the

server cannot connect to the payment gateway, then variations to this process can occur. Additionally, if the

IIS server has an issue (e.g., the application pool recycles in the middle of this process) then other items can

be seen as issues.

P a g e | 302


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Troubleshooting

To troubleshoot this process, you should always look at your payment processor and you should see a pair of

transactions.

• An Authorization and a Delayed Capture – successful transaction

• An Authorization and a Void – failed transaction

If you do not see a pair of entries on the processor website, then check the emails sent to the email

address(es) setup in the appSettings.config file. Please refer to the Staff Email Notifications and Error

Reporting section to configure these important settings.

Here is an example of what is reported on the manager.paypal.com site for successful transaction:

Note the authorization and delayed capture entries. If the transaction had failed, you would see an

authorization and a void.

CUSTOM ERROR MESSAGE

There is an entry in the Store_Settings general lookup table called lblErrorText that lets you configure an

message that is displayed when an error occurs. The default for this setting is: A copy of this error has

been sent to the administrator. If this occurred during checkout, please contact the office before

resubmitting your payment.

Flowchart of Credit Card Process

P a g e | 303


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Start

Perform Authorization at

Payment Processor

Was Authorization Successful?

Display Error to web user and email staff

Stop

No

Process Transaction in iMS

Yes

Was Transaction Successful?

Process Void at Payment Processor


No

Perform Delayed Capture at Payment

Processor

Yes

Was Delayed Capture

Successful


No

Yes

ATS Standard Credit Card Processing Methodology

P a g e | 304


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

IMIS USER SECURITY LEVELS

In order to perform the maintenance for the Online Marketplace, users will need minimum security levels set

on their logins in iMIS. Security levels are maintained by the MANAGER login in iMIS.

iMIS 15 & 20

Customers>> Find user record>>Click User Credentials button and expand the Staff Access section:

P a g e | 305


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 306


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

iMIS 10

File>>System Setup>>User Passwords

P a g e | 307


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Modules

CUSTOMERS

Users will need a level 5 access level in order to see the Set Up Tables menu. Level 8 will give users access to

the Set Up Module and Utilities menus.

EVENTS

Users will need a level 5 to access the Set Up Tables menu and level 8 to setup Events and Set Up Module

menu.

AR/CASH


the Set Up Module menu.

ORDERS


the Set Up Module menu.

BILLING

Users will need a level 5 to see the Set Up Module menu.

FUND RAISING

Users will need a level 5 access level in order to see the Set Up Tables and Set Up Module menus.

P a g e | 308


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

USER-DEFINED TABLES

User-defined tables are typically installed when the Online Marketplace is installed or updated. This section is

for reference only.

User-defined table names

• ATS_Checkout_Windows

• ATS_Dues

• ATS_Shopping_Cart

• Coupons

• Product_ReviewComment

• Product_Reviews

P a g e | 309


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: ATS_Checkout_Windows

P a g e | 310


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: ATS_Dues

P a g e | 311


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 312


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 313


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 314


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: ATS_Payment_Options

P a g e | 315


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 316


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: ATS_Shopping_Cart

P a g e | 317


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 318


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 319


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 320


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: Coupons

P a g e | 321


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 322


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: Product_ReviewComment

P a g e | 323


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

User Defined Table: Product_Reviews

P a g e | 324


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

USER-DEFINED WINDOWS (TABS)

User-defined windows are typically installed when the Online Marketplace is installed or updated. This section

is for reference only.

WINDOW NAMES

• Name-ATS_Checkout_Windows

• Name-ATS_Dues

• Name-ATS_Shopping_Cart

• Name-Coupons

• Name-Product_ReviewComment

• Name-Product_Reviews

P a g e | 325


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 326


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 327


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

P a g e | 328


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SQL SERVER SETUP

This setup is typically performed by ATS when installed the Online Marketplace. The following sections are for

reference only.

Two stored procedures are created, as well as two jobs that will call those stored procedures on a daily basis.

The two stored procedures that need to be created are “ATS_BUILD_PRODUCT_BEST_SELLERS” and

“ATS_BUILD_PRODUCT_RECOMMENDATIONS.” These procedures do exactly as their names imply.

Best Sellers Stored Procedure

1. Open SQL Server Management Studio and log in with an account that has administrative rights

2. Find the database being used by iMIS in the “Object Explorer” and expand it

3. A list of folders will appear below the database, click on and expand the one that says

“Programmability.”

4. Again, another list of folders will appear, this time underneath the “Programmability” folder. Find and

right-click the folder called “Stored Procedures.”

5. In the fly out menu select the “New Stored Procedure” option. At this point a new window pane will

open up with some auto-generated text for creating a new store procedure.

6. Select the entire block of text and replace it with the code below.

7. Go to the top of the newly pasted code and find the line that says “USE [ATS].”

8. Replace the “ATS” within the brackets with the actual name of the database, as seen in the object

explorer.

9. The stored procedure is now ready to be created. Click the “Execute” button to build.

USE [ATS]

GO

/****** Object: StoredProcedure [dbo].[ATS_BUILD_PRODUCT_BEST_SELLERS] Script Date: 08/02/2010 16:28:27 ******/

SET ANSI_NULLS ON

GO


GO

-- =============================================

-- Author: <Author,,Name>

-- Create date: <Create Date,,>

-- Description: <Description,,>

-- =============================================

CREATE PROCEDURE [dbo].[ATS_BUILD_PRODUCT_BEST_SELLERS]

@PAST_MONTHS numeric

P a g e | 329


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

-- Add the parameters for the stored procedure here

-- <@Param1, sysname, @p1> <Datatype_For_Param1, , int> = <Default_Value_For_Param1, , -12>

AS

BEGIN

-- SET NOCOUNT ON added to prevent extra result sets from

-- interfering with SELECT statements.

SET NOCOUNT ON;

-- Insert statements for procedure here

--SELECT <@Param1, sysname, @p1>, <@Param2, sysname, @p2>

DELETE FROM ATS_PRODUCT_BEST_SELLERS

INSERT INTO ATS_PRODUCT_BEST_SELLERS

SELECT

ORDER_LINES.PRODUCT_CODE,

COUNT(ORDER_LINES.PRODUCT_CODE)

FROM

ORDER_LINES,

ORDERS,

PRODUCT

WHERE

ORDER_LINES.ORDER_NUMBER = ORDERS.ORDER_NUMBER AND

ORDER_LINES.QUANTITY_ORDERED > 0 AND

ORDERS.STATUS NOT IN ('C','CT') AND

ORDERS.ORDER_DATE > DATEADD(MONTH,@PAST_MONTHS,GETDATE()) AND

ORDER_LINES.PRODUCT_CODE = PRODUCT.PRODUCT_CODE AND

PRODUCT.PROD_TYPE = 'SALES' AND

PRODUCT.WEB_OPTION = 2 AND

PRODUCT.STATUS = 'A'

GROUP BY

ORDER_LINES.PRODUCT_CODE

END

P a g e | 330


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Product Recommendations Stored Procedure

Providing no errors occurred when creating the first stored procedure, now will be the time to create the

second stored procedure. To create the second stored procedure follow the steps used to create the first,

except copy and paste the code below into the new stored procedure window pane. You will again want to

replace the “ATS” found at the top of the code with the actual name of the database that iMIS is using, and

once that is done click the execute button to actually build the procedure.

USE [ATS]

GO

/****** Object: StoredProcedure [dbo].[ATS_BUILD_PRODUCT_RECOMMENDATIONS] Script Date: 08/02/2010 16:29:19

******/

SET ANSI_NULLS ON

GO


GO

-- =============================================

-- Author: <Author,,Name>

-- Create date: <Create Date,,>

-- Description: <Description,,>

-- =============================================

CREATE PROCEDURE [dbo].[ATS_BUILD_PRODUCT_RECOMMENDATIONS]

@PAST_MONTHS numeric

-- Add the parameters for the stored procedure here

-- <@Param1, sysname, @p1> <Datatype_For_Param1, , int> = <Default_Value_For_Param1, , -12>

AS

BEGIN

-- SET NOCOUNT ON added to prevent extra result sets from

-- interfering with SELECT statements.

SET NOCOUNT ON;

-- Insert statements for procedure here

--SELECT <@Param1, sysname, @p1>, <@Param2, sysname, @p2>

DELETE FROM ATS_PRODUCT_RECOMMENDATIONS

INSERT INTO ATS_PRODUCT_RECOMMENDATIONS

SELECT

T.PRODUCT_CODE_1,

T.PRODUCT_CODE_2,

COUNT(T.BT_ID) AS NUM_PEOPLE

P a g e | 331


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

FROM

(

SELECT DISTINCT

O1.BT_ID,

OL1.PRODUCT_CODE AS PRODUCT_CODE_1,

OL2.PRODUCT_CODE AS PRODUCT_CODE_2

FROM

ORDERS O1,

ORDERS O2,

ORDER_LINES OL1,

ORDER_LINES OL2,

PRODUCT P1,

PRODUCT P2

WHERE

O1.ORDER_NUMBER = OL1.ORDER_NUMBER AND

O1.BT_ID = O2.BT_ID AND

OL1.QUANTITY_ORDERED > 0 AND

OL2.QUANTITY_ORDERED > 0 AND

O2.ORDER_NUMBER = OL2.ORDER_NUMBER AND

O1.ORDER_NUMBER <> O2.ORDER_NUMBER AND

O1.ORDER_NUMBER <> O2.ORDER_NUMBER AND

OL1.PRODUCT_CODE = P1.PRODUCT_CODE AND

P1.PROD_TYPE = 'SALES' AND

P1.WEB_OPTION = 2 AND

P1.STATUS = 'A' AND

OL2.PRODUCT_CODE = P2.PRODUCT_CODE AND

P2.PROD_TYPE = 'SALES' AND

P2.WEB_OPTION = 2 AND

P2.STATUS = 'A' AND

P1.PRODUCT_CODE <> P2.PRODUCT_CODE AND

O1.STATUS NOT IN ('C','CT') AND

O2.STATUS NOT IN ('C','CT') AND

O1.ORDER_DATE > DATEADD(MONTH,@PAST_MONTHS,GETDATE()) AND

O2.ORDER_DATE > DATEADD(MONTH,@PAST_MONTHS,GETDATE())

) T

GROUP BY

T.PRODUCT_CODE_1,

T.PRODUCT_CODE_2

END

P a g e | 332


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SQL Server Jobs

With the stored procedures in place, the

last items to set up are the jobs that will

run the stored procedures on a daily

basis. To set up a new job:

1. Go back into the object explorer

and scroll to the bottom of the list

and find “SQL Server Agent.”

2. Expand “SQL Server Agent” to

reveal a list of sub-folders

3. Right-click on the “jobs” sub-

folder and select the “New Job…”

option. You will be presented with

the window shown to the right.

In this window you will want to specify

the name of the job, as well as a

description of what the job does. For the

name fields I essentially took the names

of the stored procedures (ATS_BUILD_PRODUCT_BEST_SELLERS and

ATS_BUILD_PRODUCT_RECOMMENDATIONS) and replaced the “ATS” part at the beginning with the initials of

the association (CAA_BUILD_PRODUCT_BEST_SELLERS and CAA_BUILD_PRODUCT_RECOMMENDATIONS).

Feel free to follow this convention or to use your own. After the name and description have been set, click the

“OK” button to move on to the next screen where you will specify what happens each time the job is run.

P a g e | 333


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Each time a particular job is run, certain

steps defined within that job are

executed. On the following screen these

steps are defined.

Fortunately the jobs that you will be

creating are very simple, and only have

one step each. To define this step, click

the “New” button towards the bottom on

the window.

When defining each step, you will have

to specify the step name, the database,

and the command. The step name can

be whatever you like, in the below

example “Run Stored Procedure” is used.

The database should be set to the

database that iMIS uses. Finally, the

command should be the name of the

stored procedure that you previously set

up, followed by a space and a negative

number. The negative number lets the

stored procedure know how far in the

past (number of months) to analyze data

when building the best sellers or the

recommendations tables. The default

value used is -3, but in reality this can be

whatever negative number you like.

P a g e | 334


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

Once the step name, database, and

command have been specified, click the

“Advanced” link on the left hand side.

Find the “On success action” dropdown

list and change it to “Quit the job

reporting success.” Click the “OK” button

in the lower right hand corner to

conclude the step configuration. The

following image shows what the finished

“Steps” section should look like.

With the steps defined, the job will now

need to be set up to run on a daily basis.

To do so, click the “Schedules” link on

the left hand side, followed by the “New”

button towards the bottom of the

window.

The following image shows how to

configure a job to run on a recurring

basis. Most of these options are self-

explanatory, and they can be set up

however you like, but the recommended

configuration is shown below. Using the

configuration shown below, this

particular job will run every day at 3AM.

P a g e | 335


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

SQL Server Tables

You will need to run the following scripts in SQL Server Management Studio to create the last of the required

tables for the store. Below is a list of the tables that will be created.

• ATS_Product_Best_Sellers

• ATS_Product_Recommendations

• ATS_ShoppingCart

• ATS_ShoppingCartDues

• ATS_ShoppingCartEvents

Be sure when running each script to update the name of the database in the first line to the name of your iMIS

database.

TABLE: ATS_PRODUCT_BEST_SELLERS

USE [ATS]

GO

/****** Object: Table [dbo].[ATS_PRODUCT_BEST_SELLERS] Script Date: 12/13/2010 14:01:32 ******/

SET ANSI_NULLS ON

GO


GO

SET ANSI_PADDING ON

GO

CREATE TABLE [dbo].[ATS_PRODUCT_BEST_SELLERS](

[PRODUCT_CODE] [varchar](31) NULL,

[NUM_PEOPLE] [int] NULL

) ON [PRIMARY]

GO

SET ANSI_PADDING OFF

P a g e | 336


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: ATS_PRODUCT_RECOMMENDATIONS

USE [ATS]

GO

/****** Object: Table [dbo].[ATS_PRODUCT_RECOMMENDATIONS] Script Date: 12/13/2010 14:11:13 ******/

SET ANSI_NULLS ON

GO


GO

SET ANSI_PADDING ON

GO

CREATE TABLE [dbo].[ATS_PRODUCT_RECOMMENDATIONS](

[PRODUCT_CODE_1] [varchar](31) NULL,

[PRODUCT_CODE_2] [varchar](31) NULL,

[NUM_PEOPLE] [int] NULL

) ON [PRIMARY]

GO


P a g e | 337


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: ATS_SHOPPINGCART

USE [ATS]

GO

/****** Object: Table [dbo].[ATS_ShoppingCart] Script Date: 12/13/2010 14:11:55 ******/

SET ANSI_NULLS ON

GO


GO

SET ANSI_PADDING ON

GO

CREATE TABLE [dbo].[ATS_ShoppingCart](

[SessionID] [varchar](100) NULL,

[MemberID] [varchar](50) NULL,

[ProductCode] [varchar](50) NULL,

[Quantity] [int] NULL,

[DateTimeAdded] [datetime] NULL CONSTRAINT [DF_ATS_ShoppingCart_DateTimeAdded] DEFAULT (getdate())

) ON [PRIMARY]

GO


P a g e | 338


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: ATS_SHOPPINGCARTDUES

USE [ATS]

GO

/****** Object: Table [dbo].[ATS_ShoppingCartDues] Script Date: 12/13/2010 14:12:32 ******/

SET ANSI_NULLS ON

GO


GO

SET ANSI_PADDING ON

GO

CREATE TABLE [dbo].[ATS_ShoppingCartDues](



[ProductCode] [varchar](50) NULL,


[Type] [int] NULL,

[DateTimeAdded] [datetime] NULL CONSTRAINT [DF_ATS_ShoppingCartDues_DateTimeAdded] DEFAULT (getdate()),

[EffectiveDate] [datetime] NULL,

[ProcessMemberType] [varchar](5) NULL,

[Price] [numeric](10, 2) NULL,

[Term] [int] NULL

) ON [PRIMARY]

GO


P a g e | 339


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

TABLE: ATS_SHOPPINGCARTEVENTS

USE [ATS]

GO

/****** Object: Table [dbo].[ATS_ShoppingCartEvents] Script Date: 12/13/2010 14:13:42 ******/

SET ANSI_NULLS ON

GO


GO

SET ANSI_PADDING ON

GO

CREATE TABLE [dbo].[ATS_ShoppingCartEvents](



[EventCode] [varchar](50) NULL,

[FunctionCode] [varchar](50) NULL,


[IsKitItem] [char](1) NULL,

[KitProductCode] [varchar](50) NULL,

[FunctionNote] [varchar](255) NULL,

[ST_ID] [varchar](50) NULL,

[DateTimeAdded] [datetime] NULL CONSTRAINT [DF_ATS_ShoppingCartEvents_DateTimeAdded] DEFAULT (getdate())

) ON [PRIMARY]

GO


P a g e | 340


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

IBO PERFORMANCE

To improve performance of the iMIS Business Objects, ATS has an optional function that can be run to

minimize the startup time of the store and other iBO related functions. In the store is a .NET ASPX file called

IBOKeepAlive.ASPX. This file can be scheduled to run regularly and keep iMIS ready to go at anytime. The

following instructions show how to implement it on Windows server 2003. Set this up on the server where the

ATS web services are installed.

1. Under control panel go to

Scheduled Tasks.

2. Click on Add Scheduled Task

3. Click Next

4. Highlight Internet Explorer and

click Next

P a g e | 341


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

5. Select When my computer starts

and click next

6. Enter the username and

password that this program will

run as and select Next

P a g e | 342


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

7. Check the box to open advanced properties for this task when I click finish

8. Under Run change the entry to include the name and location of the ASPX file that will be run and

press OK

C:\PROGRA~1\INTERN~1\iexplore.exe

http://www.myassociation.org/webservices/ibokeepalive.aspx

Note: The URL will be specific to the

location of the file on your server.

http://www.myassociation.org/webservices/ibokeepalive.aspx

P a g e | 343


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

9. On the schedule tab click on the

Show Multiple Schedules checkbox

10. Click the New button.

P a g e | 344


(p) 720.945.7252 (f) 720.945.7253

www.atsol.org

11. Schedule the job to run every 5

minutes for 1 day and to run that

job daily.

12. Click Apply when done.

13. Then click OK when done.