Upgrading Secondary SmartForms Runtime Sites
It is possible to configure a single K2 smartforms site with multiple authentication providers. (It is also possible to create a copy of your SmartForms site for each authentication method, as described in Configuring a secondary SmartForms Runtime site. In some cases it may be desirable to continue having multiple sites rather than consolidate to a single site.) This topic describes the steps necessary to upgrade these copied sites to the latest K2 version and reconfigure them for the appropriate authentication method using the Claims based / Realm model.
Before you make the decision to upgrade your copied sites, review the Multi-Auth providers topic to understand if a single Multi-Auth enabled site would meet your needs. If you want to consolidate refer to the Consolidation to Multi-Auth topic for detailed steps.
Configuration
These high-level steps are provided for those familiar with upgrading K2 smartforms and configuring authentication methods. For a detailed guide, see the Detailed Steps section below.
- If necessary, upgrade your primary SmartForms site to the latest K2 version.
- Copy the upgraded primary site over the secondary sites.
- Configure Realms for the secondary sites.
- Configure Claims for the secondary sties.
Detailed Steps
The K2 smartforms installer will upgrade your primary SmartForms site, both design-time and runtime. Any SmartForms sites that were copied in order to facilitate different authentication modes will not be upgraded by the installer. Only those sites that were created through the K2 smartforms installer will be upgraded.
Since the SmartForms installer does not upgrade the copied sites, you will need to manually copy the files from the upgraded primary SmartForms site over the files in the copied SmartForms sites. Once this is done the sites will no longer be configured for the desired authentication modes. The subsequent steps will guide you on configuring the appropriate authentication mode for each site using the new Realm model.
In the new Realm configuration model all the SmartForms authentication configuration is stored centrally in the K2 database. Realms are used in order to distinguish which sites use which types of authentication. For each secondary SmartForms site that you are upgrading follow the steps below to create the Realm and configure the site to map to the Realm.
- Open the K2 Manage Site and browse to Authentication> Claims> Realms your primary SmartForms runtime site.
- Under Realms click New.
- For the URI field enter the URL to your supplementary SmartForms site (Example: https://k2.denallix.com/RuntimeSQLUM/)
- For the Reply URI field enter the relative URL to the SmartForms site (Example: /RuntimeSQLUM/).
- For the Linked Issuers you can select the appropriate option if it is available. If you don’t see the appropriate option leave the check boxes blank. The configuration steps in Step 4 will guide you through configuring an appropriate Issuer.
- Click OK to add the Realm.
- Open the web.config file for the secondary SmartForms site and locate the Federation Configuration section.
- For the cookieHandler property set the path value to be the same as the Reply URI you configured above but without the trailing slash (Example: /RuntimeSQLUM)
- For the wsFederation property set the realm value to be the same as the Realm URI you configured above (Example: https://k2.denallix.com/RuntimeSQLUM/
- Save and close the web.config file.
The final step is to configure or clean up the imported Claims configuration depending upon the type of authentication you want to enable for the site. The documents listed below have all the necessary steps for configuring a SmartForms site to use each authentication mode. You may have already completed some of the steps in these documents as they assume that you are starting from scratch rather than upgrading. Since you are upgrading existing sites, the most important parts are the steps around the Issuer and Claim Mapping configurations. If you are upgrading an AD FS configured site, some of the Claim configuration will have been automatically imported into the database but you will need to fill in some additional details. If you are upgrading a Forms Authentication site that used SQLUM, there will be no imported claims configuration and you will need to follow all the steps.
- Configure SmartForms for Active Directory Federation Services (AD FS)
- Configure SmartForms for Azure Active Directory (AAD)
- Configure SmartForms for Forms Authentication using SQLUM
When WindowsSTS authentication or FormsSTS authentication is enabled, it is important to frequently save work that has been done in the K2 Designer as work might be lost when the same session is left open for 8 hours or longer.