for imis and etouches

Transcription

1 for imis and etouches Release Notes Version Thornall Street, Suite 310 Edison, NJ Tel: New York Toronto London

2 Contents About Version imis Version Support 3 File Updates 4 Configuration Updates 4 Installation Instructions 5 (C)onnect Installation 5 eselect Importer Service Installation 6 Version 7.1 Updates 8 eselect Integration 8 Handling of Discount Functions on Registration Modification 10 Limiting Contact Information to the imis Event Registration 10 Handling of Invalid Registration Classes 10 Improved Handling of Text Containing Apostrophes 11 Resolving Duplicate Function Codes 11 Configurable Batch Number 12 How to Receive this Update 13 Page 2

3 About Version 7.1 (C)onnect Version 7.1 is in general release and available to your organization. Included in this release are enhancements to standard ereg functionality and new functionality to support the eselect module, a workflow process which allows users to manage abstract and speaker submissions. More information on the etouches eselect module can be found at Additional features for ereg integration include: 1. Improved validation of event definitions during synchronizations to imis. This includes better analysis and handling of discount codes, duplicate function codes, registrant classes and invalid registration classes. 2. Limiting contact updates to the registration and not the main contact records. 3. Improved handling of names and addresses that include apostrophes. 4. New batch number configuration control. (C)onnect, Version 7.1 includes all of the features and enhancements made available in previous versions including: Allow registration modifications for tax inclusive events Handle modifications to registrations that included dues Support for calendar year dues The etouches bridge ipart Demographic changes to etouches using the etouches bridge ipart Support for calendar year dues Improved event definition modifications Resolution of issues with work phone and address updates in imis Resolution of invoice creation for previously complimentary registrations Option to create user credentials when creating new contacts imis Version Support The following versions of imis are supported in this release: Minimum Version Maximum Version If you do not meet these requirements, please contact the (C) Systems support desk for assistance. Toll Free Phone: support@csystemsllc.net File Updates Page 3

4 The following files are included in this release. (Destination folders are relative to the root of your (C)onnect install.) File Name Destination Folder Version Number etoucheswebservice.dll \bin etoucheswebservice.pdb \bin N/A etocuhesbridge.dll \bin etocuhesbridge.pdb \bin N/A etouchesservicehost.dll \bin etouchesservicehost.pdb \bin N/A SubmissionManagement.svc \ N/A Configuration Updates The following configuration changes are required to support the eselect integration. These changes are applied to the web.config file found in the root folder of the (C)onnect installation. Verify etouches URL references 1. The following is present in the web.config file. <add key="etauthorizeurl" value=" <add key="etpostbridgeurl" value=" <add key="etlandingpage" value=" Add eselect endpoints 1. Add the new eselect web service element in the <services > section of the web.config file. This configures the SubmissionManagement service. <service behaviorconfiguration="etouchesservicehost.submissionmanagementbehavior" name="etouchesservicehost.submissionmanagement"> <endpoint address="" binding="basichttpbinding" contract="etoucheswebservice.servicecontracts.isubmissionmanagementservice"> <identity> <dns value="localhost"/> </identity> </endpoint> Page 4

5 <endpoint address="mex" binding="mexhttpbinding" contract="imetadataexchange" /> </service> 2. Add a new behavior to the <behavior> section of the web.config file. <behavior name="etouchesservicehost.submissionmanagementbehavior"> <servicemetadata httpgetenabled="true"/> <servicedebug includeexceptiondetailinfaults="false"/> </behavior> Installation Instructions Please follow these instructions to apply (C)onnect 7.1 release and the eselect Importer Service to your test and production environments. (C)onnect Installation 1. Prior to updates, run the following SQL script against your imis database to confirm the etouches_transaction_history table is present/created. IF NOT EXISTS (SELECT * FROM sys.objects WHERE Name = 'etouches_transaction_history') BEGIN CREATE TABLE [dbo].[etouches_transaction_history]( [TransactionID] [int] NOT NULL, [EventID] [int] NULL, [Secondary_AttendeeID] [int] NULL, [AttendeeID] [int] NULL, [Date_Posted] [datetime] NULL, CONSTRAINT [PK etouches 55433A4B24FDB547] PRIMARY KEY CLUSTERED ( [TransactionID] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] END 2. Backup the (C)onnect production (and test folders if applicable) 3. Copy the DLL files to the \bin directory of the your (C)onnect sites. Administrative access to overwrite the current files may be required. 4. Verify the settings in the web.config file for the etauthorizeurl, etpostbridgeurl, etlandingpage entries (see Configuration Updates). 5. Copy the new SubmissionManagement.svc to the website root. Please Note: The (C)onnect installation will restart the (C)onnect web services and may impact etouches communications for up to one minute. Page 5

6 eselect Importer Service Installation 1. Copy the following files to the on the C:\Csystems\eSelectService folder on the application server. eselectimporter.exe eselectimporter.exe.config eselectimporter.pdb etouchesbridge.dll etouchesbridge.pdb log4net.dll 2. Create a batch file with the following off sc delete "(C)onnect eselect Importer" sc create "(C)onnect eselect Importer" binpath= "C:\Csystems\eSelectService\eSelectImporter.exe" DisplayName= "(C)onnect eselect Importer" start= auto pause 3. Update the binpath option (third line above) to the file location in #1. 4. Run the batch file as a systems administrator. Configuration Updates 1. Update the eselectimporter.exe.config appsettings section <appsettings> <add key="lastrunfile" value="latestrun.txt"/> <add key="defaultintervalinminutes" value="5"/> <add key="etauthorizeurl" value=" /> <add key="etpostbridgeurl" value=" /> <add key="etlandingpage" value=" /> <add key="etselecturl" value=" /> <add key="etouchesaccountid" value="1234"/> <add key="etouchesapikey" value="ccbe4b e d9e544f95391eb440388"/> </appsettings> The following table lists the individual application configuration elements and their descriptions. Setting LastRunFile Description Name of file that stores the date/time the service was last invoked to check for new submissions. The recommended value for this setting is LastRun.txt. DefaultIntervalInMinutes Page 6 Indicates the frequency the service should poll for submissions, in minutes.

7 The default value for this setting is 5, although this may vary if large quantities of submissions are to be processed. etauthorizeurl etpostbridgeurl etlandingpage etselecturl etouchesaccountid etouchesapikey The URL used for remote etouches authentication. Please use the value specified in the application configuration noted above. The URL used for bridge handling authentication. Please use the value specified in the application configuration noted above. The URL used for redirection after remote etouches authentication. Please use the value specified in the application configuration noted above. The API endpoint for eselect querying. Please use the value specified in the application configuration noted above. Your etouches account ID number. You can find this value in your etouches integration settings. Your etouches account API key. You can find this value in your etouches integration settings. 2. In the <connectionstrings> section, set the connection string to the appropriate values to access your imis database. You can copy the same element values from the web.config file of your (C)onnect installation. An example of a connection string setup is shown in the area below. <connectionstrings> <add name="datasource.imis.connection" connectionstring="data source=imisserver;initial catalog=imisdb;user id=sa; pwd=secretpassword;"/> </connectionstrings> Lookup Table Setup 1. Create the eselect_events general look-up table in the imis database. This will hold a list of etouches events that should be polled for eselect submissions. An example of generating entries into this table using SQL is provided below. Please note, this example we are generating two etouches event references based on their etouches event IDs. INSERT INTO Gen_Tables (TABLE_NAME, CODE, SUBSTITUTE, UPPER_CODE, DESCRIPTION, OBSOLETE_DESCRIPTION) VALUES ('ESELECT_EVENTS', ' ', '', ' ', '', '') INSERT INTO Gen_Tables (TABLE_NAME, CODE, SUBSTITUTE, UPPER_CODE, DESCRIPTION, OBSOLETE_DESCRIPTION) VALUES ('ESELECT_EVENTS', '194590', '', '194590', '', '') Service Startup 1. Open the Services display on the application server (from the Start menu go to Control Panel -> Administrative Tools -> Services). Page 7

8 2. Select the (C)onnect eselect Importer service. 3. Click on the Start ( ) button in the menu area or right-click on the service and select Start. Version 7.1 Updates This release of (C)onnect includes the following feature enhancements and issue resolutions. eselect Integration (C) Systems continues its commitment to our partnership with etouches and introduces the integration with eselect, the abstract and submission management module. Update: In this version of (C)onnect, (C) Systems includes the integration of eselect submissions, status, and details in etouches to imis creating and updating Activity records in the imis database using new (C)onnect web services and the new eselect Importer Service. Details: The eselect Importer Service runs on a scheduled basis (see Installation section for details). During each scheduled run of the process, etouches eselect data is pulled from the etouches system and put into the imis database as Activity records on the submitter s imis record. This process creates/updates an E_SUBMIT Activity type with the following information from the etouches submission: etouches event ID Title of the submission Submission description Status review count Stage Rating Date the submission was added Last updated date Page 8

9 Configuration of the E_SUBMIT Activity type in imis During installation, an imis General Validation Table will be created, eselect_events, will be created which be updated with any eselect event ID and title to be included in the integration. During each run of the eselect Importer, the service selects all events identified in the look-up defined in imis. The process checks etouches for updates - including new and updated submissions. The process creates a new Activity or updates an existing E_SUBMIT Activity on the submitter s imis record. If a matching imis ID is not found, the system will create a new imis account for the submitter, Each transaction (new or updated) processed through the eselect Importer Service is to a text file for auditing purposes. The log file is created daily and saved to a text file named <Date as yyyymmdd>.log. Each logged entry includes: Date/time of the posting Name of the applicant address of the applicant Title of the submission Page 9

10 Success or failure of the transaction (e.g. Success: true or Success: false) Any error message returned in the transaction response This file can be found in the root folder of the eselect Importer Service installation. Handling of Discount Functions on Registration Modification In some cases, a modified event registration which used a discount code on the initial registration was not inserted into imis with the discounted amount. Resolution: If a discount code is added to the modified event registration or new sessions are added that an existing already applied discount code will cover, they will now insert into imis with no transactional issues. This includes any registrations modified by staff members. Limiting Contact Information to the imis Event Registration In previous versions of (C)onnect, when an attendee's profile details (name and/or address) were updated in etouches, the main contact information and order contact details were also updated in imis. There was no way to limit contact updates to the registration record. Resolution: An organization can now configure whether updates of contact information in etouches flow to the main imis profile and registration or just to the event registration (order) record. Details: A default configuration has been created to update both the imis profile record and the event registration with changes to the name or address information in etouches. This configuration can be changed to block the updates to the contact record or the registration (order). To enable registration detail only updates, add OnlyUpdateOrderAttendeeDetails to the appsettings section of the web.config. <add key="onlyupdateorderattendeedetails" value="1"/> A value of 1 will prevent updates to the attendees contact record and limit the updates to their registration record. A value of 0 will update both the registrant s profile record and the registration (order). Handling of Invalid Registration Classes In order for an etouches event definition to be synchronized to imis, unique imis registration classes had to be assigned to etouches categories. In some cases function codes were assigned the same registrant class, which is not allowed in the imis definition. This attempt at multiple Page 10

11 insertions of the same registrant class (based on category sharing) resulted in a synchronization failure. This required organizations using etouches sub-categories to create a separate etouches event without sub-categories in order to synchronize the event definition to imis. Resolution: When an imis registrant class is assigned to more than one etouches category, the etouches sessions and options with an imis function code configured will insert once per registrant class. Details: The pricing will be set at the most expensive configured in etouches for that registrant class. If a sub-category has a lower price in etouches an appropriate discount amount will be inserted to ensure the net price in the individual imis registration is accurate. Improved Handling of Text Containing Apostrophes In previous versions of (C)onnect, if a payment was entered during a modification, and the name contained an apostrophe, the insert would fail with an error if the PCI Compliance was not set to Do not retain credit card information. Resolution: A modified registration from etouches will insert into imis if the name on the credit card contains an apostrophe. Details: No changes to the configuration file or to imis are required for this update. Please note, PCI Compliance settings are configured in both the (C)onnect and RiSE web.config files. <add key="pcienabled" value="1" /> A value of 1 indicates no credit card information will be saved to imis, A value of 0 indicates the credit card information will be saved. This configuration must be set and the same in both web.config files. Resolving Duplicate Function Codes In some cases, an event was set up with duplicate function codes which would cause an error when synchronizing the event to imis. The error message was not clear and confusing to users. Resolution: In this version of (C)onnect an explicit error message will be returned identifying when a duplicate function code is present in the event definition. Details: During the synchronization process, (C)onnect will determine if a duplicate function code is present. If an issue is found, (C)onnect will respond with a message which identifies the duplicate function code. Page 11

12 The following function codes have duplicates: SES1 Configurable Batch Number The current batch number configuration is limited to the addition of an identifier within the batch number only. Some clients have requested that the date format and batch suffix be configurable. Resolution: Added ability to configure batch number. Details: To define a custom batch number, users add a new web.config entry, BatchOverrideFormat, with the value field set to the new format. <add key="batchoverrideformat" value="{0:yyyymmdd}-i" /> Field Number Description 0 The current date. 1 A configurable identifier based on your organization s rules. This is defined in the BatchSuffix value specified in the appsettings of the (C)onnect web.config file. Format Code Batch Suffix Generated Batch Number {0:yyMMdd}{1}-E E {0:yyMMdd}{1}-E A A-E {0:yyMMdd}{1} A A-E {0:yyyyMMdd}{1}-E A A-E Examples using a current date of String Format Output yymmdd yyyymmdd MMddyyyy Mdyy Page 12

13 MM-dd-yyyy M/d/yy Examples of date/time formats Batch numbers are typically set up to use the date to ensure they are always unique. It is strongly recommended that any new batch formatting configured continues to use the date and at least one other special identifier. Format Code Batch Suffix Batch Output {0:yyMMdd}{1}-I I {0:yyMMdd}{1}-I A A-I {0:yyMMdd}{1}-I I {0:yyMMdd}{1}-I A A-I {0:yyMMdd}{1}-ET ET {0:yyMMdd}{1}-E A A-ET Examples of unique batch number formatting If no custom batch format is specified then the batch will continue to be entered in the current format of <Current Date in YYYYMMDD><Batch Suffix>-i. How to Receive this Update Please contact the (C) Systems Help Desk to arrange for installation of this release. They will schedule a convenient time with your team to perform the installation of the update. You may also opt to install this release yourself. Contact our Help Desk to request this release. We will verify you are on the most current version then provide you with the (C)onnect files documented above. Remember, you can contact the (C) Systems Help Desk for scheduling updates and other (C)onnect / etouches issues using the information below. Toll Free Phone: support@csystemsglobal.com Page 13