Pre-upgrade checklist

Perform the following before the test upgrade and the live upgrade.

Note: There are certain pre-upgrade steps that may need to be performed before the test upgrade and again before the live upgrade.

Tip! To assist with completing the pre-upgrade checklist, use the Upgrade Dashboard.

Pre-upgrade steps to perform before the test upgrade

Review the following pre-upgrade steps that must be performed before the iMIS EMS test/staging upgrade in the iMIS 2017 site.

File Storage

Files (e.g., images, PDFs) stored in non-standard locations must be identified and sent to Cloud Services. If content on the site references these files using hard-coded paths rather than relative paths, this will require content to be updated post-upgrade. To minimize post-upgrade content updates, ensure that all file references use relative paths or path variables. See Images and files testing for full details.

Database

Review the iMIS reserved words article. There are several areas throughout iMIS where certain Codes and Names should not be used. If any of these reserved words are used, there will be errors after the upgrade. If you find that there are Codes or Names that are using reserved words, contact ASI Technical Support for next steps.
For those upgrading from on-premise, 20/20 Advance Program, or Direct SQL Access Program to cloud, you must ensure the database is has the correct collation. The following collation is required: SQL_Latin1_General_CP1_CI_AS. To review or change the collation, see the Microsoft Documentation.

Contacts

Ensure there are no addresses without a Country defined.

Click for details

If you have access to SQL the database, use the following SQL to identify the addresses without a country:

Copy

SELECT * FROM Name_Address
WHERE COUNTRY = '' AND FULL_ADDRESS != ''
ORDER BY ID

If you do not have access to SQL the database, do the following in the iMIS 2017 Staff site:

Go to RiSE > Intelligent Query Architect > New > Query.
Enter a Name, such as Contact Addresses without a Country.
(Sources tab) Click Add Source, then choose the CsAddress business object.
(Filters tab) Add the filters:
1. From the Property drop-down, choose Country:
  1. From the Comparison drop-down, choose Empty.
  2. Add (+) the filter.
2. From the Property drop-down, choose Full Address
  1. From the Comparison drop-down, choose Not Empty.
  2. Add (+) the filter.
(Display tab) Choose View all columns from the drop-down, then add the following properties:
- Id
- Full Address
Click Run. The addresses of the contacts returned must be updated, so that there is a Country defined.

Next Steps

If there are only 1-30 contact addresses returned, manually update the contact addresses from the account page. If there are more than 30 contact addresses returned, enter a ticket with ASI Technical Support, so they can assist you with correctly updating the data.

Membership

Ensure the M and NM customer types are defined.

Ensure no billing cycle names match billing product codes.

Click for details

Confirming billing cycle names do not match billing product codes can be done manually by opening two browser tabs, one with Membership > Billing cycles displaying and the other with Membership > Billing products displaying, and then reviewing the two lists to confirm no billing cycle names match billing product codes.

However, if the list of billing cycles and/or billing products is too long to review manually, you can create a query to determine if billing cycle names match product codes.

Steps to take

Do the following in the iMIS 2017 Staff site:

Create a new query using the BillingCycles and CsProduct business objects.
Add the following relation: BillingCycles.Cycle Name = CsProduct.Product Code

Click the Display tab, then add the following:
- CsProduct.Product Code
- CsProduct.Title
- BillingCycles.Cycle Name
Run the query and make note of the results returned, specifically the Cycle Name.

Chapter product codes are stored in the Product Minor property, so do the following to confirm no chapter codes match billing cycle names:

Delete the current relation, then add the following relation: BillingCycles.Cycle Name = CsProduct.Product Minor

Click Run. Make note of the results returned, specifically the Cycle Name.

Next steps

If there were any results returned, do the following:

Review the billing cycles that were returned (Membership > Billing cycles) and make note of the configuration options defined.
Delete the billing cycle.
Recreate the cycle using a different Cycle Name. Members can see the cycle name when they are joining or renewing from the public website, so make sure it is a clear and descriptive name.
Repeat for all billing cycles that were returned in the query results.

If any of the affected billing cycles are being referenced in a General Product Display, the content must be updated to point to the new cycle name. Although there is no way to know which content records a billing cycle may be used, you can use the Content Browser to identify all content records that contain the General Product Display content item:

Run the ContentBrowser.exe: C:\Program Files (x86)\ASI\iMIS\net\bin

Tip! See Running the Content Browser for full steps.

Click the iParts button.
From the list of iParts, choose the General Product Display.
Make note of the Content Name and Content Path for the returned content that is not system content. System content will begin with a Content Path of iCore, iSamples, and Mbrr.

From the iMIS Staff site, locate each of the returned content records and determine if any of the replaced billing cycles are being used in the General Product Display. If this billing cycle matches any of the replaced billing cycles, update it with the new cycle name.

Ensure no billing product codes contain spaces.

Open cash non-dues and list billing invoices must be rebilled after the upgrade. Prior to upgrading, confirm whether there are open cash non-dues and/or list billing invoices. If there are, you must perform the associated post-upgrade step.
Create an IQA query to identify contact records with AVAIL_CREDIT balances. After upgrading, the identified AVAIL_CREDIT balances will automatically offset the balance of dues products when cash dues renewals are generated. However, generating these renewals will create an open batch that must be posted to complete the credit application. For more information, see the post-upgrade step.

Websites

Ensure you are not using a deprecated website template or theme on any website. See Updating deprecated templates and themes in websites.
Ensure the Constellations template changes do not affect your custom websites.

Click for details

The iMIS EMS Staff site navigation was enhanced in February 2023 with the following:

A collapsible navigation, allowing staff users to utilize more horizontal space on the screen.
Updated icons that are powered by out-of-the-box CSS classes. These CSS classes, in addition to several other new classes, are only available with the Orion theme.

These enhancements required many changes to the Constellations template; therefore, to accommodate those using the Constellations template with a custom website, the Constellations_Classic template was created.

Custom websites using the Constellations template must be updated to use the Constellations_Classic template to avoid upgrade issues.

Steps to take

Do the following in the iMIS 2017 Staff site:

Go to RiSE > Site Builder > Manage websites.
Select a custom website. A custom website is any website that is not an out-of-the-box website, for example, if you have made a copy of the Staff site and are using the copied Staff site instead of the out-of-the-box Staff site.
Click the Look and feel tab.
Expand the Advanced section.
Review the template selected in the Template (master page) drop-down. If the selected template is Constellations, then this change affects the selected website.

Continue that process for each custom website.

Next steps

If this change affects your websites, see Upgrading custom websites that are using the Constellations template.

Multiple publishing servers are no longer supported and must be removed before upgrading. The only publishing server that should be defined prior to upgrading is Publish Server Code A with Is Default set to Yes.

Panels & Tables

Note: While testing panels and tables, it may be useful to review what panel sources are used in each panel definition. Use the ListPanelDefinitionSources.sql script to generate one row for every source included in a panel.

After an upgrade to iMIS EMS, there may be panels and/or panel sources that are missing. This may be because the panel source was not correctly added to the ObjectMetaData table when it was initially created. For full details, see Ensuring panels and panel sources are not missing after an upgrade.
Confirm every table and/or business object you need accessible as a panel source is properly defined as such. This step is to ensure any table you may need to use as a panel source is converted properly and added to the ObjectMetaData table (as compared to the next pre-upgrade check that is specifically referencing customizer tables). If this action is not performed before upgrading, the tables only appear as business objects and you cannot use them in Panel Designer.

Import customizer tables that were never configured as panels.

Click for details

To improve performance for sites with large amounts of data, all user-defined tables (created with iMIS Customizer) are converted to v3 panel sources, so they can be used with Panel Designer after the upgrade. All new tables created in iMIS EMS will adopt the v3 panel structure, and existing tables using the v1 or v2 structure are automatically converted to v3.

The tables that were used to store additional information about the Customizer tables (UD_Table, UD_Field, UD_WindowHeader, and UD_WindowFields) are deleted, as they are no longer used.

If there are Customizer tables that were never configured as Panels in iMIS 2017, then the panel should be imported so that a Panel Definition is created for each table prior to the upgrade. This time-saving effort prevents you from having to create a panel for each Customizer table post-upgrade.

Steps to take

Do the following in the iMIS 2017 Staff site:

Go to RiSE > Page Builder > Manage content.
Create a new content record and add the Panel Editor content item to the page.
From the Panel Editor content item, click Import.

Note: If you do not see an Import button, there are no updates to import. Continue to the NEXT STEPS below.

During the upgrade migration process, the following occurs:

The necessary business objects are created for the Customizer tables.
The business objects are named after the physical tables.
Post-upgrade, the business object is accessible to the Panel created from during the pre-upgrade import.

Next steps

If you have created panels for Customizer tables in iMIS 2017, the business objects used as sources for these panels must be verified to confirm the business object name is not the same name as the UD_Table. If there are business objects created for the Customizer tables (i.e. being used in IQA queries) using the same name as the physical table, the business object should be renamed; otherwise, the upgrade process will overwrite the business object.

Identifying UD Tables and BOs with the same name

Run the following SQL to determine if there are UD Tables with the same name as a BO:

Copy

SELECT [DocumentName] FROM [dbo].[DocumentMain] 
 WHERE [DocumentTypeCode] = 'BOD' AND [DocumentName] IN (
SELECT [TABLE_NAME] FROM [dbo].[UD_Table])

If there are results returned, you should identify whether the BO is being using in a query before changing the name. You have two options to accomplish this:

Use the QueriesByBOFor2017GA script. See the iMIS Support site for script details.
Use the Query Browser utility.

Using the Query Browser Utility

Use the Query Browser utility to determine if the BOs are being used in any queries:

Open the Query Browser: C:\Program Files (x86)\ASI\iMIS\net\bin

Tip! For full instructions on how to use the Query Browser, see Query Browser Utility.

Click Search Queries.
Click the Query Sources tab.
Enter the business object name in the Business Object Name #1 field.
Click Search. Make note of the returned query paths.
Repeat steps 5 and 6 for each business object.

Updating the BOs and queries

The next steps are to update the BO names, then update the related queries that the BOs are being used in.

Update Panel Collection Editor content items that are configured to Use all available panels.

Business Objects & Queries

Identify queries that are accessing the REST API. These queries must be explicitly granted API access post-upgrade, so it is important that they are identified during the pre-upgrade stage. See IQA Security Update and Updating queries that must access the REST API for more information.
Publish all working business objects.

Update business objects that are built from unsupported internal tables or views.

Click for details

There are specific iMIS tables and views that Business Objects (BOs) should never be built from; specifically, a custom BO should never be built from the underlying table implementations created by Panel Editor. If you have ever created a new BO using a low-level table or view from a custom panel data source, as identified below, then this applies to you.

Building BOs from these tables and views are problematic for those who are upgrading, because those tables and views are changing or going away entirely.

Tables

The following are tables that BOs should never be built from:

UserDefinedSingleInstanceProperty
UserDefinedMultiInstanceProperty
UserDefinedTableStorage

Views

The following are views that BOs should never be built from:

Any vUDBO* view
Any vUDMBO* view

Any BO that relies on one of the above tables or views must be modified and corrected before upgrading.

Steps to take

Run the following SQL to locate business objects using any of the unsupported tables.

Copy

SELECT DocumentMain.DocumentName, DocumentMain.DocumentTypeCode, DocumentMain.DocumentStatusCode
            , DocumentStatusRef.DocumentStatusDesc
            , [Path] = [dbo].[asi_DocumentPathFromHierarchyKey](Hierarchy.HierarchyKey)
            , o.[name] AS ObjectName, s.[definition] As ObjectDefinition
FROM Hierarchy
            INNER JOIN HierarchyRoot ON Hierarchy.RootHierarchyKey = HierarchyRoot.RootHierarchyKey
            INNER JOIN DocumentMain ON Hierarchy.UniformKey = DocumentMain.DocumentVersionKey
            INNER JOIN DocumentStatusRef ON DocumentMain.DocumentStatusCode = DocumentStatusRef.DocumentStatusCode
            INNER JOIN sys.objects o ON 'vBo' + DocumentMain.DocumentName = o.[name]
            INNER JOIN sys.sql_modules s ON o.[object_id] = s.[object_id]
WHERE DocumentMain.DocumentStatusCode = 40 AND DocumentMain.DocumentTypeCode = 'BOD' AND DocumentMain.IsSystem = 0
AND(       s.[definition] LIKE '%UserDefinedSingleInstanceProperty%'
OR         s.[definition] LIKE '%UserDefinedMultiInstanceProperty%'
OR         s.[definition] LIKE '%UserDefinedTableStorage%'
OR         s.[definition] LIKE '%vUDBO%'
OR         s.[definition] LIKE '%vUDMBO%'
)
Order by DocumentMain.DocumentName

After the SQL is run, do the following in the iMIS 2017 Staff site:

Go to RiSE > Business Object Designer.
Locate and open the identified sources.
Click the Database tab.
Review the Tables section. If and of the previously stated tables or views are listed, then the BO must be updated.
From the Tables section, click Add.
Locate the appropriate replacement table.

Note: The replacement for BOs that rely on one of the above tables or views is any vBO* view. Each Panel Editor source has an associated BO and a vBO* view that you can safely use and will survive upgrades intact.

Save and Publish the changes.

RiSE & Settings

Ensure no content folders under the root folder (@) are named iMIS.

Publish all working content.

Rename Tagged List Formats that contain characters other than letters, numbers, and underscores.

Remove the Expansion value from general look up tables, with the exception of the DESIGNATION, PREFIX, SUFFIX, and FUNC_TITLE tables.

Update custom system icons. iMIS system icons have been updated from PNG to SVG (.svg) for the enhanced scalability, smaller file size, and customization options that the SVG file format offers. Custom themes may require adjustments because of this enhancement. See Updating custom system icons for full details.

Finance

Ensure payment methods are defined with a specific Type. If no Type is selected, such as Cash or Credit Card, the payment method will become an Open Credit payment method after the upgrade.

Post open batches.

Process all premium transactions.

Commerce

To ensure all necessary products are available for public users to purchase, you must confirm the product's Web Option is correctly configured prior to upgrading.

Click for details

For each product that you want to continue using post-upgrade, you must confirm the Web Option is correctly configured:

From the iMIS Desktop, go to Orders > Manage inventory > Manage products.
Select a product from the Current Products list.
If the product must be available post-upgrade, ensure the Status is Active.
Click Web.The Web Option determines who can view the product and how the product is configured after the upgrade:

Table 1: Viewing products post upgrade
Web Option	Who can view the product post upgrade	Post-upgrade configuration
Not on Web	Staff users	The product setting Only staff can purchase is enabled. The Show in Search is populated with an End date in the past. The product only appears in search results when Include inactive results is enabled.
View on Web	Staff users	The product setting Only staff can purchase is enabled.
Sell on Web	Public and staff users

If the product must be available to public users, ensure the Web Option is set to Sell on Web.

Save the changes.
Continue this process for all products.

Product special pricing rules cannot be edited after the upgrade, so you must delete the rules prior to upgrading.

Click for details

Do the following to delete the special pricing rules and recreate them using the out-of-the-box implementation:

Run the following to identify each product that contains special pricing:

Copy

SELECT * FROM Product WHERE PRICE_RULES_EXIST = 1 AND PROD_TYPE = 'SALES'

Make note of each product code identified.
Review each product (Commerce > Find products) and make note of the pricing rule set up, so that you may easily recreate the rule in iMIS EMS.
Update the following SQL, where xxx, yyy, and zzz are the product codes identified in step 1. Continue adding new UPDATE statements for each product code identified. When ready, run the SQL.

Copy

UPDATE Product SET PRICE_RULES_EXIST = 0 WHERE PRODUCT_CODE = 'xxx'
UPDATE Product SET PRICE_RULES_EXIST = 0 WHERE PRODUCT_CODE = 'yyy'
UPDATE Product SET PRICE_RULES_EXIST = 0 WHERE PRODUCT_CODE = 'zzz'

Update the following SQL, where xxx, yyy, and zzz are the product codes identified in step 1. Continue adding new DELETE statements for each product code identified. When ready, run the SQL.

Copy

DELETE FROM Product_Price WHERE PRODUCT_CODE = 'xxx'
DELETE FROM Product_Price WHERE PRODUCT_CODE = 'yyy'
DELETE FROM Product_Price WHERE PRODUCT_CODE = 'zzz'

(Post upgrade) Update each product (Commerce > Find products) and recreate the special pricing rules using the out-of-the-box settings.

iMIS EMS does not support multiple warehouses, so you must designate all inventory to the default warehouse before upgrading. If you do not have multiple warehouses enabled, this does not apply to you.

Events

Update events that are using stored procedures for price evaluation.

Click for details

Before upgrading, ensure no events are configured to use a stored procedure for price evaluation.

Run the following to determine if any events are using stored procedures:

Copy

Select * from Meet_master
Where REG_CLASS_STORED_PROC <> ''

If the above returns results, use the following to clear the stored procedure pricing from all events:

Copy

Update Meet_Master
set REG_CLASS_STORED_PROC = '',
WEB_REG_CLASS_METHOD = '1'
where REG_CLASS_STORED_PROC <> ''

Update the Show on Web option for events.

Contacts that have been deleted from iMIS that were once defined as the Event Contact will still have their iMIS IDs recorded in the event definition, which causes errors when editing the event post-upgrade.To prevent these errors, it is important that these IDs are removed from the event definition.

Click for details

From the iMIS 2017 Staff site, determine whether any events need updating:

Go to RiSE > Intelligent Query Architect > New > Query.
Enter a Name, then click the Sources tab:
1. Click Add Source.
2. Choose the CsEvent and CsContact business objects.
3. Add the following relation: CsEvent.Contact Id Not Exist CsContact.iMIS Id
Click the Filters tab.
1. From the Property drop-down, choose CsEvent.Contact Id.
2. From the Comparison drop-down, choose Not Empty.
3. Add (+) the filter.
Click the Display tab:
1. From the drop-down, select View all columns.
2. Select the CsEvent.Title property.
3. Select the CsEvent.Contact Id property.
Click Run.

Next Steps to take

If the query returns any results, do the following:

From the iMIS Desktop, go to Events > Define an event.
From the list of events, double-click one of the events returned in the above query.
Click More > Web Options.

Click Edit.
Delete the ID from the Event Contact field.

Click Save.
Repeat the process for each event returned in the query.

Contacts that have been deleted from iMIS that were once defined as an event function resource (speaker or staff) will still have their iMIS IDs recorded in the event definition, which causes errors when editing the event post-upgrade. To prevent these errors, it is important that these IDs are removed from the event definition.

Click for details

There is not an out-of-the-box business object in iMIS 2017 that returns event resource data, but you can quickly create a business object:

Go to RiSE > Business Object Designer > New > Design Business Definition.
Enter a Name (EventSpeakers).
Click Create Object.
Click the Database tab.
From Tables, click Add.
Select the Meet_Resources table, then click OK.
Click Add All as Properties.
Click Save, then click Publish.

Next, create the query:

Go to RiSE > Intelligent Query Architect > New > Query.
Enter a Name, then click the Sources tab:
1. Click Add Source.
2. Choose the business object you created above (EventSpeakers) and the CsContact business object.
3. Add the following relation: EventSpeakers.Fld1 Id Not Exist CsContact.iMIS Id
Click the Display tab:
1. From the drop-down, select View all columns.
2. Select the following properties:
  1. EventSpeakers.Fld1 Id
  2. EventSpeakers.Product Code
  3. EventSpeakers.Resource Type
Click Run. The first half of the Product Code is the code of the event. The second half of the Product Code is the code of the event function where the ID currently exists.

Next Steps to take

If the query returns any results, do the following:

From the iMIS Desktop, go to Events > Define an event.
From the list of events, double-click one of the events returned in the above query.

From the list of functions, double-click the associated function.
Click More > Speakers or More > Staff.
Click the row that contains the speaker or staff ID details.

Click Edit.
Delete the Id or select a new Id.
Click Save.
Repeat the process for each Event/Function returned by the query.

Images added to an event through the iMIS Desktop are not added to the Image Manager during the upgrade, which causes errors when editing the event post-upgrade. To prevent these errors, it is important that these images are removed from the event.

Click for details

From the iMIS 2017 Staff site, do the following:

Go to RiSE > Intelligent Query Architect > New > Query.
Enter a Name, then click the Sources tab:
1. Click Add Source.
2. Choose the CsEvent business object.
Click the Filters tab:
1. From the Property drop-down, select Meeting Image Name.
2. From the Comparison drop-down, select Contains.
3. From the Value field, enter http.
4. Add (+) the filter.
Click the Display tab:
1. From the drop-down, select View all columns.
2. Select the Title property.
3. Select the Meeting Image Name property.
Click Run.

Next Steps to take

If the query returns any results, do the following:

From the iMIS Desktop, go to Events > Define an event.
From the list of events, double-click one of the events returned in the above query.
Click More > Web Options.
Click Edit.
Delete the URL from the Event Image Hyperlink field.

Click Save.
Repeat the steps for each event returned by the query. To replace the image, see Defining an event.

Pre-upgrade steps to perform before the live upgrade

The following pre-upgrade steps must be performed before the live upgrade to iMIS EMS:

Publish all working content.
Post all open batches.
Publish all working business objects.
Ensure the public websites have been tested and reviewed in the test phase.