Programming Autodesk Vault with the VDF. Dennis Mulonas and Doug Redmond Software Engineers, Autodesk

Transcription

1 Programming Autodesk Vault with the VDF Dennis Mulonas and Doug Redmond Software Engineers, Autodesk

2 Introduction This class will go over new API features in Autodesk Vault Most of the content will focus on the VDF (Vault Development Framework).

3 Introduction How many of you are programmers? How many of you have programmed with Autodesk Vault 2013 or earlier?

4 Agenda Introduction What s new in Autodesk Vault 2014 VDF Goals Demonstration Architecture Authentication / Connection Object Currency Download / Checkout Browse Vault Dialog Grid Control Other Features & Advanced Tips and Tricks Wrap-up

5 About the speakers Dennis Mulonas is a software architect for Autodesk Vault. He has been working at Autodesk for 21 years. Doug Redmond is a developer on Autodesk Vault and Autodesk PLM 360. He runs the blog It s All Just Ones and Zeros.

6

7 Server Types There are now two flavors of Autodesk Vault server. ADMS (Autodesk Data Management Server) Contains the database. Manages the metadata. AVFS (Autodesk Vault Filestore Server) Contains the files.

8 Server Types Why is there a need for two server types?

9 Server Types ADMS and AVFS can be on the save server. File operations require calls to both servers. Legacy APIs follow the old architecture. WebServiceManager and Connection route calls to the correct server.

10 Job Processor 2014 Connectivity.JobProcessor.Delegate.Host.exe JobProcessor.exe spawns delegate processes. All Jobs run in the delegate. Only one delegate running at a time. Delegates are recycled periodically.

11 Other 2014 Updates Updated.vcet.config format. No longer need to update JobProcessor.exe.config. Appstore support. Autodesk Vault Collaboration removed.

12

13 VDF Goals Easier to Develop Lower the Cost to Develop Provide consistent user experience

14

15 Demonstration Let s see how long it takes to write an application that Prompts the user to log-in to a Vault (VDF Workflow) 2. Let s the user navigate the Vault (VDF Workflow) 3. Let s the user open a file they select

16

17 VDF Overview

18 VDF Libraries Autodesk.DataManagement.Client.Framework Core utilities, no user interface, non-vault related Ex: Autodesk.DataManagement.Client.Framework.Library.Properties; Autodesk.DataManagement.Client.Framework.Forms Core user interface components, non-vault related Ex: Autodesk.DataManagement.Client.Framework.Library.Forms.GetAnswer( ); Autodesk.DataManagement.Client.Framework.Vault Vault utilities, services etc., no user interface Ex: Autodesk.DataManagement.Client.Framework.Library.Forms.Vault.ConnectionManager; Autodesk.DataManagement.Client.Framework.Vault.Forms Vault user interface components Ex: Autodesk.DataManagement.Client.Framework.Library.Forms.Vault.Forms.LogOut( );

19 VDF Library Structure Library Class Static class providing access to workflows, app settings, core services, utilities etc. Examples Autodesk.DataManagement.Client.Framework.Forms.Library.ShowError( ); Autodesk.DataManagement.Client.Framework.Vault.Library.ConnectionManager.LogIn( ); Namespaces Controls Currency Models Interfaces Results Services Settings

20 VDF Coding Patterns UI Workflows & Non-Vault Services Create Settings object (Only if needed with Library method) Call static Library class method Result object returned Vault Services (no ui) Authenticate to get a Vault Connection object Login using the static Library class All Vault business logic is done using this object Call Connection object service methods Result object returned

21

22 Logging In using VDF = Autodesk.DataManagement.Client.Framework; using VDFCC = Autodesk.DataManagement.Client.Framework.Currency.Connections; // LOGIN - no user interface // call Library service method VDF.Vault.Results.LogInResult result = VDF.Vault.Library.ConnectionManager.LogIn( "localhost", "Vault", "Administrator", "", VDF.Vault.Currency.Connections.AuthenticationFlags.Standard, null); if (result.success == false) return; Connection connection1 = result.connection; // get connection from result object // LOGIN - with user interface // create settings object VDF.Vault.Forms.Settings.LoginSettings settings = null; // none configured // static library workflow method Connection connection2 = VDF.Vault.Forms.Library.Login(settings); if (connection2 == null) return;

23 Logging In Non-UI Login o Login Types (configurable) o Server Validation Existence Product compatibility (configurable) API compatibility o Vault Validation UI Login (built on top of non-ui login) o Same UI used by Autodesk clients o Remembers credentials (configurable) o Auto-login (configurable)

24 Connection Services Useful Services on Connection WebServiceManager FileManager FolderManager WorkingFolderManager PropertyManager

25

26 VDF Entity Currency vs. Web Service Objects

27 VDF Entity Currency Encapsulates corresponding Web Service object Implements VDF.Vault.Currency.Entities.IEntity Supports Equality Rich Category Property (CutomObject, FileIteration, Folder, ItemRevision) Color c = rootfolder.category.color; Rich Revision Property on FileIteration

28 VDF Entity Currency Web Service Objects VDF Entity Currencies can be implicitly converted to Web Service objects: using VDF = Autodesk.DataManagement.Client.Framework; using WSV = Autodesk.Connectivity.WebServices; VDF.Vault.Currency.Entities.FileIteration vdffile; WSV.File wsfile = vdffile; // implicit conversion

29 VDF Entity Currency Web Service Objects Function call needed to convert from Web Service object to VDF currency: using VDF = Autodesk.DataManagement.Client.Framework; using WSV = Autodesk.Connectivity.WebServices; IDictionary<long, VDF.Vault.Currency.Entities.FileIteration> dict = conn.filemanager.getfilesbyiterationids(ienumerable<long> fileids); Or new VDF.Vault.Currency.Entities.FileIteration( VDF.Vault.Currency.Connections.Connection conn, WSV.File webservicefile)

30

31 Acquiring Files No UI using VDFV = Autodesk.DataManagement.Client.Framework.Vault; // create settings object VDFV.Settings.AcquireFilesSettings settings = new VDFV.Settings.AcquireFilesSettings(connection); // configure settings object settings.addfiletoacquire(fileiteration, VDFV.Settings.AcquireFilesSettings.AcquisitionOption.Download); // call connection service method passing in the settings object VDFV.Results.AcquireFilesResults results = connection.filemanager.acquirefiles(settings);

32 Acquiring Files Progress Bar using VDF = Autodesk.DataManagement.Client.Framework; using VDFVF = Autodesk.DataManagement.Client.Framework.Vault.Forms; // create settings object VDFVF.Settings.ProgressAcquireFilesSettings settings = new VDFVF.Settings.ProgressAcquireFilesSettings( connection, parentwindowhandle, "Download files"); // configure settings object settings.addfiletoacquire(fileiter, VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download); // call Library method passing in the settings object VDF.Vault.Results.AcquireFilesResults results = VDFVF.Library.AcquireFiles(settings);

33 Acquiring Files Interactive UI using VDF = Autodesk.DataManagement.Client.Framework; using VDFVF = Autodesk.DataManagement.Client.Framework.Vault.Forms; // create settings object VDFVF.Settings.InteractiveAcquireFileSettings settings = new VDFVF.Settings.InteractiveAcquireFileSettings( connection, parentwindowhandle, "Download files"); // configure settings object settings.addentitytoacquire(fileiter); // call Library method passing in the settings object VDF.Vault.Results.AcquireFilesResults results = VDFVF.Library.AcquireFiles(settings);

34 Acquiring Files UI operations include any needed user prompts User setting managed automatically

35 Acquiring Files To download and checkout or the AcquisitionOption settings. using VDF = Autodesk.DataManagement.Client.Framework; settings.addfiletoacquire(fileiter, VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Checkout);

36 Acquiring Files Advanced Features Assembly download Resolve file references Download to specific folder Flatten folder structure

37 Acquiring Files Relationship Gathering By version, revision or latest Get children and/or parents Recurse children and/or parents Get attachments and/or dependencies Release biased or date biased

38 Acquiring Files Event Hooks Pre/post event for each file download Pre/post event for entire download operation Pre event for updating a file on disk Progress callbacks Cancelation

39

40 File Upload No upload UI support No advanced workflows CAD Add-In is still the recommended way to upload CAD files.

41 File Upload Connection.FileManager features: Provides AddFile, CheckinFile and UndoCheckoutFile Wraps multiple File Server and Data Server calls Automatically handles large files

42

43 Select Entity Dialog

44 Select Entity Dialog Steps for launching the dialog: 1. Create Grid Configuration a. Set a unique key for the grid and dialog settings. Example: CompanyName.AppName.DialogName b. Set default grid column and sort c. Optional settings 2. Create Dialog Settings 3. Call the Select Entity Library Method

45 Select Entity Dialog using VDF = Autodesk.DataManagement.Client.Framework; using VDFVF = Autodesk.DataManagement.Client.Framework.Vault.Forms; using VDFVCP = Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties // create grid configuration object & configure var config = new VDFVF.Controls.VaultBrowserControl.Configuration( connection, "MyCompany.MyApp.MyDialog.grid", null/*all pdefs*/); config.addinitialcolumn(vdfvcp.propertydefinitionids.server.entityname); config.addinitialsortcriteria(vdfvcp.propertydefinitionids.server.entityname, true); // create browse dialog settings object & configure var settings = new VDFVF.Settings.SelectEntitySettings(); settings.persistencekey = "MyCompany.MyApp.MyDialog"; settings.gridconfig = config; // assign grid cfg to settings // call Library method passing in the settings object var results = VDFVF.Library.SelectEntity(connection, settings);

46 Select Entity Dialog - Features Double-click on a folder navigates into the folder Look In Navigation control Up, Back and Change View buttons Type Ahead All Grid Control Features

47 Select Entity Dialog - Programmatic Support Filter based on Entity class Fixed grid settings Fixed view settings Revision and Release Biased controls Custom context menu Grid Control Configuration

48

49 Grid Control - Standard Features Columns o Configuration o Sorting o Grouping o Reorder Thumbnails Entity Icons Multiple Views In Place Find Setting Persistence

50 Grid Control - Embedded Steps for hosting the control: 1. Create Grid Configuration a. Set a unique key for the grid settings. Example: CompanyName.AppName.DialogName b. Set default column and sort c. Optional settings 2. Set Navigation Model object 3. Set Content on the model 4. Set Event Handlers 5. SetDataSource on the Grid Control

51 Grid Control - Embedded using VDF = Autodesk.DataManagement.Client.Framework; using VDFVF = Autodesk.DataManagement.Client.Framework.Vault.Forms; using VDFVCP = Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties; // create & configure grid configuration object var config = new VDFVF.Controls.VaultBrowserControl.Configuration( connection, "MyCompany.MyApp.MyGrid", null); config.addinitialcolumn(vdfvcp.propertydefinitionids.server.entityname); config.addinitialsortcriteria(vdfvcp.propertydefinitionids.server.entityname, true); // create the list of vault entities to display in the control var content = new List<VDF.Vault.Currency.Entities.IEntity>(); content.add(file1); // vdf file content.add(file2); // vdf file // create the desired model & assign the entities to it var model = new VDFVF.Models.ViewVaultNavigationModel(); model.setcontent(content); // bind the configuration & model to the grid control m_vaultgrid.setdatasource(config, model);

52 Grid Control - Features Display a flat list of entities List contents are defined by your code. Event hooks for user actions. All Grid Features (configurable columns, etc.)

53 Grid Control - Event Hooks Selection changed Double click Exception thrown Drag and Drop events Context menu invoke Anything inherited from System.Windows.Forms.UserControl

54

55 Error Handling Simple way to pop up the standard error dialog. using VDF = Autodesk.DataManagement.Client.Framework; try {... } catch (Exception ex) { VDF.Forms.Library.ShowError(ex, "Error"); }

56 Custom Error Handling 1. Create a class derived off of IExceptionParserProvider 2. Create an instance of that class 3. Register your provider via Framework.Library.ExceptionParserRegistrationService.RegisterParser(...)

57 Error Handling Localized Automatic localization for plug-ins Grab language pack for custom EXEs. See Developer Tools page in Vault online help. No restriction support Restrictions show up with the message Restrictions Found. ExceptionParser tells you the error code but not the user message.

58 Properties Server properties Available through VDF or web services Searchable Client properties Available through VDF only Not searchable PropertyDefinition.IsCalculated = true

59 Client Property Examples Involving client data Vault Status File Extension icon Modification of server properties (Date only) and (Time only) Entity Icon Non-property server data Path

60 Non UI mode For non-ui apps: Autodesk.DataManagement.Client.Framework.Library.Initialize(false);

61

62 Customizable Grid Rows 1. Define your own IEntity class. 2. Create objects of that class. 3. Pass objects into Grid content. Client classes can be displayed alongside server classes.

63 Customizable Grid Columns 1. Define your own IPropertyExtensionProvider 2. Create an instance of that class. 3. Call PropertyExtensionRegistration. AddPropertyExtensionProvider() New property can be set as a column. Also shows up in Customize Colum dialog.

64 IPropertyExtensionProvider Features Set your own property values client-side. Alter property values coming from the server. Display a property value as an icon. Set which entity classes apply to your property. Does not work with Vault Explorer main grid.

65

66 More Information Autodesk Vault and Autodesk PLM 360 Development Blog Autodesk Vault Online Help Autodesk Vault Customization Discussion Group

67 Survey Reminder Please fill out the survey.

68 Autodesk is a registered trademark of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and/or other countries. All other brand names, product names, or trademarks belong to their respective holders. Autodesk reserves the right to alter product and services offerings, and specifications and pricing at any time without notice, and is not responsible for typographical or graphical errors that may appear in this document Autodesk, Inc. All rights reserved.