Autodesk Developer Blog : Replication

Here are some code snippets to help you out when dealing with replicated environments.

Finding out your local workgroup

One of the first things you will probably want to do is figure out which workgroup you are connected to. This one is pretty easy, just call GetLocalWorkgroup() in the ReplicationService.

If you want to get the list of all the workgroups connected to your local workgroup, you can call GetAllWorkgroups(). If replication is running, there should be only 1 publisher and the rest should be subscribers.

Finding out the entity's owner

The next thing you will probably want to do is figure out which workgroup owns the thing you want to work on. The best way is to use GetOwnershipByEntityId.

// C#
// get the ownership for a file, folder, item
// and change order
EntOwn [] ownerhips =
replSvc.GetOwnershipByEntityId( new long[]
{
file.MasterId, folder.Id, item.MasterId, co.Id
});

' VB.NET
' get the ownership for a file, folder, item
' and change order
Dim ownerhips As EntOwn() = replSvc.GetOwnershipByEntityId(New Long() {file.MasterId, folder.Id, item.MasterId, co.Id})

For files, items and change orders you can use the "Current Owner" property, but the result is designed more for human readability. It's not very good for program logic because there are a couple of string formats that are used depending on the workgroup settings.

Error 322
This is the error you get whenever you try to do something on an Entity that you don't own. You can minimize the chance of getting this error by checking the "Locked" property on the object. However it won't hit all cases and some Entities don't have a Locked property.

First you need to detect the error. You can do this the same way you look up any other error code. There's nothing special here.

Next you need to decide how to handle the error. This one is up to you and what make sense for your application. Common options include A) displaying the error to the user and B) automatically attempt to gain ownership.

Transferring Ownership
Here is how you transfer ownership of specific Entities. You can transfer things in groups, which mean that all Entities in the group transfer or none do at all. This feature is useful if you have a group of things that you need to work on.

If you are transferring multiple groups, it's possible for one group to fail while another succeeds. So you need to check the XferStatus to make sure the transfer succeeded.

// transfer a file and item together
LongArray group = new LongArray();
group.Items = new long[]
{ file.MasterId, item.MasterId };

XferStatus [] status =
replSvc.TransferEntityGroupOwnership(
destWorkgroup.Id, new LongArray[] { group }, 60);

if (status.Any(n => !n.IsSuccess))
    MessageBox.Show(
       "One or more ownership transfers failed");
else
    MessageBox.Show("Ownership transfers succeeded");

' transfer a file and item together
Dim group As New LongArray()
group.Items = New Long() {file.MasterId, item.MasterId}

Dim status As XferStatus() = replSvc.TransferEntityGroupOwnership(destWorkgroup.Id, New LongArray() {group}, 60)

If status.Any(Function(n) Not n.IsSuccess) Then
MessageBox.Show("One or more ownership transfers failed")
Else
MessageBox.Show("Ownership transfers succeeded")
End If

Using Newly Transferred Entities
So your code just transferred file ownership to your local workgroup. You can start working on it, right? Wrong!

You need to wait for SQL to replicate the Entity data before you can start using. The reason is because the Transfer function you called edited data on the remote workgroup, not your local workgroup. Every other API function that edits data does the edit on the local database, but the Transfer functions are special.

So how do know when you have ownership for real? The only way is to constantly check the ownership until it shows that your local workgroup owns it.

status = replSvc.TransferEntityGroupOwnership
(localWorkgroup.Id, new LongArray[] { group }, 0);

// TODO: check status

// check the ownership. Give up after 120 seconds.
for (int i = 0; i < 12; i++)
{
    ownerhips = replSvc.GetOwnershipByEntityId(
        new long[] { file.MasterId});

    if (!ownerhips[0].IsLocalOwn)
        System.Threading.Thread.Sleep(10000);
    else
        break;
}

if (!ownerhips[0].IsLocalOwn)
    MessageBox.Show("Timeout expired");
else
    MessageBox.Show("Transfer complete");

status = replSvc.TransferEntityGroupOwnership(localWorkgroup.Id, New LongArray() {group}, 0)

' TOOD: check status

' check the ownership. Give up after 120 seconds.
For i As Integer = 0 To 11
ownerhips = replSvc.GetOwnershipByEntityId(New Long() {file.MasterId})

      If Not ownerhips(0).IsLocalOwn Then
            System.Threading.Thread.Sleep(10000)
      Else
            Exit For
      End If
Next

If Not ownerhips(0).IsLocalOwn Then
MessageBox.Show("Timeout expired")
Else
MessageBox.Show("Transfer complete")
End If

Note: Make sure that your loop has an exit. If the network goes down between the two workgroups, your program would be halted indefinitely.

Replication – Common Workflows

Like this:

Comments

Leave a ReplyCancel reply

Replication – Common Workflows

Share this:

Like this:

Comments

Leave a ReplyCancel reply

Discover more from Autodesk Developer Blog