topic Re: Connection to Vault in the Event Handling Extension in Vault Customization Forum

Connection to Vault in the Event Handling Extension

pzuziak — Tue, 16 Jul 2019 13:21:14 GMT

Good day,

I am working on an extension that modifies property values on state change. The code below is working but I am not sure if am doing this the best way. What is the significance of the UserID argument in the Connection constructor? It does not seem to matter - I tried a couple of different values.

        private void UpdateFileLifecycleStateEvents_Pre(object sender, UpdateFileLifeCycleStateCommandEventArgs e)
        {         
            Connection connection = new Connection(sender.WebServiceManager, "vault", 1, "server", AuthenticationFlags.WindowsAuthentication);         

...

Another instance of UserID that does not seem to matter is:

IExplorerUtil explorerUtil = ExplorerLoader.LoadExplorerUtil(connection.Server, connection.Vault, 1, authTicket);

Kind regards

Przemek

Re: Connection to Vault in the Event Handling Extension

Anonymous — Wed, 17 Jul 2019 07:48:44 GMT

Hi,

No - it's not best way 🙂

Take a look at my example:

private void UpdateItemLifecycleStateEvents_GetRestrictions(object sender, UpdateItemLifeCycleStateCommandEventArgs e)
        {
            Logger.Trace("Start");

            if (!(sender is IWebService webService)) return;
            if (e.ItemMasterIds == null || e.ItemMasterIds.Length == 0) return;
            if (e.ToStateIds == null || e.ToStateIds.Length == 0) return;

            Logger.Debug("ItemMasterIds: {itemMasterIds}", e.ItemMasterIds);
            Logger.Debug("ToStateIds: {toStateIds}", e.ToStateIds);

            try
            {
                var items = webService.WebServiceManager.ItemService.GetLatestItemsByItemMasterIds(e.ItemMasterIds);
                var states = webService.WebServiceManager.LifeCycleService.GetLifeCycleStatesByIds(e.ToStateIds);

And so on...

The most important part is to cast sender to IWebService, then use it 🙂

Let me know if that helps.

Rafal K.

Re: Connection to Vault in the Event Handling Extension

sajith_subramanian — Wed, 17 Jul 2019 08:09:35 GMT

Hi @pzuziak ,

You shouldn't have the need to construct the connection object. Once you have the WebServiceManager, you can make use of that to access the DocumentService etc.

Also, an important note for the above approach:

"Some operations may not work correctly when it’s executed from event handler (i.e. modifying of mapped properties when file is already open in Inventor). For such cases the safer approach may be to schedule a job and perform operation later."

Regards,

Sajith

Re: Connection to Vault in the Event Handling Extension

pzuziak — Wed, 17 Jul 2019 08:36:53 GMT

@sajith_subramanian

Thank you for the reply.

The job processor approach might be more suitable and I think I will pursue that route.

Just to satisfy my curiosity.......

I was using connection to get the PropertyManager and the property definition:

PropertyDefinition property1 = connection.PropertyManager.GetPropertyDefinitionBySystemName(prop.SysName);

as well as to get IExplorerUtil object:

IExplorerUtil explorerUtil = ExplorerLoader.LoadExplorerUtil(connection.Server, connection.Vault, 1, authTicket);

I couldn't find another way apart from creating connection........

Even if there was another way could you explain the significance of the UserId argument in LoadExplorerUtil plaese?

Kind regards

Przemek

Re: Connection to Vault in the Event Handling Extension

Anonymous — Wed, 17 Jul 2019 08:44:12 GMT

Przemek,

You do not have to access PropertyManager.

Property service is all You need:

var itemPropDefs = webService.WebServiceManager.PropertyService.GetPropertyDefinitionsByEntityClassId(EntityClassIds.Items);
var itemPropInsts = webService.WebServiceManager.PropertyService.GetPropertiesByEntityIds(EntityClassIds.Items, itemIds);

How to get webService - You have it in my first answer.

UserId is indication for WebServices to determine who is calling function. It then is used to determine authorization for further actions. If You are using value 1 (hard coded), it is first user in Vault - in most cases it's Administrator.

Re: Connection to Vault in the Event Handling Extension

pzuziak — Wed, 17 Jul 2019 09:40:06 GMT

@Anonymous

Just one more question 🙂 how to get the property value?

I was doing it this way:

currentPropertyVaule = connection.PropertyManager.GetPropertyValue(fileIter, property1, null).ToString();

Kind regards

Przemek

Re: Connection to Vault in the Event Handling Extension

Anonymous — Wed, 17 Jul 2019 10:00:10 GMT

No problem Przemek.

Example for Items. You can change to Files by changing that line:

var itemPropDefs = webService.WebServiceManager.PropertyService.GetPropertyDefinitionsByEntityClassId(EntityClassIds.Items);

private void UpdateItemLifecycleStateEvents_GetRestrictions(object sender, UpdateItemLifeCycleStateCommandEventArgs e)
{
	Logger.Trace("Start");

	if (!(sender is IWebService webService)) return;
	if (e.ItemMasterIds == null || e.ItemMasterIds.Length == 0) return;
	if (e.ToStateIds == null || e.ToStateIds.Length == 0) return;

	Logger.Debug("ItemMasterIds: {itemMasterIds}", e.ItemMasterIds);
	Logger.Debug("ToStateIds: {toStateIds}", e.ToStateIds);

	try
	{
		var items = webService.WebServiceManager.ItemService.GetLatestItemsByItemMasterIds(e.ItemMasterIds);
		var itemPropDefs = webService.WebServiceManager.PropertyService.GetPropertyDefinitionsByEntityClassId(EntityClassIds.Items);
		var itemPropInsts = webService.WebServiceManager.PropertyService.GetPropertiesByEntityIds(EntityClassIds.Items, items.Select(i => i.Id).ToArray());

		foreach (var item in items)
		{
			var itemPropInstsForEntity = itemPropInsts.Where(i => i.EntityId == item.Id).ToArray();
			var propValue = GetPropertyValue(itemPropDefs, itemPropInstsForEntity, false, "Materiał")
		}
	}
	catch (Exception ex)
	{
		e.AddRestriction(
			new ExtensionRestriction(
				"Wyjątek",
				ex.Message));

		Logger.Error(ex);
	}
	Logger.Trace("Finish");
}

private static object GetPropertyValue(PropDef[] propDefs, IEnumerable<PropInst> propInsts, bool isSystem, string propName)
{
	return propInsts.SingleOrDefault(i => 
		i.PropDefId == propDefs.SingleOrDefault(j => 
			isSystem && j.SysName == propName || !isSystem && j.DispName == propName)?.Id)?.Val;
}

Feel free to contact me if You have further questions.

Rafal K.

Re: Connection to Vault in the Event Handling Extension

pzuziak — Wed, 17 Jul 2019 10:01:50 GMT

Thanks a lot @Anonymous !!!

Kind regards

Przemek