{"id":1340,"date":"2013-09-30T20:06:45","date_gmt":"2013-09-30T20:06:45","guid":{"rendered":"http:\/\/turtlellc.com\/?p=1340"},"modified":"2017-09-22T19:59:23","modified_gmt":"2017-09-22T19:59:23","slug":"sharepoint-workflow-versioning-with-visual-studio-2012","status":"publish","type":"post","link":"http:\/\/www.turtle.works\/knowledge\/sharepoint-workflow-versioning-with-visual-studio-2012\/","title":{"rendered":"SharePoint Workflow Versioning with Visual Studio 2012"},"content":{"rendered":"

I needed a methodology for publishing new versions of SharePoint workflows using Visual Studio. I have a Document Library that has a workflow (we’ll call it version 1). The document,\u00a09-30 Staff Meeting.pdf,<\/em> is running workflow version 1; waiting on a user to complete a task. However, I’ve changed the code and want new documents to run the workflow with the changes (we’ll call this workflow version 2). Here is the key, while the new document, 10-7 Staff Meeting.pdf<\/em>, \u00a0will run workflow version 2, I need the the already in progress,\u00a09-30 Staff Meeting.pdf<\/em>document,\u00a0<\/em>to complete\u00a0using the existing version 1 assembly.<\/p>\n

In a Nutshell<\/h1>\n
    \n
  1. Deploy Version 1<\/span>\n
      \n
    1. Add Assembly name suffix of “_v1”<\/li>\n
    2. Change Assembly version and File version<\/li>\n
    3. Add a suffix to the workflow Elements.xml file Name element (“v1.0.0.0”)<\/li>\n
    4. Rebuild Solution<\/li>\n
    5. Publish the Workflow<\/li>\n
    6. Add the Solution\n
        \n
      1. Add-SPSolution -LiteralPath C:\\Downloads\\Blog\\C#\\SequentialWorkflow\\bin\\Debug\\SequentialWorkflow.wsp<\/em><\/li>\n<\/ol>\n<\/li>\n
      2. Deploy the Solution using Central Administration > System Settings > Manage Farm Solutions<\/span><\/li>\n
      3. Activate the Feature<\/li>\n
      4. Add the workflow to Shared Documents<\/li>\n<\/ol>\n<\/li>\n
      5. Make a Version 2 Workflow\n
          \n
        1. Copy the version 1 dll to a v1.0.0.0 folder<\/li>\n
        2. Change \u00a0Assembly name suffix to _v2<\/li>\n
        3. Change Assembly version and File version<\/li>\n
        4. Change workflow Elements.xml file > Name element suffix changed to v2.0.0.0<\/li>\n
        5. Include version 1 dll in the Package.package\n
            \n
          1. Source Path: bin\\v1.0.0.0\\SequentialWorkflow_v1.dll<\/li>\n
          2. Location: v1.0.0.0\\SequentialWorkflow_v1.dll<\/li>\n<\/ol>\n<\/li>\n
          3. Make workflow changes as needed (code and activities)<\/li>\n
          4. Rebuild the Solution<\/li>\n
          5. Publish the workflow project, replacing the existing .wsp file<\/li>\n
          6. Update the Solution\n
              \n
            1. Update-SPSolution -Identity SequentialWorkflow.wsp -LiteralPath C:\\<my path>\\bin\\Debug\\SequentialWorkflow.wsp -GACDeployment<\/li>\n<\/ol>\n<\/li>\n
            2. Add the workflow to Shared Documents<\/li>\n
            3. Allow No New Instances<\/em> of the version 1 workflow<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

              <\/h1>\n

              Versioning In Detail<\/h1>\n

              Deploy Version 1<\/h2>\n

              To achieve this follow the below method:<\/p>\n

                \n
              1. Set the workflow assembly\u00a0version to 1.0.0.0<\/span>\n
                  \n
                1. Display the properties of the workflow project in Visual Studio<\/span><\/li>\n
                2. Add a version suffix to the Assembly name<\/span><\/li>\n
                3. Ensure the Assembly version and File version are set to 1.0.0.0
                  \n\"Assembly<\/a>
                  \n<\/span><\/li>\n
                4. Add a suffix to the workflow Name in the workflow Elements.xml file\"Elementsv1\"<\/a><\/li>\n
                5. Rebuild the Solution<\/li>\n
                6. Publish the workflow by right clicking the workflow project in Solution Explorer and clicking Publish…<\/li>\n
                7. In this case, I’m publishing to the Debug folder
                  \n                  \"Publish1\"<\/a><\/span><\/li>\n
                8. Add the Solution to SharePoint: In the SharePoint 2010 Management Shell type Add-SPSolution -LiteralPath C:\\Downloads\\Blog\\C#\\SequentialWorkflow\\bin\\Debug\\SequentialWorkflow.wsp<\/em><\/span><\/li>\n
                9. Deploy the Solution:\u00a0<\/span>\n
                    \n
                  1. Open Central Administration > System Settings > Manage Farm Solutions<\/span><\/li>\n
                  2. Click on sequentialworkflow.wsp<\/li>\n
                  3. Click Deploy Solution<\/li>\n
                  4. Click OK, noticing that it will deploy, Now, and it is using the GAC
                    \n                    \"Deploy1\"<\/a><\/li>\n<\/ol>\n<\/li>\n
                  5. Activate the Feature\n
                      \n
                    1. Site Settings > Go to top level site settings (if necessary)<\/li>\n
                    2. Site Collection Features<\/li>\n
                    3. Click the Activate button if necessary for SequentialWorkflow Feature1<\/li>\n<\/ol>\n<\/li>\n
                    4. Add the workflow to Shared Documents\n
                        \n
                      1. Shared Documents > Library > Workflow Settings<\/li>\n
                      2. Click Add a workflow\n
                          \n
                        1. Select\u00a0SequentialWorkflow – Workflow v1.0.0.0<\/em><\/li>\n
                        2. Give it a unique name: SequentialWorkflow v1<\/li>\n
                        3. Click OK<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

                          Test Version 1<\/h2>\n

                          To test the version 1 workflow:<\/p>\n

                            \n
                          1. Add a couple document to Shared Documents<\/span><\/li>\n
                          2. Run the SequentialWorkflow v1<\/em> workflow against that document<\/li>\n
                          3. View the Workflow Information to see the pending task<\/li>\n
                          4. Edit the task, setting Status to Completed and % Complete to 100<\/li>\n
                          5. Save the task<\/li>\n
                          6. Notice the Workflow History shows a Description of Workflow Version 1 completed<\/li>\n<\/ol>\n

                            Run the SequentialWorkflow v1 workflow against a document again, but do not complete the task. We need this running, so we can test version 2 of the workflow further below in this post.<\/p>\n

                            Make a Version 2 Workflow<\/h2>\n
                              \n
                            1. Save the version 1 dll<\/span>\n
                                \n
                              1. In the <project>\\bin folder create a new folder called v1.0.0.0<\/li>\n
                              2. Copy the SequentialWorkflow_v1.dll to the folder
                                \n\"dll1\"<\/a><\/li>\n<\/ol>\n<\/li>\n
                              3. Using steps 1 thru 4 in the Deploy Version 1 section above, set the version of the workflow assembly to 2.0.0.0<\/li>\n
                              4. Include the version 1 dll in the new solution\n
                                  \n
                                1. Solution Explorer > Package<\/li>\n
                                2. Double click Package.package<\/li>\n
                                3. Click the Advanced tab<\/li>\n
                                4. Add > Add exiting assembly<\/li>\n
                                5. Browse to the v1.0.0.0 folder where you saved the SequentialWorkflow_v1.dll file, select it and click Open<\/li>\n
                                6. Add a v1.0.0.0\\ prefix to the Location
                                  \n                                  \"AddAssembly1\"<\/a><\/li>\n
                                7. Click OK<\/li>\n<\/ol>\n<\/li>\n
                                8. Modify the workflow code as needed for version 2. In this example I change my logging statement to say “Workflow Version 2 completed”<\/li>\n
                                9. Rebuild the Solution<\/li>\n
                                10. Publish the SequentialWorkflow project replacing the existing .wsp file<\/li>\n
                                11. Using the SharePoint 2010 Management Shell update the Solution: Update-SPSolution -Identity SequentialWorkflow.wsp -LiteralPath C:\\<my path>\\bin\\Debug\\SequentialWorkflow.wsp -GACDeployment<\/li>\n
                                12. Add the workflow to Shared Documents. See step 11 in Deploy Version 1<\/li>\n
                                13. Allow No New Instances<\/em> of the version 1 workflow\n
                                    \n
                                  1. Document Library Settings > Workflow Settings<\/li>\n
                                  2. Click Remove a workflow<\/li>\n
                                  3. Set SequentialWorkflow v1 to No New Instances
                                    \n                                    \"NoNewInstances\"<\/a><\/li>\n
                                  4. Click OK<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

                                    Test Version 2<\/h2>\n

                                    To test the version 1 workflow:<\/p>\n

                                      \n
                                    1. Make sure you have a SequentialWorkflow v1<\/em> workflow In Progress<\/em><\/li>\n
                                    2. Run the\u00a0SequentialWorkflow v2<\/em>\u00a0workflow against a different document<\/li>\n
                                    3. View the Workflow Information to see the pending task<\/li>\n
                                    4. Edit the task, setting Status to Completed and % Complete to 100<\/li>\n
                                    5. Save the task<\/li>\n
                                    6. Notice the Workflow History shows a Description of Workflow Version 2 completed<\/em><\/li>\n
                                    7. Complete the task for In Progress SequentialWorkflow v1<\/em> workflow<\/li>\n
                                    8. Notice the Workflow History shows a Description Workflow Version 1 completed<\/em><\/li>\n<\/ol>\n

                                      Thanks to Raghavendra B Nanjaiah at Microsoft for help with this.<\/p>\n","protected":false},"excerpt":{"rendered":"

                                      I needed a methodology for publishing new versions of SharePoint workflows using Visual Studio. I have a Document Library that has a workflow (we’ll call it version 1). The document,\u00a09-30 Staff Meeting.pdf, is running workflow version 1; waiting on a user to complete a task. However, I’ve changed the code and want new documents to … <\/p>\n

                                      Continue reading “SharePoint Workflow Versioning with Visual Studio 2012”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20],"tags":[],"class_list":["post-1340","post","type-post","status-publish","format-standard","hentry","category-sharepoint"],"_links":{"self":[{"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/posts\/1340","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/comments?post=1340"}],"version-history":[{"count":1,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/posts\/1340\/revisions"}],"predecessor-version":[{"id":1709,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/posts\/1340\/revisions\/1709"}],"wp:attachment":[{"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/media?parent=1340"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/categories?post=1340"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.turtle.works\/knowledge\/wp-json\/wp\/v2\/tags?post=1340"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}