Add the App

<!DOCTYPE html> <html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en-US" xml:lang="en-US" class="_Skins_SideNav" data-mc-search-type="Stem" data-mc-help-system-file-name="Default.xml" data-mc-path-to-help-system="../../" data-mc-has-content-body="True" data-mc-toc-path="K2 for SharePoint|Administer" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic;Default" data-mc-preload-images="false" data-mc-in-preview-mode="false"> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta charset="utf-8" /> <meta name="productName" content="Nintex Automation (5.8) User Guide" /> <meta name="addsearch-custom-field" data-type="double" content="addsearch-filter-version=5.8" /> <meta name="addsearch-custom-field" data-type="text" content="addsearch-filter-product=Nintex-Automation" /> <meta name="addsearch-filter-version" data-type="text" content="type=5.8" /> <meta name="addsearch-filter" data-type="text" content="type=Nintex Automation" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="msapplication-config" content="../../Skins/Favicons/browserconfig.xml" /> <link rel="apple-touch-icon" sizes="180x180" href="../../Skins/Favicons/apple-touch-icon.png" /> <link rel="shortcut icon" href="../../Skins/Favicons/favicon-32x32.png" /> <link rel="icon" sizes="96x96" href="../../Skins/Favicons/favicon-96x96.png" /> <link rel="icon" sizes="32x32" href="../../Skins/Favicons/favicon-32x32.png" /> <link rel="icon" sizes="16x16" href="../../Skins/Favicons/favicon-16x16.png" /><title>Add the App</title>   <link rel="icon" type="image/png" href="https://help.nintex.com/FaviconGrey-sm.png" /> <link rel="shortcut icon" href="https://help.nintex.com/FaviconGrey-sm.png" type="image/x-icon" /> <link href="../../Skins/Default/Stylesheets/Slideshow.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/Components/Styles.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/Components/Tablet.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/Components/Mobile.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Default/Stylesheets/Components/Print.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Fluid/Stylesheets/foundation.6.2.3.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Fluid/Stylesheets/Styles.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Fluid/Stylesheets/Tablet.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Fluid/Stylesheets/Mobile.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../../Skins/Fluid/Stylesheets/Print.css" rel="stylesheet" type="text/css" data-mc-generated="True" /> <link href="../Resources/Stylesheets/new.skin.differences.css" rel="stylesheet" type="text/css" /> <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" /> <style>/*<meta />*/ .button.expand-all-button { -pie-background: linear-gradient(transparent, transparent); } .button.collapse-all-button { -pie-background: linear-gradient(transparent, transparent); } .needs-pie { behavior: url('../../Resources/Scripts/PIE-no-motw.htc'); } </style> <link rel="apple-touch-icon" sizes="180x180" href="../../Skins/Favicons/apple-touch-icon.png" /> <link rel="shortcut icon" href="../../Skins/Favicons/favicon-32x32.png" /> <link rel="icon" sizes="96x96" href="../../Skins/Favicons/favicon-96x96.png" /> <link rel="icon" sizes="32x32" href="../../Skins/Favicons/favicon-32x32.png" /> <link rel="icon" sizes="16x16" href="../../Skins/Favicons/favicon-16x16.png" /> <script src="../../Resources/Scripts/jquery.min.js" type="text/javascript"> </script> <script src="../../Resources/Scripts/purify.min.js" type="text/javascript" defer="defer"> </script> <script src="../../Resources/Scripts/require.min.js" type="text/javascript" defer="defer"> </script> <script src="../../Resources/Scripts/require.config.js" type="text/javascript" defer="defer"> </script> <script src="../../Resources/Scripts/foundation.6.2.3_custom.js" type="text/javascript" defer="defer"> </script> <script src="../../Resources/Scripts/plugins.min.js" type="text/javascript" defer="defer"> </script> <script src="../../Resources/Scripts/MadCapAll.js" type="text/javascript" defer="defer"> </script> <script> /* <![CDATA[ */ (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-W4F8LZ3'); /* ]]> */ </script> <script type="text/javascript" src="../../Skins/Default/Scripts/TopicToolBar.js"> </script> </head> <body class="topicpagebody"> <div class="foundation-wrap off-canvas-wrapper"> <div class="off-canvas-wrapper-inner" data-off-canvas-wrapper=""> <aside class="off-canvas position-right" role="navigation" id="offCanvas" data-off-canvas="" data-position="right" data-mc-ignore="true"> <ul class="off-canvas-drilldown vertical menu off-canvas-list" data-drilldown="" data-mc-back-link="Back" data-mc-css-tree-node-expanded="is-drilldown-submenu-parent" data-mc-css-tree-node-collapsed="is-drilldown-submenu-parent" data-mc-css-sub-menu="vertical menu slide-in-right is-drilldown-submenu" data-mc-include-indicator="False" data-mc-include-icon="False" data-mc-include-parent-link="True" data-mc-include-back="True" data-mc-defer-expand-event="True" data-mc-expand-event="click.zf.drilldown" data-mc-toc="True"> </ul> </aside> <div class="off-canvas-content inner-wrap" data-off-canvas-content=""> <div data-sticky-container="" class="title-bar-container"> <nav class="title-bar tab-bar sticky" role="banner" data-sticky="" data-options="marginTop:0" style="width:100%" data-sticky-on="only screen and (max-width: 1279px)" data-mc-ignore="true"><a class="skip-to-content fluid-skip showOnFocus" href="#">Skip To Main Content</a> <div class="middle title-bar-section outer-row clearfix"> <div class="menu-icon-container relative clearfix"> <div class="central-account-wrapper"> <div class="central-dropdown"><a class="central-account-drop"><span class="central-account-image"></span><span class="central-account-text">Account</span></a> <div class="central-dropdown-content"><a class="MCCentralLink central-dropdown-content-settings">Settings</a> <hr class="central-separator" /><a class="MCCentralLink central-dropdown-content-logout">Logout</a> </div> </div> </div> <button class="menu-icon" aria-label="Show Navigation Panel" data-toggle="offCanvas"><span></span> </button> </div> </div> <div class="title-bar-layout outer-row"> <div class="logo-wrapper"><a class="logo" href="../WelcomeLandingPages/NintexK2Landing.htm" alt="Logo"></a> </div> <div class="navigation-wrapper nocontent"> <ul class="navigation clearfix" role="navigation" data-mc-css-tree-node-has-children="has-children" data-mc-css-sub-menu="sub-menu" data-mc-expand-event="mouseenter" data-mc-top-nav-menu="True" data-mc-max-depth="3" data-mc-include-icon="False" data-mc-include-indicator="False" data-mc-include-children="True" data-mc-include-siblings="True" data-mc-include-parent="True" data-mc-toc="True"> <li class="placeholder" style="visibility:hidden"><a>placeholder</a> </li> </ul> </div> <div class="central-account-wrapper"> <div class="central-dropdown"><a class="central-account-drop"><span class="central-account-image"></span><span class="central-account-text">Account</span></a> <div class="central-dropdown-content"><a class="MCCentralLink central-dropdown-content-settings">Settings</a> <hr class="central-separator" /><a class="MCCentralLink central-dropdown-content-logout">Logout</a> </div> </div> </div> <div class="nav-search-wrapper"> <div class="nav-search row"> <form class="search" action="#"> <div class="search-bar search-bar-container needs-pie"> <input class="search-field needs-pie" type="search" aria-label="Search Field" placeholder="Search" /> <div class="search-filter-wrapper"><span class="invisible-label" id="search-filters-label">Filter: </span> <div class="search-filter" aria-haspopup="true" aria-controls="sf-content" aria-expanded="false" aria-label="Search Filter" title="All Files" role="button" tabindex="0"> </div> <div class="search-filter-content" id="sf-content"> <ul> <li> <button class="mc-dropdown-item" aria-labelledby="search-filters-label filterSelectorLabel-00001"><span id="filterSelectorLabel-00001">All Files</span> </button> </li> </ul> </div> </div> <div class="search-submit-wrapper" dir="ltr"> <div class="search-submit" title="Search" role="button" tabindex="0"><span class="invisible-label">Submit Search</span> </div> </div> </div> </form> </div> </div> </div> </nav> </div> <div class="main-section"> <div class="row outer-row sidenav-layout"> <nav class="sidenav-wrapper"> <div class="sidenav-container"> <ul class="off-canvas-accordion vertical menu sidenav" data-accordion-menu="" data-mc-css-tree-node-expanded="is-accordion-submenu-parent" data-mc-css-tree-node-collapsed="is-accordion-submenu-parent" data-mc-css-sub-menu="vertical menu accordion-menu is-accordion-submenu nested" data-mc-include-indicator="False" data-mc-include-icon="False" data-mc-include-parent-link="False" data-mc-include-back="False" data-mc-defer-expand-event="True" data-mc-expand-event="click.zf.accordionMenu" data-mc-toc="True" data-mc-side-nav-menu="True"> </ul> </div> </nav> <div class="body-container"> <div data-mc-content-body="True">  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-W4F8LZ3" height="0" width="0" style="display:none;visibility:hidden"></iframe> </noscript>  <div class="nocontent"> <div class="MCBreadcrumbsBox_0 breadcrumbs" role="navigation" aria-label="Breadcrumbs" data-mc-breadcrumbs-divider=" > " data-mc-breadcrumbs-count="3" data-mc-toc="True"><span class="MCBreadcrumbsPrefix">You are here: </span> </div> </div> <div class="buttons popup-container clearfix topicToolbarProxy _Skins_TopicToolBar mc-component nocontent" style="mc-topic-toolbar-items: ;"> <div class="button-group-container-left"> <button class="button needs-pie expand-all-button" data-state1-class="expand-all-button" data-state2-class="collapse-all-button" data-state2-title="Collapse all" title="Expand all" data-state1-title="Expand all"> <div> <div role="img" class="button-icon-wrapper" aria-label="Expand all"> <div class="button-icon"> </div> </div> </div> </button> </div> </div>   <div class="bodycontainer"> <div style="float:right;" data-mc-conditions="K2ProductConditionalTags.K2Connect_Content,K2ProductConditionalTags.K2Five_Content,K2ProductConditionalTags.Version_Selector,LegacyFlags.K2LegacyVersion"> <label class="text-muted">Version</label> <select id="VersionSelector" class="custom-select my-select" style="width:200px"> <option><span class="K2VersionVariables.Current mc-variable">Select a Version</span></option><option><span class="K2VersionVariables.Version1 mc-variable">5.8</span></option><option><span class="K2VersionVariables.Version2 mc-variable">5.7</span></option><option><span class="K2VersionVariables.Version3 mc-variable">5.6</span></option><option><span class="K2VersionVariables.Version4 mc-variable">5.5</span></option></select></div>   <p class="Note-genericblue" data-mc-conditions="ProductNameChange2022.Pre-Update"> We're updating some of our product names. <span class="mc-variable ProductNameChange2022.OriginalName variable">K2 Five</span> is now <span class="mc-variable ProductNameChange2022.NewName variable">Nintex Automation</span>. You may see both product names in our help pages while we make this change.</p>  <div role="main" id="mc-main-content"> <h1><a name="Add"></a><a name="kanchor18"></a>Add the app</h1> <div> <div class="NoteBox" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">From <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> (5.7) onwards there are two different apps for SharePoint. The legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint: used for SharePoint on-premises and upgraded environments for SharePoint Online, and <a href="AppComparison.htm" target="_self"><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span></a>: used on new installations for SharePoint Online. From <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> (5.8) onwards you can migrate your existing SharePoint Online solutions from <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint to <a href="AppComparison.htm" target="_self"><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span></a> using the <a href="MigrationTool.htm" target="_self">Nintex K2 for SharePoint SPFx migration tool</a>. </div> <div> <p data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Existing customers upgrading to <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> (5.7) or later use the legacy app from the SharePoint App Catalog for all SharePoint environments. New installations of <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> use the legacy app from the SharePoint App Catalog for SharePoint on-premises, and the new <span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span> app (SPFx) for SharePoint Online.</p> </div> </div> <p> <p> </p> </p> <h2><a name="NA4SP"></a><a name="NA_for_SharePoint_App"></a><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Nintex Automation for SharePoint</span> Online</h2> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Install the app</a></span> <div class="MCDropDownBody dropDownBody"> <div> <p>The product integrates with SharePoint Online using an app. To enable integration between the product and SharePoint, you must install the app in SharePoint and then activate the SharePoint feature in Management which registers an instance of it. You then need to activate your SharePoint sites using this Service Instance.</p> <div class="NoteBox">The screenshots and instructions for third-party software are accurate at the time of writing. Third-party vendors may have changed or updated aspects of their systems (such as user interfaces, functionality, and security). As a result, this content may be outdated.</div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Add the app</a></span> <div class="MCDropDownBody dropDownBody"> <p>You can <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">add the app from the SharePoint store, or</MadCap:conditionalText> download the app, and then upload and enable it in SharePoint Online.</p> <p data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Follow these steps to add the app from the SharePoint store:</p> <ol> <li value="1" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Go to the <b>More features</b> page in the <b>SharePoint admin center</b> and select <b>Open</b> under <b>Apps</b>.<br /><img src="../K2-Management-Site/Features/SharePoint/Up002.png" /><![CDATA[ ]]></li> <li value="2" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">On the <b>Manage apps</b> page, select <b>SharePoint Store</b> in the left pane. </li> <li value="3" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Search for <span style="font-weight: bold;" class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span>. </li> <li value="4" data-mc-conditions="K2ProductConditionalTags.K2Five_Content"> Select the <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> App and select <b>Add</b>. <div class="CautionBox"><p data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Do not select the <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> Cloud app.</p></div></li> <li value="5" data-mc-conditions="K2ProductConditionalTags.K2Five_Content"> Select to add the app to all sites. </li> </ol> <p data-mc-conditions="K2ProductConditionalTags.K2Five_Content"><b>Or</b> use the following steps to download the app, and then upload and enable it in SharePoint Online:</p> <ol> <li value="1">Download the app file from <a href="https://help.nintex.com/en-US/platform/ReleaseNotes/NAforSharePoint.htm" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Nintex Automation for SharePoint app</a>.</li> <li value="2">In the <b>SharePoint admin center</b>, select <b>More features</b> and click the <b>Open</b> button in the <b>Apps</b> section.<br /><img src="../K2-Management-Site/Features/SharePoint/Up002.png" /></li> <li value="3">In <b>Manage apps</b>, click <b>Upload</b>.<br /><img src="../K2-Management-Site/Features/SharePoint/Up003.png" /></li> <li value="4" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Navigate to your <span class="mc-variable K2Variables.Nintex_Automation variable" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Nintex Automation</span> installation folder and into the SharePoint installer sub folder. </li> <li value="5">Select the <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content"><b>nintex-automation.sppkg</b></MadCap:conditionalText> file and click <b>Open</b>. </li> <li value="6">On the <b>Enable app</b> screen select <b>Enable this app and add it to all sites</b>, then click <b>Enable app</b>.<br /><img src="../K2-Management-Site/Features/SharePoint/Up004.png" data-mc-conditions="K2ProductConditionalTags.K2Five_Content" /><br /></li> <li value="7">Once the app is enabled click <b>Close</b>. </li> <li value="8">The <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content"><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span> app</MadCap:conditionalText> is now installed on your SharePoint Online environment.<br /><img src="../K2-Management-Site/Features/SharePoint/Up005.png" data-mc-conditions="K2ProductConditionalTags.K2Five_Content" /><br /></li> </ol> </div> </div> </div> <p><a name="Configure_feature_instance_in_Management"></a> </p> <div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" /></a><a name="Configure_the_feature_instance_in__Management"></a><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_" aria-expanded="false">Configure the feature instance in Management</a></span> <div class="MCDropDownBody dropDownBody"> <ol> <li value="1">Make sure you have your App Catalog SiteURL from SharePoint Online.</li> <li value="2">Navigate to <a href="../K2-Management-Site/K2-Management-Site.htm" target="_self">Management</a>. </li> <li value="3">Select <b>Features</b> or click on <b>Manage Features</b>.<br /><img src="../K2-Management-Site/Features/SharePoint/006.png" /></li> <li value="4">Select <b>SharePoint Site Collection</b>. </li> <li value="5">Click the <b>New Instance</b> button at the top left of the <b>Features</b> list. </li> <li value="6">In the <b>Configure Server</b> step, <b>App Catalog Site URL</b> text box, paste your App Catalog Site URL, for example: https://<companyname>.sharepoint.com/sites/appcatalog.<br /><img src="../K2-Management-Site/Features/SharePoint/003.png" /></li> <li value="7">Click <b>Configure</b>.</li> <li value="8">The Permission requested message displays, click <b>Accept</b>.<br /><img src="../K2-Management-Site/Features/SharePoint/002.png" /></li> <li value="9">The <b>Trust</b> integration runs. </li> <li value="10">Once completed and you see the <b>Authorization Successful</b> message, return to the App Feature Instance and click <b>Continue</b>. </li> <li value="11">The OAuth Resource, Claims, Administrative OAuth Token, SharePoint Service Broker, and Application configuration shows.<br /><img src="../K2-Management-Site/Features/SharePoint/004.png" /></li> <li value="12">Once everything has completed successfully, click <b>Close</b>.</li> <li value="13">In the <b>Activate Site Collection</b> step, add your Site URL to the <b>Site Collection URL</b> text box, for example, https://<companyname>.sharepoint.com/sites/<sitename>.<br /><img src="../K2-Management-Site/Features/SharePoint/005.png" /></li> <li value="14">Click <b>Activate</b>. </li> <li value="15">You must log in to your SharePoint site collection to create the authorization token. Once you see the <b>Authorization Successful</b> message, click <b>OK</b>.</li> <li value="16">The <b>Active Site</b> screen shows the sites activated on SharePoint Online.</li> <li value="17">Click <b>Close.</b></li> <li value="18">You can activate more site collections as needed. </li> <li value="19">Once the configuration is complete, close the <b>Add Feature Instance</b> screen.</li> </ol> </div> </div> </div> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" /></a><a name="Steps_to_remove_the_app"></a><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_" aria-expanded="false">Steps to remove the app</a></span> <div class="MCDropDownBody dropDownBody"> <p>For an overview of the differences when using the app see <a href="AppComparison.htm" class="MCXref xref">Nintex Automation for SharePoint app overview</a>. If you need to move back to the legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint app, use the following steps:</p> <ol> <li value="1"> <p>Uninstall your <b>SharePoint Site Collections</b> from Management > Features > SharePoint Site Collection. For more information see <a href="../K2-Management-Site/Features/SharePointOnline.htm" class="MCXref xref">SharePoint Online</a>.</p> <div class="ImportantBox">This will clear all your artifacts from each site collection. You must then recreate them after installing the legacy app.</div> </li> <li value="2"> <p>Delete the <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content"><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span> SharePoint Online (SPFx) app</MadCap:conditionalText> from your SharePoint Online <b>App Catalog</b>.</p> </li> <li value="3"> <p>Also delete the app from the following areas, one after the other:</p> <ul> <li> <p>[Tenant]/sites/appcatalog/Lists/K2%20Tracking/</p> </li> <li> <p>[Tenant]/sites/appcatalog/Lists/K2s%20Tracking/</p> </li> <li> <p> Recycle bin</p> </li> </ul> </li> <li value="4"> <p> <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Set the following flags</MadCap:conditionalText> to <b>False</b> in the K2 database under <b>HostServerFeature</b>:</p> <ul> <li> <p>SPOnlineModernForms</p> </li> <li> <p>Webhooks<br /><img src="SPFxImages/Database.png" /></p> </li> </ul> </li> <li value="5"> <p data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Restart the K2 Service.</p> </li> <li value="6"> <p>Clear your browser cache and close the browser.</p> </li> <li value="7"> <p>Install, register, deploy, and activate the legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint app to your SharePoint Online environment. Follow the Legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint app > Add the legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint app steps in <a href="#" class="MCXref xref selected">Add the app</a></p> </li> </ol> </div> </div> <h2><a name="Legacy__for_SharePoint_app"></a>Legacy <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint app</h2> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Add the app</a></span> <div class="MCDropDownBody dropDownBody"> <p>Follow the steps below to add the <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText> app to the app catalog site. </p> <div class="CautionBox">Do not use the SharePoint app from the App store, use the app that corresponds to your version of the product.</div> <div class="TipBox"><b>Tenant Administration</b> rights are required to register, deploy, and activate the app on the app catalog site. <b>Site Collection Administrator</b> rights are required to deploy and activate the app on site collections. View <a href="../Welcome/K2AppPermSP.htm#top">Permissions and rights</a> for more information. </div> <div class="NoteBox">The screenshots and instructions for third-party software are accurate at the time of writing. Third-party vendors may have changed or updated aspects of their systems (such as user interfaces, functionality, and security). As a result, this content may be outdated.</div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><div><a name="Adding_the_App_to_the_App_CatalogThe_K2_Appit_for_SharePoint_App_should_be_available_in_the_Site_Contents_of_the_App_Catalog.The_next_step_will_be_to_register_the_K2_Appit_for_SharePoint_App_in_the_App_Catalog."></a></div><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Add the app to the App Catalog</a></span> <div class="MCDropDownBody dropDownBody"> <div class="CautionBox">Do not access the app from the new Site Collection App Catalog, you must use the app from the SharePoint App Catalog.</div> <div class="NoteBox" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Use the <b>App Deployment</b> tool to deploy the <b>K2 Five for SharePoint</b> app to your App Catalog. This automatically runs during an installation, or you can manually run the tool from the setup folder after installation: <br />"%ProgramFiles%\K2\Setup\AppDeployment.exe"</div> <ol> <li value="1" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">The <b>K2 Five for SharePoint</b> app is not automatically added to the app catalog. Open the <b>Site Contents</b> page of your app catalog. Click on the <b>K2 Five for SharePoint</b> app in the <b>Apps you can add</b> section and add it.<br /><img src="015.png" data-mc-conditions="K2ProductConditionalTags.K2Five_Content" /></li> <li value="2">On the <MadCap:conditionalText style="font-weight: bold;" data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Do you trust K2 Five for SharePoint?</MadCap:conditionalText> page, click <b>Trust It</b>.<br /></li> <li value="3">Once the app has been added to the app catalog, the app is available in the app catalog's <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Site Contents</b> page.<br /></li> </ol> <p>Your next step is to register the app in the app catalog, as shown in the following section.</p> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Register the app</a><div><a name="Register_the_App"></a></div></span> <div class="MCDropDownBody dropDownBody"> <p>Follow these steps to register the app in the app catalog:</p> <ol> <li value="1">In the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Site Contents</b> of the app catalog, click the <b><MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText></b> app.<br /></li> <li value="2">On the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint > Settings > Registration Wizard</b> page, specify a <b>K2 URL</b> and click <b>Next</b>.<br /><img src="018.png" /></li> <li value="3">Next the Registration Wizard will run. Click <b>Finish</b> once complete.<br /><img src="019.png" /></li> </ol> <p>Your next step is to deploy the app to required site collections.</p> <div class="NoteBox"> When deploying the<MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content"> K2 Five for SharePoint</MadCap:conditionalText> app to the required site collections, the app is deployed to all subsites that exist within the chosen site collections. </div> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Deploy the app</a><div><a name="Deploy_the_App"></a></div></span> <div class="MCDropDownBody dropDownBody"> <p>Follow the steps below to deploy the app to the required site collections:</p> <ol> <li value="1">On the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint</b> page, click the <b>Manage App Deployments (SharePoint)</b> link.<br /><img src="020.png" /></li> <li value="2">Next the <b>Manage App Deployments > <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText></b> page opens. On the <b>Manage App Deployments</b> page, there are two methods to deploy the app to the required site collections. Firstly, as described in step 3, using the <b>Site Collections</b> section where site collections can be individually specified, and secondly, as described in step 4, using the <b>Managed Paths</b> section where all site collections can be specified via the <b>(All Paths)</b> option. If you follow the <b>Site Collections</b> method (step 3) then the <b>Managed Paths</b> method (step 4) should not be used as it will deploy to all site collections.<br /><div class="NoteBox">Best practice is to use the <b>Managed Paths</b> option to accomplish integration with SharePoint.</div></li> <li value="3">If specific site collections and their associated subsites are required for app deployment follow this step. In the <b>Site Collections</b> section, add the required site collections and click the <b>Add</b> button. Do not use the <b>Managed Paths</b> step as it will deploy to all site collections.<br /><div class="NoteBox">Multiple site collections can be added at once, if required.</div><br /><img src="021.png" /></li> <li value="4">If all paths are required follow this step. In the <b>Managed Paths</b> section, select the <b>(All Paths)</b> option and click <b>Add</b>. This deploys the app to all site collections and associated subsites that reside in the farm/tenancy <b>(All Paths)</b> or under a valid path, such as <b>sites</b>. This is a more efficient and the recommended way to accomplish integration with SharePoint than step 3 where you specify site collections individually.<br /><img src="022.png" /></li> <li value="5">Click <b>OK</b>.</li> <li value="6">Next click the <b>Trust It</b> button on the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Do you trust K2 Five for SharePoint</b> page.<br /><![CDATA[ ]]></li> </ol> <p>Your next step is to activate the app.</p> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Activate the app</a><div><a name="Activate_the_App"></a></div></span> <div class="MCDropDownBody dropDownBody"> <p>Follow these steps to activate the K2 for SharePoint app:</p> <ol> <li value="1">On the Site Contents page, click on the <b> <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText> app</b>.</li> <li value="2">Click the <b>Manage App Activations</b> link on the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint</b> page.<br /><img src="024.png" /></li> <li value="3">Next, on the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint > Settings > Manage App Activations</b> page, set the default server and specify the required site collections for activation and click <b>Activate</b>. <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">On the Manage App Activations page, select or deselect the <b>Enable auto-activation on sites where the app is deployed</b> check box, the check is selected by default. This option allows a administrator to specify specific site collections to have the app activated or all site collections where the app is deployed to be activated. Click the <b>Save</b> button then specify the site collection, then click the <b>Activate</b> button</MadCap:conditionalText> If the <b>Enable auto-activation on sites where the app is deployed</b> check box is deselected, you must activate the app from this page though the app appears on each site collection where the app is deployed.<br /><img src="025.png" /></li> <li value="4">Next the <b>Activate Site Collection</b> page opens and the specified site collection is activated. Notice that the site collection and all subsites now have the activated app.<br /><img src="026.png" /><div class="NoteBox">At activation time, all existing subsites in the site collection are activated with K2 for SharePoint. New subsites that are added at a later point, either manually or via a workflow, are also activated with K2 for SharePoint through the remote event receivers. This automatic activation may take a few minutes depending on your SharePoint environment. SharePoint Online instances do NOT include the remote event receiver, and hence do not get K2 for SharePoint automatically added to new subsites. For SharePoint Online you must reactivate the site collection using the <b>Manage App Activations</b> page, which finds the new subsites and only activates those.</div></li> <li value="5">When activating a site collection which contains a high number of subsites (50+), the activation may fail. To correct this issue click the <b>Retry</b> button on the <b>Activate Site Collection</b> page.<br /><img src="../Resources/Images/K2forSharePoint/RetryLink.png" /></li> <li value="6">Multiple site collections can be activated all at once if required, just repeat the above steps on <b>the Manage App Activations</b> page.<br /><div class="NoteBox">Ensure that if multiple site collections are required for activation, the app is deployed via the <b>Manage App Deployments</b> page first. For more information see <a href="https://community.nintex.com/k2-blackpearl-66/k2-for-sharepoint-deployment-and-activation-2668" target="_blank">KB001755 - K2 for SharePoint Deployment and Activation</a>.</div></li> <li value="7">Click the <b>Close</b> button on the <b>Activate Site Collection</b> page.</li> <li value="8">Click the <b>Close</b> button <b>Manage App Activations</b> page.</li> </ol> <div class="NoteBox"> You can integrate lists and libraries in SharePoint site collections with the product, but you cannot integrate list and libraries in the app catalog with the product. </div> </div> </div> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Manage the app</a></span> <div class="MCDropDownBody dropDownBody"><a name="Management"></a> <p> <div><a name="The"></a> </div>The following sections discuss how to manage a <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText> environment. All management of the app is done on the app catalog. From the <b>Settings</b> page of the app, deployments and activations are administered, whether that's adding the app to a site collection or uninstalling it from a previously-integrated site collection.</p> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Add the app to a SharePoint environment</a></span> <div class="MCDropDownBody dropDownBody"> <p>To add the app to a SharePoint environment see the <a href="#Add">Add </a>topic.</p> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Uninstall the app</a><div><a name="Uninstall_the_K2_Appit_for_SharePoint_App"></a></div></span> <div class="MCDropDownBody dropDownBody"> <p>To uninstall the app, use the settings page on the app catalog. This removes the app from the specified site collection and its associated subsites. Follow the steps below to uninstall the app:</p> <ol> <li value="1">Open the app catalog site, click <b>Site Contents</b>.</li> <li value="2"> On the <b>Site Contents</b> page click <b> <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText> app</b>. </li> <li value="3">On the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint</b> page, click the <b>Manage App Activations</b> link.<br /><img src="024.png" /><br /></li> <li value="4">On the <b>Manage App Activations</b> page select the required site collection where the app is currently installed and activated, and select it in the <b>Uninstall</b> section. Click the <b>Uninstall</b> button.<br /><br /><img src="027.png" /></li> <li value="5">A <b>Confirmation</b> dialog appears, click <b>OK</b>.<br /><img src="028.png" data-mc-conditions="K2ProductConditionalTags.K2Five_Content" /></li> <li value="6">The <b>Uninstall Site Collection page</b> opens and the uninstall begins automatically.<div class="NoteBox">When uninstalling the app from a site collection, all associated subsites that reside in the site collection, are also uninstalled.</div><img src="../Resources/Images/AppUninstall/UninstallApp02.png" /></li> <li value="7">Once the uninstall is complete, click the <b>Close</b> button.<br /><br /><img src="029.png" /></li> <li value="8">Click the <b>Close</b> button on the <b>Manage App Activations</b> page.</li> </ol> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" /></a><a name="Remove_the_App"></a><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_" aria-expanded="false">Remove the app from a SharePoint Environment</a></span> <div class="MCDropDownBody dropDownBody"> <p>To remove the app from a SharePoint environment, the app must first be uninstalled. To do this see the <a href="#Uninstall_the_K2_Appit_for_SharePoint_App">Uninstall</a> section.</p> <p>After uninstalling the app, the app can be removed from the <b>App Deployment</b> section of the app settings. To do this follow the steps below:</p> <div class="CautionBox"> <p>Before removing the app from the <b>App Deployment</b> section, ensure that the app has been uninstalled first from the necessary site collections.</p> </div> <ol> <li value="1">Open the app catalog site and navigate to <b>Site Contents > <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText></b>.</li> <li value="2">On the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Apps > K2 for SharePoint</b> page, click the <b>Manage App Deployments (SharePoint)</b> link.<br /><img src="020.png" /></li> <li value="3">On the <b>Manage App Deployments > <MadCap:conditionalText data-mc-conditions="K2ProductConditionalTags.K2Five_Content">K2 Five for SharePoint</MadCap:conditionalText></b> page, select the site collection to remove from the <b>Site collections to deploy to:</b> section and click the <b>Remove</b> button.<br /><img src="030.png" /></li> <li value="4"> If you instead deployed using <b>Managed Paths</b>, click the paths you deployed to in the <b>Managed paths to deploy to:</b> section and then click the <b>Remove</b> button.<br /><img src="031.png" /><br /></li> <li value="5">Click the <b>OK</b> button.</li> <li value="6">Next the <b data-mc-conditions="K2ProductConditionalTags.K2Five_Content">Do you trust K2 Five for SharePoint?</b> page opens, click the <b>Trust it</b> button.<br /></li> </ol> <p> If you want to remove the app and integration artifacts see <a href="RemoveartifactsintegrationSP.htm">Remove artifacts and integration from SharePoint</a>.</p> </div> </div> </div> </div> <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../Skins/Default/Stylesheets/Images/transparent.gif" height="8" width="16" alt="Closed" data-mc-alt2="Open" />Considerations</a></span> <div class="MCDropDownBody dropDownBody"> <ul> <li><b>Known issue</b>:<br />After running the registration wizard and trying to access the <b>Manage App Activation</b> page, you may get a "- 500 Session is invalid" error.<br /><b>Resolution</b>:<br />Do not use Google Chrome Incognito mode to access the <b>Manage App Activation</b> page. Access the page using Google Chrome in normal mode.</li> <li>From <span class="mc-variable K2Variables.Nintex_Automation variable">Nintex Automation</span> (5.8) onwards you can migrate your existing SharePoint Online solutions from <span class="mc-variable K2ProjectVariables.Nintex_K2 variable">Nintex K2</span> for SharePoint to <a href="AppComparison.htm" target="_self"><span class="mc-variable K2Variables.Nintex_Automation_for_SharePoint variable">Nintex Automation for SharePoint</span></a> using the <a href="MigrationTool.htm" target="_self">Nintex K2 for SharePoint SPFx migration tool</a>.</li> </ul> </div> </div> <div class="MCHelpControl MCHelpControl-Related relatedTopics"><span class="MCHelpControl-RelatedHotSpot_">Related Topics</span> <ul class="MCHelpControlList MCRelatedTopicsControlList"> <li class="MCHelpControlListItem MCRelatedTopicsControlListItem"><a class="MCHelpControlListItemLink MCRelatedTopicsControlListItemLink" href="LifecycleMangSPandK2.htm">Lifecycle Management of SharePoint with K2 Integration</a> </li> </ul> </div> </div> </div> <div class="footer"> <div> <p><a href="https://community.nintex.com/" class="footer">Nintex Community</a> </p> </div> <div> <p><a href="https://learn.nintex.com/" class="footer">Nintex University</a> </p> </div> <div> <p><a href="https://customer.nintex.com/" class="footer">Customer Central</a> </p> </div> <div> <p><a href="https://www.nintex.com/resources/nintex-customer-support/" class="footer">Support</a> </p> </div> <div> <p><a href="https://www.nintex.com/" class="footer">Nintex.com</a> </p> </div> <div> <p><a href="https://www.nintex.com/legal/" class="footer">Legal Notices</a> </p> </div> <div> <p><a href="https://www.nintex.com/security/" class="footer">Security</a> </p> </div> <div> <p><a href="https://status.nintex.com/" class="footer">Status</a> </p> </div> </div>  <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js"> </script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"> </script>  <script>/* <![CDATA[ */ $(document).ready(function(){ $('[data-toggle="tooltip"]').tooltip(); }); /* ]]> */</script>   <script src="../Resources/scripts/loadProductName.js"> </script> <script>/* <![CDATA[ */loadProductName();/* ]]> */</script>    <MadCap:conditionalText data-mc-conditions="TemplateFeatures.EnableSortableTables"> <script type="text/javascript" src="../Resources/scripts/sorttable.js"> </script> </MadCap:conditionalText>  <script src="../Resources/scripts/flare10_lightweight/flare10_lightweight.js"> </script>    <MadCap:conditionalText data-mc-conditions="LegacyFlags.K2LegacyVersion"> <script src="../Resources/scripts/k2versionSwitch.js"> </script> </MadCap:conditionalText>  <MadCap:conditionalText data-mc-conditions="LegacyFlags.CustomDropDowns"> <script src="../Resources/scripts/customDropDown.js"> </script> <script>/* <![CDATA[ */loadCustomDropdowns();/* ]]> */</script> </MadCap:conditionalText> </div> </div> </div> </div><a data-close="true"></a> </div> </div> </div> </body> </html>

CINXE.COM

Add the App