Akeneo Product Assistant for Autodesk® Vault® User Guide (September ... - AMC … · 2019-12-04 · Wait till the setup wizard completes the installation. 5. lick Finish ... 3

ENGINEERING SOFTWARE DEVELOPMENT MADE EASY

www.amcbridge.com AMC Bridge confidential. For internal use only

Akeneo Product Assistant for Autodesk® Vault®

User Guide

(September 2019)

Akeneo Product Assistant for Autodesk® Vault® User Guide

Copyright © 2019 AMC Bridge AMC Bridge confidential. For internal use only

2

Contents

Welcome to Akeneo Product Assistant for Autodesk Vault ................................................................................................ 3

Requirements and installation ........................................................................................................................................... 3

Requirements ................................................................................................................................................................ 3

Installation .................................................................................................................................................................... 3

Getting started .................................................................................................................................................................. 5

User interface .................................................................................................................................................................... 6

Functionality ..................................................................................................................................................................... 7

Log In ............................................................................................................................................................................ 7

Log Out ....................................................................................................................................................................... 10

Export ......................................................................................................................................................................... 10

Update with Akeneo ................................................................................................................................................... 12

Configure mapping ..................................................................................................................................................... 16

About .......................................................................................................................................................................... 18

Uninstallation .................................................................................................................................................................. 18

About AMC Bridge ........................................................................................................................................................... 19



3

Welcome to Akeneo Product Assistant for Autodesk Vault

Akeneo Product Assistant for Autodesk® Vault® is a technology demonstration of connecting

Autodesk® Vault® Professional 2019 with Akeneo™ Community Edition. 

Introducing Akeneo PIM to users, it demonstrates how to create, update, and edit product

information in the Akeneo PIM system using the data stored in Autodesk Vault. 

Akeneo Product Assistant for Autodesk Vault enables users to: 

• Connect to the Akeneo server. 

• Select files from the Vault Client to create products. 

• Map the configuration between the Vault properties and the Akeneo attributes. 

• Provide users with the results of file processing. 

• Set the product image from the Vault Client as the thumbnail or preview image. 

Requirements and installation

Requirements Akeneo Product Assistant for Autodesk Vault requires the following software to be installed:

• Windows 10 Professional (64-bit).

• Autodesk Vault Professional 2019.

• Akeneo Community Edition.

Installation

To install Akeneo Product Assistant for Autodesk Vault

1. Upload a setup file for Akeneo Product Assistant for Autodesk Vault.

2. Double-click it.

3. In the new Setup dialog, select I accept the terms in the License Agreement checkbox, click

Install and then click Next (see Fig. 1, 2).



4

Figure 1.

Figure 2.

4. Wait till the setup wizard completes the installation.

5. Click Finish (see Fig. 3).

Output: The Akeneo PIM menu appears on the Tools tab of the Autodesk Vault ribbon.



5

Figure 3.

Getting started

To get started with Akeneo Product Assistant for Autodesk Vault

1. Launch Autodesk Vault (see Fig. 4).

Figure 4.



6

2. Click the Tools tab on the Autodesk Vault ribbon (see Fig. 5).

Figure 5.

User interface

Akeneo Product Assistant for Autodesk Vault has the following set of commands:

• Log In

• Log Out

• Export

• Update with Akeneo

• Configure mapping

• About

You will find more details about each command further in this document.

By default, only Log In and About are available. You need to log in to the Akeneo server to interact

with Akeneo. Refer to the Log In section of this user guide to get more details about access.

https://sitrusllc.sharepoint.com/TeamSite/Projects/ResearchProjects/AutodeskVaultToAkeneoProductImporter/Shared%20Documents/Stage%201/Autodesk%20Vault%20to%20Akeneo%20Specification.docx#_Akeneo_create_new

https://sitrusllc.sharepoint.com/TeamSite/Projects/ResearchProjects/AutodeskVaultToAkeneoProductImporter/Shared%20Documents/Stage%201/Autodesk%20Vault%20to%20Akeneo%20Specification.docx#_Akeneo_Log_out

https://sitrusllc.sharepoint.com/TeamSite/Projects/ResearchProjects/AutodeskVaultToAkeneoProductImporter/Shared%20Documents/Stage%201/Autodesk%20Vault%20to%20Akeneo%20Specification.docx#_Akeneo_update_product.



7

Functionality

Log In

Log In establishes a connection between the Vault client and the Akeneo server.

To establish this connection

1. Launch Autodesk Vault.

2. Click Tools on the Autodesk Vault ribbon.

3. Click Akeneo PIM > Log In.

Output: The Log In dialog appears (see Fig. 6).

Figure 6.

The Akeneo Log In dialog contains the following boxes and buttons:

• Host. Type the URL or IP address of the Akeneo server. By default, it displays the address of the

latest connected server.

• Client ID. Type your Client ID for your internal Akeneo server.

• Secret. Type your secret for your internal Akeneo server.

• Name. Type your username to log in to the Akeneo server.

• Password. Type your password to log in to the Akeneo server. The password is hidden. To view



8

the hidden password, click .

• Cancel. Click it to close the dialog without further interaction.

• OK. Click it to establish a connection with the Akeneo server.

Tip: If you want to connect to the server automatically every time Autodesk Vault starts, select the Remember me checkbox.

If you do not have your own internal Akeneo server, you can log in to the Akeneo demo server.

To do this

1. In the Host box, type https://www.akeneo.com/demo/

2. Go to the Akeneo website and copy the following demo server credentials:

• Username: admin

• Password: admin

3. Click Access our online demo in the lower-left corner of the dialog (see Fig. 7), enter the demo

server credentials from the point above, and click Log in (see Fig. 8).

Figure 7.

https://www.akeneo.com/demo/

https://www.akeneo.com/demo/



9

Figure 8.

4. Click System > API Connections to get your demo Client ID and Secret (see Fig. 9)

Figure 9.

5. Copy these credentials, return to the Log In dialog of Akeneo Product Assistant for Autodesk

Vault, enter the access data, and click OK.

Output: The Success dialog appears (see Fig. 10).

Figure 10.



10

Log Out

To break a connection with the Akeneo server, and exit your Akeneo account


2. Click Akeneo PIM > Log Out.

Output: The Log Out dialog appears (see Fig. 11).

Figure 11.

When executed, Log out removes all the stored Akeneo tokens, logins, and passwords. You can

execute it either on your demand or automatically when you close the Vault Client.

Export

Export allows creating Vault products in the Akeneo PIM system. Akeneo Product Assistant for Autodesk Vault supports the following functionality:

• Single-file export.

• Multi-file export.

• Folder export.

To export the product(s), follow the steps below:

1. Launch Autodesk Vault.

2. Select the file(s) or the folder you need to export.

3. You can launch Export in one of the following ways:

a. Click Tools > Akeneo PIM > Export. Output: The Create Akeneo Product dialog appears (see Fig. 12).

b. Right-click the selected file(s) or the folder you need to export and click Export. Output: The Create Akeneo Product dialog appears (see Fig. 12).



11

Figure 12.

The Create Akeneo Product dialog contains the following boxes and buttons:

• Project image. It shows the default image representation of the Vault product in the Akeneo PIM system.

• Name. Enter the name of the product in the Akeneo PIM system. The name of the selected file in the Vault Client is set by default.

• Enable. Select the checkbox to make the new product available to Akeneo users.

• Channel. Select a channel for the product. A channel in Akeneo defines a selection of products and information for exporting. A channel can be a website, a print catalog, a mobile application, and so on.

• All. Select the checkbox to assign a product to all the channels.

• Locale. Select a locale for the product. A locale in Akeneo is a combination of a language (for example, English, German, French) and a country (for example, the United States, United Kingdom, France). Locale allows users to manage the translation of product information in the interface.

• Families. Select a family for the product. Families are used for gathering attributes that are common to several products.

• Mapping. Allows users to configure property mapping between the Vault and Akeneo properties for the family you export. Refer to the Configure mapping section of this user guide to get more details.

• Cancel. Click it to close the dialog without interaction.

• OK. Click it to run the product creation process.



12

Update with Akeneo

Update with Akeneo allows users to update information about the existing product in Akeneo and Autodesk Vault.

To update the product information, follow the steps below:

1. Export a product from Autodesk Vault to Akeneo. Refer to the Export section for more details.

2. Click the link in the success message to go to the Akeneo server (see Fig. 13).

Figure 13.

3. Find the exported product on the Products list, update the necessary information, and click Save in the upper-left corner (see Fig. 14).

Figure 14.

Note: You can update the product information for different channels and locales as well (see Fig. 15).



13

Figure 15.

4. Return to Autodesk Vault and launch Update with Akeneo in one of the following ways:

a. Click Tools > Akeneo PIM > Update with Akeneo. Output: The Update with Akeneo dialog appears (see Fig. 16).

b. Right-click the selected file(s) you need to update and click Update with Akeneo. Output: The Update with Akeneo dialog appears (see Fig. 16).



14

Figure 16.

The Update with Akeneo dialog provides the following information:

• Channel. Displays the Akeneo channel of the selected product(s).

• Locale. Displays the Akeneo locale of the selected product(s).

• Information about the Vault properties defined for a specific Vault product with the mapping command.

• The current value of the existing Vault property.

• The new value of the Akeneo property corresponding to the selected Akeneo locale and channel.

Update with Akeneo lets you:

• Select each specific property that you need to update.

• Automatically mark the properties based on differences between the Vault and Akeneo values.

• Mark all properties as selected and deselected.

• Change the Akeneo locale and channel on demand.

• Change the Akeneo locale and channel on demand and automatically refresh the Akeneo properties.

5. Select the checkboxes next to the properties you need to update and click OK (see Fig. 17).



15

Figure 17.

6. Check the updated information for the latest product version in the Vault properties (see Fig. 18).

Figure 18.



16

Configure mapping

Configure mapping allows to create the mapping between the Akeneo family attributes and Vault properties of the products.

To configure mapping, follow the instructions below:


2. Click Akeneo PIM > Configure mapping.

Output: The Akeneo Family Mapping dialog appears (see Fig. 19).

Figure 19.

The Akeneo Family Mapping dialog contains two columns:

• Akeneo Attribute. The values of this column are not editable and represent the names of the

attributes from the specific Akeneo family collection.

• Vault Properties. This column represents the corresponding properties in the Vault Client (see

Fig. 20).



17

Figure 20.

The Akeneo Family Mapping dialog also contains the following boxes and buttons:

• Cancel. Click it to close the dialog without further interaction.

• OK. Click it to save the mapping results.

• Default. Click it to map all the available properties in Akeneo to the Vault properties based on the property names. For example, it maps the description property to the Description property.



18

About

About opens the About dialog with contact information and version details (see Fig. 21).

Figure 21.

Uninstallation

To uninstall Akeneo Product Assistant for Autodesk Vault

1. In Control Panel, click Programs > Uninstall a program.

2. Right-click Akeneo Product Assistant for Autodesk Vault, and then click Uninstall.

3. In a confirmation message, click Yes to continue the uninstallation (see Fig. 22).

Figure 22.



19

About AMC Bridge

AMC Bridge is a vendor of choice for software development services in the areas of computer-aided

design, engineering, manufacturing, and construction. Since 1999 we have been delivering solutions

for CAD, CAE, CAM, PDM, BIM, and PLM applications. For over 15 years, we have participated in the

development of commercial software products and custom solutions for the engineering markets

based on the variety of platforms, from desktop and web to mobile and clouds.

AMC Bridge helps to improve engineering process overhead by developing 3D and 2D modeling

software products, data, document and community management technologies, CAD data

interoperability, and many other aspects of software development for the engineering markets.

The AMC Bridge team is always open to new challenging projects, requests, and suggestions. Feel free

to contact us, and we will do our best to turn your ideas into reality.

303 Wyman Street, Suite 300 Waltham, MA 02451, USA

+1 866-575-4791

www.amcbridge.com

For all online inquiries, please contact: [email protected]

Technical Support: [email protected]

http://www.amcbridge.com/

http://www.amcbridge.com/

mailto:[email protected]


