Roundtable: Sell Your First Revit Plug-in on the Revit Exchange Store Saikat Bhattacharya Autodesk Stephen Preston - Autodesk

Transcription

1 Roundtable: Sell Your First Revit Plug-in on the Revit Exchange Store Saikat Bhattacharya Autodesk Stephen Preston - Autodesk CP2300-R Do you have a cool Revit app/plug-in or a content that you would like to try your hand at selling? The new Revit Exchange Apps store makes it very easy to get your work in front of hundreds of thousands of Revit users who might want to buy what you have to sell. Bring-in your Revit plug-in(s) or other content to this Roundtable session. In 90 minutes, you will walk away ready to sell your first product for sale through the Revit Exchange Store. We'll help you through the app packaging and posting process; provide advice on product naming, pricing, licensing; and more. Learning Objectives At the end of this class, you will be able to Understand the value you can get from free and fee-based products in the Revit Exchange store Package and publish products on the Revit Exchange Apps store Comprehend the money-making opportunity the Revit Exchange Apps Store offers Attractively package and price your products for sale on the Exchange store About the Speaker Saikat is a member of the AEC workgroup of the Autodesk Developer Network (ADN) team, providing evangelism, support, trainings and delivering technical presentations to the third party developers who are part of the ADN. He joined Autodesk in 2004 as Technical Consultant with the Autodesk Consulting group and then joined the ADN team. Saikat has prior experience as GIS software developer and as a project architect with the construction industry. He holds a Bachelor s degree in Architecture from India and a Master of Science degree from RPI. saikat.bhattacharya@autodesk.com

2 Introduction The primary goal of the Autodesk Exchange Apps store has been to provide end users of Autodesk products, with a trusted place to quickly and easily find, download and install add-on applications which can increase the breadth and depth of Autodesk product usage. The Exchange Apps Store brings together plug-ins, standalone applications, content libraries, training materials, e-books, and other products the tools that help customers quickly solve their problems and improve their productivity. If it s something useful, then it s a candidate for Autodesk Exchange Apps Store. The Autodesk Exchange Apps Store was initially launched for AutoCAD 2012 in June 2011 and then expanded to include Revit during the end of March The Exchange Apps Store includes products that are free, trial-based or fee based. By publishing a product to the Exchange Apps Store, publishers and developers can use the download information to find new customers and users i.e. for lead generation, or sell their products i.e. for revenue generation, or even both. If possible it is a good idea to experiment with a mix of offerings. (Note: Autodesk is not currently taking any commission for the fee-based products). For specialized and high-end add-ons, publishers can consider repurposing existing code to offer useful tools for lead generation and develop awareness of full applications. The end goal in this case is to be seen by the customers, and give them a good idea of what you can offer. Getting Started Anyone can submit a product to be published to Autodesk Exchange Apps. Publishers can simply go to select the Autodesk product your app is designed for, click on the Exchange Apps Developers! link and follow the simple steps. The Autodesk Exchange Apps Developer Center ( contains information to help you easily create or modify your apps to integrate with the simple Exchange Apps requirements and technical guidelines designed to give Exchange Apps customers a consistent user experience and to speed your product through the approval process. Please read the documentation provided here before you submit your app. Information for Autodesk Revit Developers This guide is for developers and content providers new to publishing plug-ins and other content on Autodesk Exchange Apps either free, trial or for fee versions. It outlines best practice guidelines and a few requirements for publishers to follow when creating products for the Autodesk Exchange Apps. These guidelines are designed to ensure that users on Autodesk Exchange have a consistent experience when downloading multiple products from the store. Requirements You will be presented with a detailed list of requirements for publishing on Exchange when you first register to be a publisher on Autodesk Exchange Apps. The information that follows is a summary specific to Autodesk Revit. For All Content Types Most of the information we need from you is collected from the product submission form that you complete in the publisher system. This includes gathering information to auto-generate a 'quick start' page 2

3 in HTML format that is included with the download of your product and is viewable online. Other requirements are: Compatibility: Your product must be relevant to (and usable with) Autodesk Revit 2013 software, and must run on any Windows operating system supported by Revit 2013 (including 32- and 64-bit versions). Your product may be compatible with any Revit 2013 based vertical application (i.e., Autodesk Revit, Autodesk Revit Architecture, Autodesk Revit Structure, and Autodesk Revit MEP). If it is not compatible with all Revit verticals, then please specify in your submission which Revit vertical it is compatible with. HTML help page: The documentation information you provide as part of the submission process is used to populate a standard, auto-generated HTML page. This information must allow the user to quickly understand how to use your product. You can reference additional information (for example, additional help files posted on your website) from this standard documentation. The auto-generated HTML page will be populated using information you provide when submitting your product to the store you will be prompted to supply it as part of the submission process. User privileges: The default user privilege for the store apps is Windows 7 Standard User. If your product or installer requires elevated user privileges, or if you don't use the standard installer template we provide, then this must be very clearly documented in the description of your product displayed on the store. Ready to run: Your product must be "ready to run" as soon as it's installed. It must not require the user to manually copy or register files, or manually edit Revit settings (such as support paths). If you use a licensing system, then it must allow your product to run as soon as it is installed by the user. This means that your application allows either instant activation (e.g., online activation), or full functionality with a time-bombed "grace period" that is long enough for you to send activation information to the customer. Product Stability: Your product should be stable, and not behave or alter the behavior of Revit in a way that we deem unsuitable (for example, blocking standard Revit functionality, blocking the functionality of another plug-in, causing data loss, etc.). Plug-ins Additional requirements for plug-ins are: You must use an add-in manifest as the loading mechanism. Your plug-in must include a ribbon button to access your main command. If your application has many buttons, you may also choose to have a separate custom ribbon tab. Family Libraries Additional requirements for family libraries are: Your Family Library must include a ribbon button to the Revit ribbon bar. The ribbon bar UI must either provide access to the family library or launch a help file explaining how to access it. Your family libraries (in rfa file format) must be installed in the following folder: Windows 7/Vista: %PUBLIC%\Documents\Autodesk\Downloaded Content (typically C:\Users\Public\Documents\Autodesk\Downloaded Content). Windows XP: %ALLUSERSPROFILE%\Documents\Autodesk\Downloaded Content 3

4 (typically C:\Documents and Settings\All Users\Documents\Autodesk\Downloaded Content) Note: This is to be consistent with other Autodesk products - for a repeatable cross-product user experience (for example, when using products in a Suite). Again, we'll create the installer for you and we can help you modify your libraries so that they work in this new location. Standalone Applications and Other Contents There are no additional requirements for products that are not integrated with Revit. If you wonder what kinds of products this might include consider ebooks, video tutorials, industry specific calculators, connectors to Cloud based services and the like. Guidelines Use of the Add-in Manifest As a default location, we ll be using per-user location to place the add-in manifest: %appdata%\autodesk\revit\addins\2013 In addition to the add-in manifest, a folder containing all the supporting materials that your plugin-in needs will also be placed in the same location. The name of the folder is exactly the same as the name of the add-in manifest except that it has.bundle instead of.addin. e.g.: The Add-in manifest accepts relative path in the <Assembly/> tag: <Assembly>.\ADNPlugin-RoomRenumbering.bundle\ADNPlugin-RoomRenumbering.dll</Assembly> In this way, your plug-in can be simply installed by copying files without requiring the add-in manifest to be modified during installation. To see how this looks, you can download some of the free plug-ins already available on Autodesk Exchange store and study their format. For example, the following Autodesk Plugins of the Month are currently available: Duct Fitting Table Viewer Filer Upgrader String Search Wall Opening Area Use a Registered Developer Symbol We strongly recommend you prefix your filenames with your Registered Developer Symbol (RDS) to avoid potential naming conflict with other plug-ins. You can reserve an RDS for free at 4

5 (If you don't use an RDS, and your plug-in files clash with another plug-in, then we will ask you to rename your files). This applies to contents (such as family libraries) as well as plug-in modules. Use the Ribbon Using ribbon elements for your application is requirement, but how you do this will depend on your plug-in design. As a minimum, every plug-in or family library must add a panel to the 'Add-Ins' tab that either invokes the main command defined by the plug-in or displays a help file explaining how to use the family library. However, if your plug-in defines more than one command, then you will have to create ribbon layout for your plug-in in a way that is most helpful to the user (for example, using large buttons for most frequently used commands and small buttons for lesser used commands). Plug-ins that install a single panel should normally add that panel to the 'Add-Ins' tab. Plug-ins that creates several ribbon bar panels may prefer to create a new tab specific to that Plug-In (and preferably with the Tab name being the name of the plug-in). Use the Contextual Help (F1 Help) with a Ribbon Item Contextual or F1 Help support is a new feature in Revit 2013 API. Please refer to the RibbonItem.SetContextualHelp() method and the ContextualHelp class in the Revit API documentation. The Autodesk Plug-in of the Month sample apps posted to the Exchange Apps store demonstrate how to implement F1 help. We encourage you to use a help mechanism that is consistent with the Revit help, such as tooltips and contextual help placed on a ribbon item. The options supported for contextual help include linking to an external URL, launching a locally installed help file, or linking to a topic on the Autodesk help wiki. End User License Agreement The installer that the ADN team creates for your app includes a button that allows the user to view the standard End User License Agreement (EULA) during the app installation. This EULA is NOT modifiable. If you wish to include your own EULA to your app, you can either: 1) reference your EULA from the standard HTM help file text, or 2) display your EULA when the app runs for the first time, and require the user to accept it before the app will work. Special Considerations If your app or content has any special requirements and the standard installer template cannot handle as is, please talk to us. For example, we understand that for a large application, installing to all-user location may be desirable. It is possible to install at: %programdata%\autodesk\revit\addins\2013. For any other special needs that require a custom installation, you can provide them in the form of Windows Installer Merge Modules (.msm) files. We will merge your msm file with the Windows Installer (.msi) file that we create for your app. Examples of such a scenario would be: writing entries to the registry for a licensing system you are using, installing dependent components by other vendors, and running custom scripts. For additional information, please contact us at appsinfo@autodesk.com. App Submission Process Overview 5

6 Please read through this information before and while submitting your first app to the Exchange store. It explains the basic workflow and provides some additional information to make publishing your app as easy as possible. Submitting an App Before submitting your app, we recommend you collect the information you ll need. Use the App submissions required information document as a template and checklist. To start your app submission, click on the link displayed on the Exchange storefront: You will then be taken to a page showing some publishing information and a publisher agreement. Make sure you read this information carefully and click to accept the agreement. Then click the Continue button to move to the publish workflow. (You will be asked to login using your Autodesk Single-Sign-On account if you re not already logged in): 6

7 Language selection Screen Click on the Add Native Language link, select English from the list, and click the Add button. o Note: Only English is supported at this time. The form has been designed to allow the addition of other languages in the future Click the Continue button Use the Save as Draft button to save your app submission so you can continue it later. You can access your app later from the My Uploads screen see 'Editing an existing app'. 7

8 App Information Screen 8

9 Enter information for your app in the textboxes on the form. o The App Description textbox allows long descriptions (i.e characters). This is where you should include a detailed description of your app. Customers will read this section to see if your App is worth buying/downloading. If your app is a trial version include information here on the type of trial or limitations of the trial. o If you set a Price, the value you enter must be numeric only (i.e. don t use $,,,, etc.). If you indicate your App is a paid App you will then be asked to add a PayPal address (but not if you ll just be providing Free and Trial Products). You should have either a PayPal Business Account or a Premier Account. Refer to the additional documentation for PayPal account settings required for the Exchange store from the PayPal Account Setup link in the Autodesk Exchange Apps Developer Center ( page. o The Publisher Contact Information is the address we will use to send you automated notifications when your app is downloaded, and where we will contact you for any additional information we need while reviewing your app. o The Publisher Contact Information and PayPal for Payments apply to all apps you publish. If you edit this in one app, it will change for all of them. Click Continue to proceed. 9

10 File Uploading Screen To upload your app files, click the Choose File button and select your file in the dialog that appears. Then click the Upload button. Your App File is your installer, your zipped app files, or PDF files. o If we have already provided you with an MSI installer file for your app, please upload the MSI directly do not zip it first. o Please also upload PDF files unzipped. Your App Logo is the icon displayed on the store to represent your app. o We recommend 80x80 pixels for your Logo. o If you re looking for a free icon editing tool, then you might consider GIMP, Paint.NET or something similar. o Refer to Icon Guidelines and Template for guidance and specifications. Add up to 10 App Screenshots. Once you ve uploaded each image, a text box will appear in which you should enter the text that will accompany the screenshot. Screenshot images will be scaled to fit the views that Exchange supports for screenshots. Recommended maximum image size and dimensions: 2000 pixels wide x 2000 pixels high, DPI: 96 or 72 pixels per inch (PPI), maximum file size 5MB. Click Continue to proceed. 10

11 Compatibility Screen Click on the down arrow symbols to extend a product family list. Select all the Autodesk products your app is compatible with. o If a product isn t listed here, then it means that it is not supported by the store at this time. Please contact us for information on unlisted products you re interested in. Marking your app as compatible with a product means that: o You have tested your app with that product o You are able to support customers using your app with that product. AutoCAD means vanilla AutoCAD only. It does not include an AutoCAD vertical running its vanilla profile. Click Continue to proceed. 11

12 Categories Screen A list of Categories will be displayed for each Product you selected on the Compatibility Screen. Select up to 4 the categories that apply to your application for each product it is compatible with, and add a custom category if needed. o Don t spam customers by selecting Categories that are not relevant to your app. Click Continue to proceed. 12

13 Documentation Screen Enter the information for your app that we can use to create a standard format quick start helpfile. This will be shipped with your app and displayed on the store (not yet implemented). o If you re using our standard installer template (i.e. we are creating the installer for you) then just write standard text in the Installation/Uninstallation textbox, and we ll substitute the correct text for you when we review your app. o In the Author/Company Information textbox, please include details of how a customer can contact you for support (e.g. this address, or visit this webpage). Click Continue to proceed. 13

14 App Summary screen This is a summary of the information you entered about your app. Click the Preview Button to open a new browser tab showing how your app will look in the store. o Use the Back button to go back through the workflow to change any information that you don t like in the Preview. Click the Submit button if you re happy with the Preview. You should be contacted by an app reviewer within two weeks of submitting your app. Please AppSubmissions@autodesk.com if you have not heard from us within that time. Editing an existing app Go to You will then be prompted to log in using your Autodesk Single Sign On account. To edit, use edit button corresponding to your application as shown below. 14

15 If the app you wish to edit is published, then you will have to click the un-publish button before the edit button appears. This will remove your published app from the store until the store manager republishes your edited app. When you start editing an existing app, you simply follow the same workflow as creating a new app, except the information you previously entered is now displayed. More information The ADN team is here during this Roundtable session, to help you be a successful publisher on Autodesk Exchange store. We ll do whatever we can do to help you. You are also welcome to appsinfo@autodesk.com if you have any further questions after reviewing these guidelines and the other documentation on Thank you for participating in this Roundtable session and for your interest in the Revit Exchange Apps Store. 15