Bridgeline Digital Logo
Menu

Upgrade OrchestraCMS

We recommend that you install or upgrade OrchestraCMS 14 days before or after a scheduled Salesforce upgrade. You can review the Salesforce maintenance schedule at the following URL to determine when it is best to perform an OrchestraCMS upgrade: http://trust.salesforce.com/trust/maintenance

Salesforce upgrades generally occur over several weekends. This causes version differences between Stantive development environments and your production and sandbox environments.

Any OrchestraCMS patches required during a Salesforce upgrade period will not be available until all environments have been upgraded to the same Salesforce release.

Please follow these steps:

  1. In order to receive the latest package installation links, when you are ready to begin, contact customer-support@stantive.com 
  2. Plan downtime in which to install the package. Packages typically take 15 to 20 minutes to install, and no OrchestraCMS users should be using the application during this time.
  3. If it has not already been completed, perform Post-Refresh steps on the Sandbox. These include:
    • Email Deliverability
      • In Salesforce Setup, navigate to Email and select Deliverability. The Access to Send Email (All Email Services) access level field must be set to “All email”.
    • Remote Site Settings
      • In Salesforce Setup, make sure Remote Site Settings are updated to the correct URLs. If the sandbox pod is CS1, for example, you would need to update:
      • OrchestraCMSSchedulerAPI: https://na24-api.salesforce.com to https://cs1-api.salesforce.com
      • OrchestraCMSSchedulerREST: https://na24.salesforce.com to https://cs1.salesforce.com
      • OrchestraCMSRemoteLogin: https://login.salesforce.com to https://test.salesforce.com
    • OrchestraCMS Site Details
      • In OrchestraCMS Setup (Site|Details), ensure you have the URLs to point to the sandbox environment. These include:
        • Site Domain
        • Site Secure Domain
        • Site URL
        • Site Secure URL
    • License verification
      • In OrchestraCMS Setup, click Licenses.
      • Click Check Now to validate that your sandbox is properly receiving the OrchestraCMS licenses. If not, please contact Stantive Technologies Group Customer Support.
 

If the sandbox has been refreshed from production, you will need to send the sandbox org ID (found under Salesforce Setup, Company Profile, Company Information) and the production org ID to Stantive Technologies Group Customer Support”, customer-support@stantive.com .

  • Removal of inactive users (contact Stantive Technologies Group for query)
  • Removal of orphaned records (contact Stantive Technologies Group for query)
  1. Install the new OrchestraCMS package/OrchestraCMS Extensions package.
  2. In Salesforce Setup, expand Installed Packages. Beside OrchestraCMS, click Configure. This will migrate and update any Permission Sets changes between versions.
  3. Refresh content/page caches for all sites. This might take some time, and the sites might experience unexpected behaviour between the time of the package installation to the time the cache refreshes have been completed. We recommend you use the “Email on Completion” checkbox to receive an email from Salesforce once the refreshes are complete.
  4. Run all apex tests in “My Namespace” to ensure you have the minimum code coverage required and no failures have occurred that would prevent any code modifications required for the upgrade to be deployable. If there are changes to the OrchestraCMS application that have affected your test classes, these should be addressed in advance before planning to upgrade your production org (Stantive Technologies Group Customer Support is available to assist in resolving issues.)
  5. Perform UAT of the full sandbox and test all aspects of your solution to ensure they are working as expected. Any issues that are found should be reported to Customer Support by emailing customer-support@stantive.com or by logging the issue in The Pulse (Stantive’s Customer Community).
  6. Stantive Technologies Group has put together a checklist to help with UAT of the site. This is a general checklist and might not encompass all components of your site. This can be found on The Pulse or User Acceptance Testing of your Site – A Checklist.
  7. Stantive Technologies Group Customer Support is available to assist in investigating potential issues that may arise after upgrading.
    • If the issue is determined to be related to OrchestraCMS, a bug request will be logged with our development team for investigation.
    • If the issue requires a code change to your custom solution, our Product Enablement team may be able to assist if required (there may be associated costs).
      • Stantive Technologies Group Customer Support is available 8am to 8pm EST, Monday through Friday.
  8. Once you have confirmed that testing is complete and all issues are resolved or explained, the upgrade in the Production org is scheduled.
    • There is an expectation that the customer will have resources available to ensure a smooth upgrade. If the intention is to perform the production upgrade during off-hours of the business day, Stantive Technologies Group should be made aware of this. We request notification no less than two weeks in advance, although we cannot guarantee Stantive Technologies Group availability.
    • If there is a requirement for assistance from Stantive Technologies Group Customer Support during the production upgrade which falls outside of standard support hours, a request must be made to customersuccess@stantive.com as much in advance as possible.

Upgrade OrchestraCMS in your sandbox

As a best practice, we recommend that you refresh and upgrade your full sandbox environment and test your pages and content in your sandbox environment before upgrading your production environment.

Only full sandbox refreshes are supported by OrchestraCMS. OrchestraCMS has some base record data that may not be transferred from your production instance with other sandbox types. Any missing data may cause issues with OrchestraCMS functionality.

Your OrchestraCMS licenses are associated with your Salesforce organization IDs. Each time a sandbox is refreshed, a new organization ID is created. To have your OrchestraCMS licenses applied to the refreshed sandbox, contact customer support at customer-support@stantive.com to add the new organization ID to your account.

If there are issues found in the sandbox after upgrading that require assistance from Stantive Customer Support, please use a case subject in this format: OrchestraCMS Sandbox Upgrade - [short issue description] so the Stantive Customer Support team can flag it accordingly.

Test your pages and content

It is important to ensure that your pages and content are rendering and behaving correctly in your sandbox environment before you install the upgrade to your production environment.

We recommend that, at minimum, you do the following to test your site:

  • Navigate through your live site using the links you have set.
  • Use the Full Preview feature in OrchestraCMS to review your pages and content.
  • Test your forms, and verify that data is being correctly submitted to Salesforce.
  • Test any custom components you have added; verify that they display and behave correctly.

If you encounter any issues in your testing process, contact the Stantive Support team at

customer-support@stantive.com  before you install the upgrade to your production environment.

Upgrade your production environment

You can also contact the Stantive Support team at customer-support@stantive.com to let us know the date and time that you plan to perform the upgrade. We can coordinate with you to make sure you have support available if you encounter any issues during the upgrade process.

 

All content and pages from previous versions of OrchestraCMS should function correctly in the most current release.

Build a custom content editor for a multilingual site

Custom content templates, developed specifically for your organization, are also compatible with the multilingual feature. In some cases, it can be beneficial to have a content template developer make adjustments to custom content editors, because this makes it easier for translators to use.

The Split View feature, which allows translators to view two language instances of a content item in the content editor, is easiest to use if the following best practices are used to develop custom content editors:

  • The content editor should be 625px wide or less.
  • All input fields should stack on top of each other.
  • Field labels should appear above the fields.

We recommend that the system administrator select the Configure link on the OrchestraCMS Installed Package detail page in Salesforce in order to refresh all permission sets after the OrchestraCMS installation.

This action will generate or regenerate any permission sets for the OrchestraCMS profile, and display the status of the OrchestraCMS Permission Generator Batch job.

Permissions are also updated when the system administrator logs in to OrchestraCMS.

The permission sets are applied to users when they are added to an OrchestraCMS profile.

 

When you first upgrade from an earlier version of OrchestraCMS, you will need to check for any new license permissions. In setup, under Licenses, click Check Now. Then in Setup, under Caches, click Run Global Content.

Language Selector content template

You can add the Language Selector content template to your pages so your site visitors can view the page in another language. Public site visitors can select any language the current page supports. Authenticated users (Intranet or Communities) will see multilingual pages in the language specified on their user record unless you disable the “Always use Salesforce User Language to determine language” option shown in Setup under Manage Languages.

We recommend you translate the Language Selector Label into all the languages the site supports.

  • When you drop the Language Selector on a page, it displays a list of languages the page has.
  • When you drop the Language Selector on a master page to make it available to all pages using that master page, it will always display the list of available languages in the master page.

Third party involvement

In the event a solution was built by a third party agency, it is strongly recommended that the third party agency be involved in the upgrade process.

JQuery Upgrade

As of OrchestraCMS Summer 2015, we have migrated the version of jQuery we are running from 1.5.1 to 1.11.2. Customers upgrading from any version below OrchestraCMS Summer 2015 may need to accommodate for the jQuery upgrade.

There are a few methods that have been deprecated or removed that we have seen in use in customer solutions. If you are making use of our version of jQuery, or have a heavily dependent jQuery solution, you should review your custom code to ensure you are not using methods that no longer exist. Solutions that make use of their own versions of jQuery and are using noConflict for their custom code should not be affected.

http://api.jquery.com/category/removed/

Example - As of jQuery 1.7, the .live() method is deprecated. Use .on() to attach event handlers.

http://api.jquery.com/live/

.on is geared to any customers that have not upgraded to at least OrchestraCMS Spring 2015 (OrchestraCMS v7).

Permission Sets for Library conversion

Being able to create a permission set allowing users to edit inactive user records is required for any OrchestraCMS users with an OrchestraCMS System Administrator or OrchestraCMS Site Administrator profile.

We strongly recommend that you create a permission set specifically for this purpose before you attempt to convert a media library, and that you do not apply it to autogenerated OrchestraCMS permission sets.

Create permissions to edit inactive user records

  1. In Salesforce App setup, under Customize, select User Interface.
  2. In User Interface, under Setup, select “Set Audit Fields upon Record Creation” and “Update Records with Inactive Owners” User Permissions.
  3. Click Save.
  4. In Salesforce Administration Setup, under Manage Users, select Permission Sets.
  5. On the Permission Sets page, click New.
  6. Create a new Permission Set, such as OrchestraCMS Library Media Conversion.
  7. Click Save.
  8. In the interface for your new Permission Set, under System, click System Permissions.
  9. Enable “Update Records with Inactive Owners”.

Further notes regarding the OrchestraCMS upgrade process

  • Sandboxes do not run with the same performance as Production; however, you should make note of the durations taken for the package installation (Step 4), the Permission Set update (Step 5), and the Cache refreshes (Step 6) to have an idea of expected downtime in production.
  • Production upgrade schedules should not be planned until UAT has been completed on all the sites.
  • Stantive Technologies Group only provides official support for the browser versions supported by Salesforce.