Follow the steps in this topic to configure the Enterprise Add-on for Vault.
This feature is available in certain editions of vault. To see if your Vault edition supports this feature, refer to the following table .
2012 | 2013 | 2014 | |
---|---|---|---|
Autodesk Vault Basic |
![]() |
![]() |
|
Autodesk Vault Workgroup |
![]() |
![]() |
|
Autodesk Vault Collaboration |
![]() |
![]() |
|
Autodesk Vault Professional |
![]() |
![]() |
The property management utility enables access to Vault properties in Inventor and AutoCAD clients. The configuration of property schemas is stored in XML file.
Make sure that all properties are created in vault prior to configuring the XML File.
The XML file should be located in C:\Program Files\Autodesk\VAO 2013\Configuration\Property Management.
The XML file contains following elements:
Inventor add-In can automatically synchronize properties between the Inventor model and drawing.
The properties can be specified using SynchronizedProperty element.
All job handlers must be registered in the JobProcessor.exe.config file. The file is located under C:\Program Files\Autodesk\Vault Professional 2013\Explorer.
The file uses XML format. Job handler registration is located under configuration/connectivityExplorer/jobHandlers element in JobProcessor.exe.config.
During Enterprise Add-On for Autodesk Vault installation, the JobProcessor.exe.config file is automatically updated. It is recommended to stop the service before installing Enterprise Add-On for Autodesk Vault and to restart it once the installation is completed, this will ensure that all the changes take effect properly.
The jobHandler element uses following syntax:
<jobHandler class="ClassName" handler="JobHandlerName " />
Following entries should be added into configuration file:
<!--Custom job handlers --> <jobHandler class="Autodesk.VaultToolkit.Publish.CATV5Part" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.CATV5Product" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.IGES" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.JT" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.PDF" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.STEP" handler="Autodesk.VaultToolkit.Vault.PublishJobHandler, Autodesk.VaultToolkit.Vault.JobHandler" /> <jobHandler class="Autodesk.VaultToolkit.Publish.Publish.FlatPatternDXF " handler="Autodesk.VaultToolkit.Vault.Inventor.FlatPatternPublisher, Autodesk.VaultToolkit.Vault.JobHandler" />
It is possible to specify default options for each supported file format. The configuration is via XML file which needs to be imported into Vault.
A configuration template is stored in the following directory:
C:\Program Files\Autodesk\VAO 2013\Configuration\Property Management\JobConfiguration.xml.If you edit configuration file in the location above, don't forget to import it using the custom command (Tools Enterprise Add-On
Settings
Publish Jobs) available in Vault Explorer. This guarantees that same options will be available for all users connected to same server
and Vault database.
The table below contains detailed list of common options.
The following keywords can be used when specifying the name of the output file.
It's possible to configure Vault to run publish job on lifecycle state change. The Vault SDK is required to enable this to work; the LifecycleEventEditor is used to fulfill this functionality. The application is include in Vault SDK (under [Vault SDK Installation Folder]\util\LifecycleEventEditor). Use following steps:
The Clone Structure command supports any folder structure including project structure used by AutoCAD Civil3D. In this case the structure contains additional files required by Civil3D - i.e., PointsGeometry.db.
The list of such files can be defined in the file named IncludedProjectFiles.xml. The file is located in installation folder for Vault add-in.
The configuration for the email notification is defined using XML file. The import and export of configurations, as well the creation of a template configuration file can be done from the Settings UI.
Following parameters must be defined in the XML file:
The email subject and -body configuration can include placeholders which will be replaced by real values before an email is being sent out. Valid placeholders are:
The configuration of the object classification rules is stored in an XML file. The XML file must be configured to fit the business requirement and then imported in to Vault prior usage of the add-in functionality.
The classification schemas are defined using XML file. The Classification XML can also be generated manually. A template can be generated to perform this action.
The vault properties used for the DOCUMENT or/and ITEM classification need to be as a minimum member of the Vault "File" or "Item" category. They do not need to be (but can be) part of the categories definition in Vault.
Key field description of the Classification XML
The configuration for the four eyes check is defined by a specified XML file. The import and export of configurations, as well as the creation of a template configuration file can be done from the Settings UI of the Enterprise Add-On for Autodesk Vault within the Vault Explorer.
Following parameters will have to be defined in the XML file to make it work:
The application will compare the name of the VaultUser which did the LifeCycle change prior to the current state change with the current VaultUser login.
In the case that they are the same the system will issue an exception and a message box will be displayed.
The workflow change process will be stopped and the user will need to change to a different VaultUser to change the state after checking the documents.
However the application of the 4 Eyes Check can be bound to a number of pre-conditions:
With this pre-condition you can position the check to the absolutely needed objects in Vault when changing their sate. Multiple configurations (one per LifeCycleStateDefinitionName) are supported. This function assumes the enforcement of a workflow definition native to the customer's current environment and legal requirements by government or ISO regulations.
A LINQ query expression can execute checks on the following objects:
An example expression could look like this:
Name = "Created By" and Value.ToString() = "Administrator"
The call to the vget function can be extended with the following parameters:
Please find below some examples for the usage of the tool.
Sync folder structure (no files):
vget -s cfgAdmin -p test -db vault1 -t -sr $/prj001/cooker/model1/
In this case all files will be copied from the source vault folder to the local workspace.
vget -s cfgAdmin -p test -db vault1 -s -t $/prj001/cooker/model1/ -tg f:\mycfg\
In this case the tool will be used in silent mode and all files copied to the target folder.
Sync folder structure (including files):
vget -s cfgAdmin -p test -db vault1 -sr $/prj001/cooker/model1/
vget -s cfgAdmin -p test -db vault1 -sr $/prj001/cooker/model1/ -tg f:\mycfg\ dwg;dxf
vget -s cfgAdmin -p test -db vault1 -sr $/prj001/cooker/model1/best.dwg
This utility allows to export and import user and group definitions, greatly speeding up the creation and configuration of Vault accounts when many users and groups are required by the customer.
This is a command line utility, and reads from/writes to a CSV file.
This command line utility ( VaultUserAccounts.exe) is located in the C:\Program Files\Autodesk\VAO 2013 directory.
As best practice you should export your current user and group list from Vault to view the correct syntax of the CSV file, and then adding into this your new user accounts either by typing, or adding in an export from Windows security lists, MS-Outlook Contacts, or similar.
VaultUserAccounts.exe
It is a simple syntax, even allowing for the type of user account to be exported/imported with the -A "AuthenticationType" parameter.
Example–Exporting current user accounts.
We have exported to a CSV file called "spool.csv" which looks like this:
Columns A-E define the users "firstname", "lastname", "username", "email address", and "password"; as you would normally create a new Vault user.
Column F contains ALL the roles that this user should have, concatenated into one string and separated by a semi-colon for each role.
These must be exactly as the descriptions in Vault, hence the recommendation to always start with an export of your current user list from Vault; then it easier to cut and paste required roles for new users within MS-Excel.
Column G contains all the vaults that this user should be assigned to, again semi-colon separated.
Column H shows which groups this user should be assigned to.
Column I is set to "1" for all user so that they are enabled.
Once you have made your manual changes to this CSV file, save it, and re-import with the syntax like:
VaultUserAccounts.exe –u administrator –p “” –s localhost –a Vault –g IMPORT Groups.csv
For larger implementations, this utility will save you a lot of time; even when using Active Domain user accounts.
This utility allows you to update file properties from an external text file, such as for instance if one is migrating data from a legacy document management system that also holds property data not present in the files.
This command line utility is located in C:\Program Files\Autodesk\VAO 2013 directory.
There are some rules that apply, for the import to be successful.
Using a text string (in a command window) like
ImportFileProperties.exe -s localhost -db Vault - u administrator -p "" FileProperties.csv
would produce results like this:
Where the ADMS server computer is called "localhost", we use the "administrator" login, with a blank password, to log into the "Vault" vault, and the import text file called FileProperties.csv.
The expected results should show that:
All file properties have been updated accordingly.
This is a command line tool that can be used to populate the configured list values of either file or item properties.
At a windows command prompt, simply running the ImportPropertyList.exe file will display the required syntax.
In a vault called "Demo1", I have an item property called "Source_Country", and this needs to cater for the following list:
AUSTRALIA | INDIA | POLAND |
AUSTRIA | INDONESIA | PORTUGAL |
BELGIUM | IRELAND | RUSSIA |
BRAZIL | ISRAEL | SINGAPORE |
CHILE | ITALY | SLOVAK REPUBLIC |
CHINA | JAPAN | SOUTH AFRICA |
COLOMBIA | LATVIA | SOUTH KOREA |
CZECH REPUBLIC | LUXEMBOURG | SPAIN |
DENMARK | MALAYSIA | SWEDEN |
ESTONIA | MEXICO | SWITZERLAND |
FINLAND | NETHERLANDS | TAIWAN |
FRANCE | NEW ZEALAND | THAILAND |
GERMANY | NORWAY | UNITED KINGDOM |
GREECE | PANAMA | URUGUAY |
HONG KONG | PERU | USA |
HUNGARY | PHILIPPINES | VENEZUELA |
There is no way we want to have to manually enter all of these when creating the property in Vault.
So, we create the item property as a list type, with one value (does not matter what that is, since the import will overwrite the existing list values of the property).
The syntax would be something like:
ImportPropertyList.exe -s Fara06738 -db Demo1 -u administrator -p "" -t File Source_County Countries.txt
The end result is the populated list: