Thanks for your reply Jason but a Checked Out document can be cancelled by any administrator (or another user that has sufficient rights) and this option is available in the Windows and Web Client interfaces.

I'm looking for the right code syntax to perform the "Undo Check Out".

And can Laserfiche provide a comment about the "IsCheckedOut" property that doesn't seem to reflect the real state of the document?

Jason is right. A user can undo their own check-out. Even with more rights, you can't undo another user's check-out. You can release the persistent lock caused by their check-out (either through the client or by using the code above).

Why do you think the IsCheckedOut property does not reflect the real state of the document?

As Miruna said, you can cancel a check out through the client, but UndoCheckOut is not the same kind of function.

The code I provided is more similar to what is happening behind the scenes when you cancel a check out through the admin console.

As for checking whether or not something is checked out, the Find Entry activity allows you to get the "Checked Out By" and "Locked By" or ("Checked Out By SID" and "Locked By SID") properties of the document.

If either of those is not empty, then it is safe to assume the document is checked out, and if you want to get more specific you can use the SID versions to create an identity object and only retrieve a list of locks associated with that user.

For Example, the following uses the CheckedOutBySID and LockedBySID value(s) obtained from a Find Entry activity and unlocks the document if it is checked out or locked.

            // Create array containing each lock type
            string[] lockTypes = new string[] { "CheckedOut", "Locked" };

            foreach(string lockType in lockTypes){
                // Get identity token object
                var identityToken = GetTokenValue("FindEntry_OutputEntry_" + lockType + "BySID");

                // Check if entry is locked
                if(identityToken.ToString() != ""){
                    // Get Identity Reference
                    IdentityReference identity = identityToken as IdentityReference;

                    // Initialize lock list settings only for the target account
                    EntryLockListingSettings lockListSettings = new EntryLockListingSettings();
                    lockListSettings.IdentityReference = identity;
                    lockListSettings.PersistentLocksOnly = false;
                    lockListSettings.SortColumn = PersistentLockColumn.CreationTime;
                    lockListSettings.SortDirection = SortDirection.Ascending;

                    // Get the lock listings
                    EntryLockListing lockListing = EntryLockListing.GetListing(0,lockListSettings,RASession);

                    // Iterate through the list to find the target entries
                    foreach(EntryLockListingRow row in lockListing){
                        // If current entry matches target entry
                        if(row.EntryId == this.BoundEntryId){
                            // Unlock the entry
                            Entry.Unlock(row.EntryId,row.LockToken,RASession);
                        }
                    }
                }
            }

Jason,

I know this is an old post, but it's exactly what I need in my current situation, and I'm hoping you can assist me in implementing it.  I used the code in your last reply, and set up the Find Entries and conditional sequence just as you did, but I'm getting the following error:

 Error    1    The type or namespace name 'IdentityReference' could not be found (are you missing a using directive or an assembly reference?)

I'm not great at coding, so I'm just assuming that I'm missing something from another part of your code where it references the ID of the current entry?  I don't see anywhere in this snippet where it does that, so I assume that's what I'm missing.  Could you help me figure out if that's the case?

Here's my code:

// Create array containing each lock type
string[] lockTypes = new string[] { "CheckedOut", "Locked" };

foreach(string lockType in lockTypes){
    // Get identity token object
    var identityToken = GetTokenValue("ForEachDocuments_CurrentEntry_" + lockType + "BySID");

    // Check if entry is locked
    if(identityToken.ToString() != ""){
        // Get Identity Reference
        IdentityReference identity = identityToken as IdentityReference;

        // Initialize lock list settings only for the target account
        EntryLockListingSettings lockListSettings = new EntryLockListingSettings();
        lockListSettings.IdentityReference = identity;
        lockListSettings.PersistentLocksOnly = false;
        lockListSettings.SortColumn = PersistentLockColumn.CreationTime;
        lockListSettings.SortDirection = SortDirection.Ascending;

        // Get the lock listings
        EntryLockListing lockListing = EntryLockListing.GetListing(0,lockListSettings,RASession);

        // Iterate through the list to find the target entries
        foreach(EntryLockListingRow row in lockListing){
            // If current entry matches target entry
            if(row.EntryId == this.BoundEntryId){
                // Unlock the entry
                Entry.Unlock(row.EntryId,row.LockToken,RASession);
            }
        }
    }
}
        }
    }
}

Thanks in advance!

Since you're actually creating an IdentityReference object to use instead of using a null value like I did in my example, then you need to include a reference to the assembly.

IdentityReference comes from System.Security.Principal

You can add the using statement to include the reference; this goes up at the top with the other using statements.

using System.Security.Principal;

Or you could use the full name reference like

System.Security.Principal.IdentityReference identity = ....

Awesome!  That sorted out the build issue.  My only other question is, how does the script know which document to remove the lock/checkout from?  The only token that seems to be passed to it is the checkedoutby or lockedby.  Does it just by default use the current entry's ID without it being specified?

The code for this.BoundEntryId is referencing the entry id of the script's default entry, which is set outside of the script editor in the activity settings.

Basically, the "Bound Entry" is the "Default Entry" you set for the activity; it can be the starting entry, or an entry from another activity in the workflow.

Whenever you use a script activity and set a default entry, BountEntryId is the default entry id, and BoundEntryInfo is the EntryInfo object.

For example, if you know for sure that the default entry is a document, instead of having to retrieve the DocumentInfo object again, you can just cast the BoundEntryInfo object to a DocumentInfo type like so:

DocumentInfo docInfo = (DocumentInfo)this.BoundEntryInfo;

After I posted, I looked at it again and saw that line and thought that might be the case.  Thanks again for the assistance on this!  Very helpful.

I apologize again for another tag onto this old post, but it seems as though it is what I am after. We occasionally have errant locks, rather locks that give a warning to the user that it is locked, but nothing showing in the admin console. However, the document properties show a user account in "checked out by." We log in as that user check out and either undo or re check in the document to clear the lock error. 

I am hoping to implement a business process that gives a couple admins the ability to remove these error locks without having to give them other users' credentials. However, it does seem that if the script is executed while the user has the document open, they then save and close that document it now marks it as checked out:

running the script again will not clear this value. Additionally, if a user has this checked out, and we run the script, it clears the appearance of a lock, but the item still shows that user as having checked out the document. Ultimately I just need something that completely clears the lock and any values that may hang up a document. Any ideas?

@████████ Just confirm, when you say there are no locks in the admin console, are you clearing both Entry Locks and Checked Out Documents? I've never seen the exact scenario you're describing, so I'm not too sure.

Although related, locks and checkouts are separate things; locks can apply to all entries but check outs are for documents with version control. I have not used a script like this to force unlock version-controlled documents before.

In the SDK there are check in/out related methods for DocumentInfo objects, but EntryInfo objects only have the lock/unlock methods; however, those methods are for the current user context not undoing other user checkouts.

The user saving would still be a problem since they'll already have the document open, so you might also have to disconnect their Session.