Managing the K2 Five settings for a specific Site Collection

The K2 for SharePoint App Settings page can be accessed by clicking on the K2 Five App in the SharePoint Site Contents page.

Use the options below to access and manage K2 for SharePoint features and settings.

General

Use this option to rerun the Activation Wizard on a site collection level. The Activation Wizard, reactivates the K2 Five app on the site collection.

You can only rerun the Activation Wizard on a site collection level in K2 Five for SharePoint.

To rerun the Activation Wizard, follow the steps below:

  1. On your site collection, click Site Contents > K2 Five.
  2. Click the Activate Site Collection link in the General section.

  3. The Activation Wizard runs. Take note that all subsites associated with the site collection will get the app reactivated.

  4. Click the Close button.

Use this option to remove the K2 for SharePoint app from the SharePoint Site. For more information go to the Uninstall topic.

You can only on a site collection level in K2 Five for SharePoint.

Removing K2 Five and K2 artifacts from a Site Collection

Removing K2 artifacts from a SharePoint site does not remove them from the K2 server, it does however remove the remote events which allow workflows to start.

  1. To remove the K2 artifacts, browse to the K2 Five settings page and click the Uninstall link under the General heading.
  2. The Uninstall K2 for SharePoint page is shown, select Uninstall or Cancel:

    Once the actions described on the uninstall page have been performed (green check-marks will show), the page will redirect to the home page.
  3. In the previous step, if Uninstall is clicked, the following warning is shown. Select either OK or Cancel.
Previously-created Workflows will not function if the K2 Five app is added back to the site collection at this point. These workflows need to be redeployed so they can work again. Once the K2 artifacts are removed, the remote events in the existing workflows are also removed and redeploying the workflow is the only way to re-register the events and reintegrate the application.

Artifacts

The following Artifacts are available:

Use this option to view reports based on the site collection workflows. For more information go to the Using Reports topic.

The SmartObjects artifact is used for generating and managing SmartObjects.

Generate SmartObjects

Follow these steps to generate single or multiple SharePoint List or Library SmartObjects for a Site:

  1. Click on New from either the Libraries or Lists section.
  2. A list of SharePoint Lists or Libraries will display depending on which section you are working from. Select the items for which the SmartObjects will be created by clicking the check-box in front of each item. Select the Scope of these items. The Scope can be changed per item at a later stage. The Scope options are:
    • This Site and all of its subsites - This option enables the use of the SmartObjects in a K2 workflow designed in the K2 for SharePoint application from any List or Library in the Site Collection including all of the sites subsites.
    • List/Library - This option enables the use of the SmartObjects in a K2 workflow designed in the K2 for SharePoint application only for the specific List or Library.
    • None - Selecting this option will prevent the use of the SmartObjects in a K2 workflow designed in the K2 for SharePoint application.
  3. Click OK to generate the selected items as SmartObjects.
  4. The items selected will now be listed under the relevant sections indicating the scope per item.
  5. If you click on New again, only the items for which SmartObjects do not exist will now be displayed. These can be selected to generate SmartObjects.

    6. When generating SmartObjects based on SharePoint Lists, the associated Attachments SmartObject will also be generated and displayed in the list of SmartObjects as per the image above.

    Clicking OK or Cancel on the Manage SmartObjects Landing page after generating SmartObjects, will not influence the SmartObjects generated. It will only save or cancel changes made to the Scope of these SmartObjects.

Manage SmartObjects

To manage SmartObjects, click on the SmartObjects artifact from the K2 for SharePoint App Settings page.

The Scope of SmartObjects can be changed from this page. The scope determines where the SmartObject is visible for workflows. The scope options are:

  • This Site and all of its subsites - This option enables the use of SmartObjects in workflows designed any SharePoint List, Document Library or related subsites in the Site Collection.
  • List/Library - This option enables the use of the SmartObjects in a workflow only for the specific SharePoint List or Document Library.
  • None - Selecting this option will prevent the use of the SmartObject in a workflow designed in the K2 Application.

To change the scope per SmartObject, select a SmartObject and click Edit or double click the SmartObject. Click on the drop-down under Scope and select the new scope for the SmartObject.

Click OK at the bottom of the page to finish editing the SmartObject's visibility settings.

Changes to the SmartObjects are saved at the time of making the change. Clicking Cancel on this page will not undo your changes.
Additional SmartObjects

The Additional SmartObjects section allows you to add or remove other SmartObjects so that they are visible when designing a workflow. For example, if you had a SmartObject that exposes a SQL database, you must add the SmartObject to the Additional SmartObjects section before it is available in the workflow design tool. Note that any SmartObjects you add in the Additional section appear in the SmartObjects tab of the workflow designer for all workflows designed on the site.

To add SmartObjects, click on the Add button and then use the ellipsis button to browse for and select the SmartObject you want to expose in the workflow designer.

Additional SmartObjects can be removed either by selecting a SmartObject and clicking Remove option, or click Remove All to remove all the SmartObjects listed.

Use this link to open the K2 Designer. You can use the K2 Designer to manually create SmartObjects and work with SmartForms.

Permissions

Use this option to specify K2 permissions based on site collection group membership. The available option is:

  • Solution Participants (Legacy): Assign permissions to members in the site collection Group/s to start and view information about workflows they participate in. This option only applies to workflows created in Workflow Designer (Legacy).

The synchronization of Site Collection Groups between SharePoint and K2 occurs every 8 hours by default. This option can however be used to force the synchronization after changes were made to a group/s and these changes need to reflect in K2 immediately.

This operation may require a few minutes to complete dependent on the size of the site as well as the number of users in the Site Collection Group.

The following Synchronization options are available:

  • Sync All - This option enables synchronization for all SharePoint site groups. This includes groups in the Solution Designers, Solution Participants and other SharePoint groups not part of these roles.
  • Synchronize K2-related Groups - This option enables synchronization between SharePoint site groups and K2. Only SharePoint groups that are in the Solution Designers and Solution Participants roles will be synchronized.
If you have chosen to use the new Sync Service by running the Enable New Identity Service installer as described in the KB002707: Identity Synchronization and Caching, automatic synchronization is turned on for your environment and you will not need to synchronize site groups. Clicking Synchronize Groups on the Administration screen opens the following screen:

Management

This takes you to the K2 Management site where you can manage SmartObjects, Workflows, Worklists, Users and Server for example. See the K2 Management Site for more information on using the Management site.

Related Topics