Transcription

Virto SharePoint Kanban Board Web Partfor SharePoint 2013, 2016, and 2019v. 5.3.3Installation and User GuideCopyright 2022 All rights reserved. www.virtosoftware.com

2ContentsSYSTEM/DEVELOPER REQUIREMENTS.4VIRTO KANBAN BOARD OVERVIEW .4INSTALLATION AND LICENSE ACTIVATION .4EXPECTED OUTAGE . 4INSTALLING VIRTO KANBAN BOARD WEB PART . 4SPFX WEB PART INSTALLATION . 7ERROR “SORRY APPS ARE TURNED OFF”: WHAT TO DO . 7LICENSE ACTIVATION . 8UPGRADING VIRTO KANBAN BOARD . 8UNINSTALLING VIRTO KANBAN BOARD . 9VIRTO SHAREPOINT KANBAN BOARD ADJUSTMENT.9ADD WEB PART . 9QUICK BOARD AND BOARD FROM AN EXISTING LIST . 11KANBAN BOARD ADMINISTRATION TOOLS. 13LISTS AND COLUMNS COMPATIBILITY . 19LIST SETUP . 20Select List . 21Available Content Types . 22Board Templates . 23BOARD SETUP. 26Columns . 26Adding Required Fields . 31Swimlanes . 32Sorting . 37Views & Filters. 37CARDS SETUP . 39Task Information . 39Short View . 43Full View . 44Comments. 45Styles . 50ADVANCED SETUP . 53Filters . 53Notifications . 56Permissions . 58Additional . 59USING VIRTO SHAREPOINT KANBAN BOARD WEB PART .61MANAGING TASKS. 61Toolbar . 61Short View (tooltip) . 62Task Watchers . 63Comments. 64USING SWIMLANES . 66TASK FILTERS . 67ACTIONS . 72Auto-assign tasks. 72Bulk swimlane change. 74CREATE AND EDIT A NEW TASK . 74TASK DELETE NOTIFICATION . 77IMAGES . 78SUBTASKS . 79Copyright 2022 All rights reserved. www.virtosoftware.com

3Add New Subtask . 79Edit Subtasks in a Subtasks Tab . 81Sorting of Subtasks . 81View Subtasks on the Kanban Board . 82Group Subtasks on the Board by Parent Tasks. 83Parent ID Field . 84Subtask Counter . 85CHARTS . 85Status . 86Assigned To . 87Completion . 88Burndown . 89BOARD HISTORY. 90VERSION RELEASE HISTORY .91Copyright 2022 All rights reserved. www.virtosoftware.com

4System/Developer RequirementsSP version2019Operation System64-bit edition ofWindows Server2012 R2 Service Pack1 AND 64-bit editionof Microsoft SQLServer 2014 ServicePack 1 (SP1)ServerSharePoint Server2019, Microsoft .NETFramework 4.5.2BrowserMicrosoft InternetExplorer 10 orgreater, GoogleChrome, Firefox,Mozilla201664-bit edition ofWindows Server2012 R2 Service Pack1 AND 64-bit editionof Microsoft SQLServer 2014 ServicePack 1 (SP1)Windows Server2012 Standard orDatacenter X64 /2008 R2 SP1SharePoint Server2016, Microsoft .NETFramework 4.5.2Microsoft InternetExplorer 10 orgreater, GoogleChrome, Firefox,MozillaSharePoint Release:Microsoft SharePointFoundation 2013 orMicrosoft SharePointServer 2013;Microsoft .NETFramework 4.5Windows Server2008 x64 / 2008 R2SharePoint Release:Microsoft SharePointFoundation 2010 orMicrosoft SharePointServer 2010.Microsoft .NETFramework 3.5Internet Explorer 8 orgreater isrecommended forAdvancedAdministrationfeatures, Mozilla,Firefox, GoogleChrome supportedInternet Explorer 7 orgreater isrecommended forAdvancedAdministrationfeatures, MozillaFirefox supported20132010Copyright 2022 All rights reserved. www.virtosoftware.com

4Virto Kanban Board OverviewSharePoint Kanban Board Web Part is an agile tool to visualize and manage tasks in SharePoint 2019,2016, 2013, and 2010. Virto Kanban web part allows you to show any SharePoint list and multiplelists as a Kanban Board, where you can drag & drop and sort tasks between columns and swimlanesof a project. With this SharePoint task management web part, managers can quickly revealbottlenecks and blockers. Less time is spent sorting out how projects are coming along, becauseeverything is visible on the SharePoint Kanban board. It is a part of Virto ONE License. It is alsoavailable as Kanban Board App for Office 365. The web part supports SharePoint Server SubscriptionEdition.Installation and License ActivationExpected OutageThe expected outage time is from 2 minutes to several hours depending on your hardware andnumber of SharePoint sites. Though we recommend all Virto users to upgrade on a weekend.Installing Virto Kanban Board Web PartBefore you begin, you need to make sure you have access to the server and your account musthave the appropriate administrative privileges to install applications.To access Virto Kanban Board Setup program p file and unzip it. Run extracted Setup.exe file. Theinstall process for all the SharePoint versions looks very similar. If you’re installing the VirtoOne,you need to follow almost the same steps.The setup wizard window will appear.Copyright 2022 All rights reserved. www.virtosoftware.com

5Virto Kanban Board Setup wizard performs a system check before to the installation. All the systemchecks must be completed successfully to proceed with the installation. After the checks have beencompleted, click “Next”.Check “I accept the terms in the License Agreement” and click “Next”. Select the web application(s)where you want to install the product.Copyright 2022 All rights reserved. www.virtosoftware.com

6Then click “Next”.Copyright 2022 All rights reserved. www.virtosoftware.com

7Click “Close” to complete the installation.SPFx Web Part InstallationVirto Kanban Board web part for SharePoint 2019 can be used as SPFx web part. To start using VirtoKanban Board web part on modern sites/pages of SharePoint 2019 please do the steps as follows.1) Create Tenant App Catalog in your SharePoint if necessary: tration/manage-the-app-catalog.2) To install Virto Kanban Board web part run Setup.exe file under the farm administrator account (clickthe right mouse button on the .exe file and choose “Run as administrator”).The "kanban-webpart-spfx.sppkg" file will be automatically uploaded to your Tenant App Catalog into"Apps for SharePoint". However, please verify your app catalog for existence of "kanban-webpartspfx.sppkg" file.Now you can add Virto Kanban Board on the modern pages/sites.Warning! Please do not use service administrative account to install and activate SPFx web part on your sites.Error “Sorry apps are turned off”: What to DoIf you are trying to install the web part on SharePoint 2019 server and got below error while Addingit to your site:Copyright 2022 All rights reserved. www.virtosoftware.com

8Sorry, apps are turned off. If you know who runs the server, tell them to enable apps.Possible Reasons and SolutionsReasonSolutionApps are not enabled in your farmMake sure your have Apps enabled in your SharePoint2019 farm.The first and most probably problem would be thesubscription service is not configured in your farm.Please configure it.Make sure App Management Service Application isassociated with your web application where you want toadd the SPFx web part.If you have not configured the App Urls. please ensureyou have given values to App Domain and App Prefix inyour App Store settings.Subscription service is not setupApp management service is not associated with yourweb applicationApp Url is not configuredIf after ensuring above solutions, you still have the same error, please register a ticket to let ourtechnicians analyze the problem.License ActivationFull instruction for successful activation of your component is placed in our blog.Upgrading Virto Kanban BoardIf you already use Virto Kanban Board and need to upgrade it to the latest version, downloadthe.zip file from the VirtoSoftware official website.On step 3 select the checkbox “Upgrade” and click “Next”.Note: if you had activated the license while installing the previous Virto Kanban Board version, youCopyright 2022 All rights reserved. www.virtosoftware.com

9do not need to activate it now.Uninstalling Virto Kanban BoardTo uninstall the component:1.Double click theSetup.exeextractedfrom zip file.2.The program performs the system checks again. Once that has been successfully completed,the program prompts you to Repair or Remove the solution. Select “Remove” and click “Next”.Virto SharePoint Kanban Board AdjustmentAdd Web PartWhen Virto Kanban Board web part is installed, you can add it on a page of your site collection.1. Switch to the edit mode on the Web Part Page: click “Edit Page” in the “Page” tab.2. Click on a zone of a Web Part page where you wish to add the web part, and then choose “WebPart” on the “Insert” tab under “Parts” to open the Web Part Gallery.3. Select a Virto Kanban Board web part in Virto solutions block and drag it to the zone or click theAdd button.Copyright 2022 All rights reserved. www.virtosoftware.com

10In case you need to change the web part properties, choose “Edit Web Part” from the Edit drop-downlist.Make all the changes you need and click “Save” (scroll down to the end of the settings block).Copyright 2022 All rights reserved. www.virtosoftware.com

11Now you can start working with Virto Kanban Board web part.Quick Board and Board from an Existing ListVirto Kanban Board web part provides two options of how to create a new board. The web art takesdata from a SharePoint task list and visualizes them as a classic Kanban board. If you already have theSharePoint list with all the required data for your new board, you can configure the board for theexisting list. But if you do not have such a list, choose “Quick Board”. In this case the web part createsthe board and an appropriate SharePoint task list automatically.How to Create a Quick BoardTo create a new board quickly, choose “Quick Board”.Copyright 2022 All rights reserved. www.virtosoftware.com

12Then type a board name to customize it later. The list with the same name will be created.The new board will contain the default task with basic set of columns. You can adjust this board byclicking the “Edit board settings” icon next to the board name.Note: quick boards have swimlanes organized by a project by default. You can change this settinglater.Copyright 2022 All rights reserved. www.virtosoftware.com

13Board from an Existing ListChoose “Configure for the Existing List”.Then adjust your board according to your needs. To do this you need to configure the settings in the“List Setup”, “Board Setup”, “Cards Setup” and “Advanced Setup” blocks (optional). All of them aredescribed below in the user guide.Kanban Board Administration ToolsYou can set common settings for Virto Kanban on the board and farm level. Find the settings blockunder the gear icon on the left top corner.Copyright 2022 All rights reserved. www.virtosoftware.com

14And then scroll down to the “Virto Kanban Task Manager settings” under the “Site Administration”.The block of administration tools with three tabs appears.Copyright 2022 All rights reserved. www.virtosoftware.com

15First, you as an administrator can select the checkbox “Always follow parent settings”. Uncheck it ifyou want to tune the web part according to your needs.Copyright 2022 All rights reserved. www.virtosoftware.com

16The “Solution Settings” block includes the settings as follows: Disable Quick Board (select this check box if plan to create boards only from an existing list);Disable list event receivers (use this option to disable notifications when a task is moved tothe “Completed” column).Enter the URL of a required CSS-file and you’ll be able to use custom styles on your boards.In the Virto Kanban settings, you also can tune the task notification text. Just make the requiredchanges to the default message that will be sent to recipients. By default, users will get the alert withthe task link, mention by whom the task was assigned, and the board links inserted. The settings areapplied to the current site collection.The “Swimlanes” block allows you to tune the swimlanes on your board. For example, here you canallow drag tasks between swimlanes, allow to change task value by moving the item to defaultswimlane or hide empty swimlanes. You can also allow separated columns scroll if you need to viewthe items separately on your board. It is also possible to display the total count for swimlanes.Copyright 2022 All rights reserved. www.virtosoftware.com

17You can set a field that you’re going to use for sorting by default or allow manual sorting.The “Cards Setup” block contains such settings as hiding empty card/tooltip fields, URL format foruser avatars, or editing directly on a card, sending notification when a task is assigned and etc.Choose “Send notification, when a task has been assigned” to let assigned users receive alerts whenthey are assigned.If you choose “Open form by double click”, the edit form will appear by double click on a task. Hereyou can also allow using the SharePoint form if you prefer using the classic SharePoint view of a card.The “Advanced Setup” settings block includes default settings you may apply for new boards. Hereyou can define the first day of the week, allow creating new tasks, allow creating a task from acolumn, use the horizontal scroll, and enable drag & drop tasks.Copyright 2022 All rights reserved. www.virtosoftware.com

18Please do not forget that you (administrator) can select the checkbox “Override all boards to default”to forbid other users from changing the chosen settings on their permissions level.It is possible to define default values for new boards or override existing board settings. Any optionactivated in the column "Override all boards to default" makes the corresponding feature unavailable(grayed out) in the board settings.In the “Create board list” you can generate the list of all boards on the SP site. Click the board to openit.The correlation ID field is used for technical support (in the “Support” tab).Enable debug module (when you need additional admin information, select this checkbox, and the“Debug information” tab will appear. This might be quite useful for technical supportCopyright 2022 All rights reserved. www.virtosoftware.com

19Here the administrator also can enable or disable actions for the Kanban board (see the “Actions”section).Also, use the search to find the appropriate board in the list or filter the list.Lists and Columns CompatibilityYou can overlay lists with the same content type and any lists with coinciding fields. The list to displayon Kanban Board must have at least one Choice field and a User field.Lists can be merged in 2 cases:- They have an identical content type with the same fields.Copyright 2022 All rights reserved. www.virtosoftware.com

20- They share the same parent content type. In this case, only the coinciding fields will be merged (Afield type and field title must be identical in both lists to merge it and make it available to select as aKanban Column, a Kanban Swimlane, or a required field in Board Settings)The table below shows the list columns compatibility. These columns taken from 2 or moreSharePoint lists can be merged and used as:- Kanban Columns;- Kanban Swimlanes;- required fields for a board (such as Task Title field)For example, if List 1 is a Task list and has the “Assigned to” field renamed to the “Users” fieldand List 2 is a custom list with the “Created by” field renamed to the “Users” field, this field “Users”will be available on a board as a column or swimlane when both lists are merged.If List 1 has the “Assigned To” field and its copy “Copy of list 2” list has the renamed field “AssignedUsers”, these fields will be available to edit and displayed on the Kanban Board, but you can’t usethem as columns or swimlanes.Columns CompatibilityList SetupType a board name and open the lists picker to choose a SharePoint list(s) from the site collection,which contains the data you’re going to display as a Kanban board.Copyright 2022 All rights reserved. www.virtosoftware.com

21Select ListYou can overlay lists with the same content type and any lists with coinciding fields. The list to displayon Kanban Board must have at least one Choice field and a User field.Lists can be merged in 2 cases:- They have an identical content type with the same fields.- They share the same parent content type. In this case, only the coinciding fields will be merged (Afield type and field title must be identical in both lists to merge it and make it available to select as aKanban Column, a Kanban Swimlane, or a required field in Board Settings)The table below shows the list columns compatibility. These columns taken from 2 or moreSharePoint lists can be merged and used as:- Kanban Columns;- Kanban Swimlanes;- required fields for a board (such as Task Title field)For example, if List 1 is a Task list and has the “Assigned to” field renamed to the “Users” fieldand List 2 is a custom list with the “Created by” field renamed to the “Users” field, this field “Users”will be available on a board as a column or swimlane when both lists are merged.If List 1 has the “Assigned To” field and its copy “Copy of list 2” list has the renamed field “AssignedUsers”, these fields will be available to edit and displayed on the Kanban Board, but you can’t usethem as columns or swimlanes.Table. Columns CompatibilityCopyright 2022 All rights reserved. www.virtosoftware.com

22List picker allows you to select one or multiple lists to display on Kanban board. The list name containslink to the list, and you can also see the list collection which this list belongs to.Available Content TypesThe “Available Content Types” dropdown allows you to show the lists that contain the chosen contenttype.Copyright 2022 All rights reserved. www.virtosoftware.com

23Note: this option is usually used for multiple lists to show on the Kanban board. So, you need to choosethe content type first and then decide which lists with this content type you display on the board.Board TemplatesThe Kanban Board web part (including SharePoint 2013, 2016, and 2019) supports templates.Navigate to List Setup block of your board settings. The three options are available: Save the board as a template (save a KBOT file to your disc according to chosen fields);Save as template (save a KBOJ file to your disc with the current board settings);Load template (choose a file from your disc to load previously saved settings).Copyright 2022 All rights reserved. www.virtosoftware.com

24To save a template, find “Templates” in the List setup tab and click “Save the board as a template”.Check the fields you would like to export and pay attention to the fields that are not included(cannot be exported).Export rulesCopyright 2022 All rights reserved. www.virtosoftware.com

251. You can only create a template from a board if it is based on a single list.2. Not all fields can be added to the template. For example, external Lookup fields cannot beexported. You can see the exact list of fields that cannot be exported from the board in yourexport window.3. You can include up to 50 cards into the template. For this purpose, subtasks are counted asseparate cards.4. You can exclude the content and only import list fields and structure.You can make a preview before the export (click “Preview data”).Finally, save the created file to your disc and use it later.You also can create a new board from a template. When you create a new board, choose “Createfrom a template” on the Kanban Board web part page.Copyright 2022 All rights reserved. www.virtosoftware.com

26Now just choose the previously saved template file from your disc and start working.Board SetupColumnsColumns visualize the workflow across the board.Select the “Set of columns” list field, which will be used for generating columns for Virto SharePointKanban. This field must be a choice field. Usually, the columns mean the status of a task, but you canselect any other choice field.Note: please be careful when you change the set of columns and rename the column names. Forexample, if you change the task status set of columns to another one and rename the columns, yourtask cards might appear without a status. In this case, to cha

Virto Kanban Board Overview SharePoint Kanban Board Web Part is an agile tool to visualize and manage tasks in SharePoint 2019, 2016, 2013, and 2010. Virto Kanban web part allows you to show any SharePoint list and multiple lists as a Kanban Board, where you can drag & drop and sort tasks between columns and swimlanes of a project.