Autodesk Exchange for Autodesk Revit Preparing Apps for

Autodesk Exchange for Autodesk® Revit® Preparing Apps for the Store: Guidelines © 2013 Autodesk

Publishing Workflow Overview 6. Update bundle or upload the msi for final publishing 7. Go live on the store 1. App. bundle Guidelines Publisher (developer) 3. Initial submission Autodesk 4. Packaging/testing 2. Publishing Info. Icons, help files, contact, etc. 5. Send updated bundle or msi for testing © 2013 Autodesk Exchange for Revit

Guidelines § Ribbon buttons § Contextual (F 1) help § Install locations § “Bundle” structure © 2013 Autodesk Exchange for Revit

Ribbon Buttons § § § Need to have Ribbon Button (not under external tools) Add-ins tab (by default) Custom tabs (optional) Autodesk Icon Guidelines. pdf under Revit SDK Autodesk Wiki. Help > Revit > Developers > Appendices > API User Interface Guidelines > Ribbon Guidelines http: //wikihelp. autodesk. com/Revit/enu/2014/Help/ 3665 -Developers/0170 -Appendic 170/0206 -API_User 206/0215 -Ribbon_G 215 © 2013 Autodesk Exchange for Revit

Contextual (F 1) Help § Ribbon. Item. Set. Contextual. Help() § Link to: § External URL § Local help file § Autodesk help file © 2013 Autodesk Exchange for Revit

Install Locations § All User (Default) § %Program. Data%AutodeskApplication. Plugins<my. App>. bundle All User location Fixed location. Shares with other Autodesk products A folder containing your application § Per User § %App. Data%AutodeskApplication. Plugins<my. App>. bundle Per User location © 2013 Autodesk Exchange for Revit

Bundle Folder Structure (1) Typical Single App Contain Installer and run-time info. *1 To be completed upon submission <my. App>. bundle Package. Contents. xml Organize and place necessary Contents files under. bundle <my. App>. dll <my. App>. addin Resources my. Icon. Image. png my. Help. html <any other supporting files/folders> *1) Revit supports the store location or Package. Contents. xml since the release 2014 © 2013 Autodesk

Bundle Folder Structure (2) App Supporting Multiple Versions <my. App>. bundle Package. Contents. xml Organize and place necessary Contents files under. bundle 2014 <my. App>. dll <my. App>. addin 20 xx <my. App>. dll <my. App>. addin Resources my. Icon. Image. png my. Help. html <any other supporting files and folders> © 2013 Autodesk

Package. Contents. xml § Generated by the Autodesk installer tool after the initial submission of an app (populated from submission information. No need for publisher to provide as such) § Contains installer information § Revit 2014 (and above) will read this file and pick up the location of. addin manifest § Important: keep it in your bundle once it is generated after the initial submission © 2013 Autodesk Exchange for Revit

Package. Contents. xml Populated by Installer Tool Installer information <? xml version="1. 0" encoding="utf-8"? > <Application. Package Schema. Version="1. 0" Autodesk. Product="Revit" Product. Type="Application" Name="File Upgrader" App. Version="2. 0. 0" Description="ADN Plugin of the Month: File Upgrader " Author="Saikat Bhattacharya " Icon=". /Contents/2014/Resources/File. Upgrader_Thumbnail. png " Online. Documentation ="http: //labs. autodesk. com/utilities/ADN_Plugins " Help. File=". /Contents/2014/Resources/ADNFile. Upgrader. Help. htm " Product. Code="{F 23 B 85 C 8 -D 5 DE-45 B 9 -977 E-D 860120 D 27 B 1} " Upgrade. Code="{5 D 9 F 89 AD-3 CC 0 -4769 -B 90 D-60 BFB 4 EE 90 DB} " Friendly. Version="2. 0. 0" Supported. Locales ="Enu" App. Name. Space="appstore. exchange. autodesk. com "> <Company. Details Name="Autodesk" Url="http: //labs. autodesk. com/utilities/ADN_Plugins " Email="adn. apps@autodesk. com " Phone=" " /> Summary of components (optional) <Runtime. Requirements OS="Win 32|Win 64" Platform="Revit|Revit Architecture|Revit Structure|Revit MEP " Series. Min="R 2014" Series. Max="R 2014" /> <Components Description="2014 parts"> Revit run-time info <Runtime. Requirements OS="Win 32|Win 64" Platform="Revit|Revit Architecture|Revit Structure|Revit MEP " Series. Min="R 2014" Series. Max="R 2014" /> Location of addin manifest <Component. Entry App. Name="File. Upgrader" Version="2. 0. 0" Module. Name=". /Contents/2014/ADNPlugin-File. Upgrader. addin " App. Description="File. Upgrader" /> </Components> </Application. Package > © 2013 Autodesk

Revit App Auto Load Flow 1. Revit goes through the common install folder and parse for Revit apps for the appropriate environments (Runtime. Requirements) 2. Revit picks up the location of addin manifest (Module. Name) 3. Read. addin manifest and load the app. Minimum <? xml version="1. 0" encoding="utf-8"? > Package. Contents. xml <Application. Package> to load to Revit. <Components Description="2014 parts"> Use for testing purposes <Runtime. Requirements OS="Win 32|Win 64" Platform="Revit|Revit Architecture|Revit Structure|Revit MEP " Series. Min="R 2014" Series. Max="R 2014" /> <Component. Entry App. Name="File. Upgrader" Version="2. 0. 0" Module. Name=". /Contents/2014/ADNPlugin-File. Upgrader. addin " App. Description="File. Upgrader" /> </Components> </Application. Package> © 2013 Autodesk Exchange for Revit

Addin Manifest § Use the relative path to your dll <? xml version="1. 0" encoding="utf-8" standalone="no"? > <Revit. Add. Ins> Relative path to your dll <Add. In Type="Application"> <Name>File Upgrader</Name> <Assembly>. ADNPlugin-File. Upgrader. dll</Assembly> <Client. Id>BEA 80927 -9044 -4 c 31 -AAE 1 -48 AB 3527 AAAA</Client. Id> <Full. Class. Name>ADNPlugin. Revit. File. Upgrader. Ribbon</Full. Class. Nam e> <Vendor. Id>ADNP</Vendor. Id> <Vendor. Description>Autodesk, www. autodesk. com</Vendor. Description> </Add. In> </Revit. Add. Ins> § By default, Revit will load addins without restarting Revit. If you want to change this behavior, add the flag: *1 <Allow. Load. Into. Existing. Session>false</Allow. Load. Into. Existing. Session> *1) Revit supports in-session loading since the release 2014. Earlier releases require restarting Revit. © 2013 Autodesk Exchange for Revit

Preparing Apps for the Store: Guidelines § Ribbon buttons § Contextual (F 1) help § Install locations § “Bundle” structure Next: App Submission Processes © 2013 Autodesk Exchange for Revit

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. © 2013 Autodesk, Inc. All rights reserved.