The K2 Pirate

SPComments (hidden)

SharePoint_Item

SPIntegrationData (hidden)

WFIProcessField

List Item MetaData

SPEventsField

EventDetails

Fields Added by the Item Reference Wizard

I was looking for a way to embed a Word document in to my SharePoint page.  It seems the with Windows Live, this is allowed – but what if the documents are stored locally on a SharePoint 2010 Serve with Office Web Apps enabled? No. The URL doesn't allow for embedding, it detects the iframe and gives an error.

Looking around I found this post, it describes how to use the source of the WordViewer.aspx to grab the iframe for the actual document, this will then allow you to embed the document, but there is a problem.  The source for the iframe is a URL that looks something like this:

http://portal.denallix.com/Sites/DocumentApprovalCase/WordViewerFrame.aspx?d=F01fa671c0367476c94cf7159cdd4363eme27788ac7945483ab227dcbf558bce4fme45d2577bbde4734aa37e73babe4af3bm&source=http%3a%2f%2fportal.denallix.com%2fSites%2fDocumentApprovalCase%2fDocuments%2fProjektverfahrensanweisungen.docx

Now in my case I had a dynamic SharePoint site that needed to be provided a parameter for which document to display. At first glance it seems simple to URL encode the source parameter and easily embed any document.  This is not the case.  What's actually going on is that the 'd' parameter is an encoded reference tot he document location and it's this that must be set correctly.

I embarked on a little session of Reflection (big R for Red Gate, not little r, where I might contemplate my life as a rock star).

I discovered that the requried 'd' parameter is simple a concat of four GUIDs of the site, web, library, and file IDs, prefixed with an F (O for a folder).

Internally MS's code refers to this encoding as a "String Representation".  Here's some example code for the SharePoint Object Model to generate it from a URL, via an SPWeb.  You should probably choose a better way to implement this but here are the fundamentals:

    public class OfficeWebAppUtil
    {
        public static string GetWordViewerURL(string url)
        {

            url = HttpUtility.UrlPathEncode(url);

            using (SPSite site = new SPSite(url))
            {
                using (SPWeb web = site.OpenWeb())
                {
                    SPFile file = web.GetFile(url);
                    string rep = StringRepFromItem(file);
                    return web.Site.Url + "/_layouts/WordViewerFrame.aspx?d=" + rep;
                }
            }
        }

        protected static string StringRepFromItem(SPFile item)
        {
            StringBuilder builder = new StringBuilder();
            builder.Append("F");
            builder.Append(item.Web.Site.ID.ToString("N"));
            builder.Append('m');
            builder.Append(item.Web.ID.ToString("N"));
            builder.Append('m');
            builder.Append(item.UniqueId.ToString("N"));
            builder.Append('m');
            return builder.ToString();
        }
    }

As for the soruce parameter – you might want to append that also as this is where you will be redirected to if you close the document or click the popout icon.

I'm sure the same technique will work for other document types.  If I get some time I'll wrap this in to a web part that can handle different document types… maybe

Cheers,

Hoshy, the K2 Pirate

Use the web interface: http://hoshy.co.uk/cgi-bin/mailman/listinfo/k2tech

Hello!

I want to tell you about an underused tool in the K2 Blackmarket community arsenal: The Process Instance Version Migrator.

This tool allows you to make inflight migrations of process instances between process versions.

It uses an API called LIM - Live Instance Management.  This API /is/ a K2 Supported API however the tool itself is community supported.

Credits for this tool go to Neil Maartens – A K2 Consultant now working in the US.  K2 Underground username: NeilM

So – on with the tool.  Download it from here: http://www.k2underground.com/groups/process_version_migration_utility/default.aspx

Extract the tool – full source code is included however you'll want to navigate to the folder: ProcessInstanceVersionMigrator\ProcessInstanceVersionMigrator\bin\Debug

Here you'll find a .exe which is to run the program and a .config thatcontains the server connection strings.

FIRST MODIFY THE .config

You'll need to modify the following:

<add key="K2SqlConnString" value="Data Source=localhost;Initial Catalog=k2server;Integrated Security=True;MultipleActiveResultSets=True"/>
<add key="K2ServerName" value="localhost"/>
<add key="K2ServerPort" value="5555"/>

By default the tool will work best if you're running on the (a) K2 Server as the K2 Server Service account.

Next run the tool .exe

Use of the tool should be quite straight forward.  When it runs you are presented with a window that describes 7 steps – each with a button associated.

Step 1 – Check the config file!

Step 2 – Click "Get list of processes" – this populates a drop down list with the process types on the specified server, select the process type you with you migrate.

Step 3 – Click on "Get Active Instances" – this will fill the table with a list of running instances of the selected process type, including the status and version of the instances.

Step 4 – Select each instance you wish to migrate – processes in error state can be migrated also.

Step 5 – Click on "Get process versions" – this will load a list of versions for the selected process type – then select which verson you wish to migrate the above instances to.

Step 6 – Click on "Get process version activites" – this loads a list of activites in the selected version that you can then select.  The tool will then perform a goto to the selected activity after migration. You can also choose not to redirect at all, or redirect to the current activity if you want to rexecute the current step (useful if the instance is in error and you want to restarted from the failed point).

Step 7 – Perform the migration!  This is the final step and the act can not be un-done.  By now you should have thoroughly tested the migration scenario in you test environments.

The table will show Migrating, followed by Migrated for each selected process instance.

Good luck!

P.S: Some other things to know.

• There are only certain things you can chance and expect migration to work
  • See product documentation: Designers > K2 Designer for Visual Studio > Live Instance Management > LIM – Sourcecode.Workflow.Management > Important Notes
• I have tested this tool myself on version from late 0807 (release of API) to 4.5 1320 (Latest at time or writing)
• You can migrated backwards or forwards
• <todo… suggestions welcome>

Cheers,

The K2 Pirate

Join the new K2Tech mailing list by clicking here to send a mail to the list subscription address Click here

Also visit the K2Tech archieves: Here

Hello!

Welcome to my blog.

Over the coming months I'll be using this spot to communicate idea, best practices, code and insights in to all things K2 related.