オートデスク デベロッパーネットワーク(ADN)

Autodesk App ストア - Autodesk Revit デベロッパ向けの情報

このドキュメントは、無償、試用版、又は有償版のプラグインやその他のコンテンツを Autodesk App ストアに出品する開発者やコンテンツ プロバイダーを対象にしています。Autodesk App ストアに出品する製品作成において、正しい方法と、そしていくつ満たさなければならない条件について解説します。これらのガイドラインは、Autodesk App ストアのユーザがストアから複数の製品をダウンロードする際に、一貫した手順で購入できる事を目的として用意されたものです。

要件


初めてパブリッシャー(出品者)として登録すると、Autodesk App ストアに出品する際の必要条件に関して説明した詳細な一覧が提示します。以下のその一覧の内容を Autodesk Revit に特化して要約するものです。

全てのコンテンツの種類
必要となる情報のほとんどは、コンテンツを提出する際に作成して頂く提出フォーム経由で収集することができます。これには、ダウンロードされる御社製品に含まれる HTML ページを自動生成するための情報も含まれています。また、その情報はオンラインで表示させることもできます。その他の条件は次のとおりです。

  • 互換性製品は Autodesk® Revit® 2018 ソフトウェアに関連する製品(あるいは一緒に使用可能)である必要があります。また、Revit® 2018 製品がサポートする Windows オペレーティングシステム上で実行可能である必要があります。Revit 2017/2016/2015 との互換性を示すこともできます。御社製品が、Revit 2016/2015 ベースの業種別製品(Autodesk® Revit®、Autodesk® Revit® Architecture、Autodesk® Revit® Structure、Autodesk® Revit® MEP)との互換性を示す場合には、それら製品とのテストを実施する責務があります。もし、すべての Revit ベース製品と互換性がない場合には、製品の提出時に、どの Revit ベース製品と互換性があるかをご指定ください。
  • HTML ヘルプ ページ製品を提出する際にご提供いただくドキュメントの情報は、ユーザが製品をどのように使用するか簡単に理解するための標準フォーマットの HTML ページを自動的に生成する目的で使用されます。なお、この標準 HTML ファイルから、追加情報を参照することも可能です。例えば、Web サイトにポストされている追加のヘルプファイルへのリンクなどが該当します。
  • ユーザ権限ストア アプリの既定のユーザ権限は、Windows 7/8/8.1/10 の管理者ユーザです。オートデスクの標準インストーラ テンプレートを使用しない場合や、インストーラや製品がユーザ権限の昇格を必要とする場合には、ストア上に表示される製品の説明の中で、その点を明記していただく必要があります。
  • すぐに利用可能製品は、インストールしてすぐに利用可能な状態になる必要があります。ユーザにマニュアル操作でファイルをコピーさせたり、Revit のサポート パスを設定させたりしてはいけません。
  • ライセンス:ライセンス システムを使用する場合には、ユーザによるインストール後に、すぐに製品の実行を許可する必要があります。これは、アプリケーションがインスタント アクティベーションをおこなうか(例、オンライン アクティベーション)、猶予期限を迎える前に、アクティベーション作業に十分な “猶予期間” を設定し、その間、完全に機能するようにするかを意味します。
  • 製品安定性:製品は安定して動作しなければなりません。Revit 上で不適切と思われるような振る舞いを起こしてはなりません。例えば、Revit の標準機能の阻害や他のプラグインの機能の妨害、データ損失を発生させる、などの動作が含まれます。

プラグイン
プラグイン(アドオン)製品の必要条件:

  • ロード メカニズムとして アドイン マニフェスト を使用しなければなりません。
  • プラグインは、メイン コマンドにアクセスする リボン ボタン を含む必要があります。アプリケーションが多くのボタンを持つ場合には、カスタム リボン タブを分離する選択も可能です。

ファミリ ライブラリ
ファミリ ライブラリの必要条件:

  • ファミリ ライブラリは、Revit リボンバーへのリボン ボタンを含めなければなりません。リボンバー UI は、ファミリ ライブラリにアクセスするか、どうアクセスするかを説明するヘルプファイルを起動するか、いずれかである必要があります。
  • ファミリ ライブラリ(rfa ファイル形式内)は、次のフォルダにインストールされる必要があります。

Windows 7 (Revit 2015/2016)/Windows 8/ (Revit 2015/2016 64-bit のみ)/Windows 8.1 (Revit 2015/2016 64-bit のみ)/Windows 10 (2017/2018 64-bit のみ):
%PUBLIC%\Documents\Autodesk\Downloaded Content
(通常は C:\Users\Public\Documents\Autodesk\Downloaded Content)

注意:これは、他のオートデスク製品と一貫させることを目的としています。 - 製品間で繰り返されるユーザ エクスペリエンスのため(例えば、Suite 製品内での製品使用)。

オートデスクは、インストーラを作成したり、新しい場所でライブラリが動作するように編集するサポートをすることもできます。

スタンドアロン アプリケーションと他のコンテンツ
Revit に統合されない製品に関しては、追加の必要条件はありません。電子書籍、ビデオ チュートリアル、産業に特化した計算ソフトウェア、クラウド ベース サービスへの接続などがこれに該当します。

ガイドライン

バンドルと Revit 2015/2016/2017/2018 プラグイン用のXML ファイルの使用
既定の場所として、アドイン マニフェストの配置場所に全ユーザ(All Users)パスを使用します。:
%programdata%\Autodesk\ApplicationPlugins

プラグイン ファイルは、“<アプリケーション名>.bundle” と呼ばれる特有なフォルダに含まれ、PackageContents.xml ファイル(アプリケーション用にオートデスクが作成した)は、アプリケーションに必要なコンテンツと一緒に .bundle フォルダ内に保存されます。:

PackageContents.xml は、次の XML タグ(インストーラについての情報をコントロールする他のタグの中で)と、御社の .bundle フォルダ内の .addin マニフェストへの位置を含みます。:

<ComponentEntry ModuleName="./Contents/ADNPlugin-FileUpgrader.addin"

Revit 2015/2016/2017/2018 は、.bundle フォルダ中のコンテンツを見て、PackageContents.xml を読み込み、“ModuleName” Revit プラグイン特有の情報を定義する .addin ファイルの場所を参照します。

例えば、Contents フォルダ下に .addin マニフェストとアセンブリ dll を配置した場合には、フォルダ構造は、前述の XML タグのようになります。

どのようにこれが動作するか参照するために、Autodesk App ストア上ですでに利用できる無償のプラグインをダウンロードして、それらのフォーマットから学習することができます。

リボンの使用
アプリケーション用のリボン要素の使用が必要です。ただし、その方法については、プラグインのデザインに依存することになります。最低でも、プラグインやファミリ ライブラリ毎に、プラグインによって定義されるコマンドの呼び出しや、ファミリ ライブラリをどう利用するかを説明するヘルプファイルを表示するパネルを、‘アドイン’ タブに追加しなければなりません。

ただし、プラグインが1つ以上のコマンドを定義する場合には、ユーザにとって最も分かり易い方法でリボン レイアウトを作成しなければなりません(例えば、最も頻繁に使用するコマンドには大きなボタンを配置したり、あまり利用しないコマンドには小さなボタンを配置します)。

  • 1 つのパネルにインストールするプラグインは、通常、‘アドイン’ タブにパネルを追加してください。
  • 複数のリボンバー パネルを作成するプラグインは、そのプラグイン固有の新しいタブの作成を選択することもできます(通常、タブ名はプラグインの名前になります)。

リボン アイテムでのコンテキスト ヘルプ(F1 ヘルプ)の使用
Revit API は、コンテキストまたは F1 ヘルプをサポートします。Revit API ドキュメントで RibbonItem.SetContextualHelp() メソッドと ContextualHelp クラスを参照してください。Autodesk App ストアにポストされている今月のオートデスク プラグイン サンプルは、F1 ヘルプを実装する方法をデモしています。

ツールチップやリボン アイテムに配置されているコンテキスト ヘルプのような、Revit のヘルプ機能と一貫したヘルプ メカニズムの使用をお勧めします。外部 URL へのリンク、ローカルにインストールされたヘルプの起動、オートデスク Wiki ヘルプのトピックへのリンクを含むコンテキスト ヘルプをサポートするオプションもあります。

使用許諾契約(End User License Agreement
ADN チームが御社アプリケーション用に作成するインストーラは、アプリケーションのインストール中に使用許諾契約(EULA)をユーザに表示するボタンを持っています。

注意:この EULA は、修正することはできません。アプリケーションに独自の EULA を含める必要がある場合には、

  1. 標準 HTML ヘルプ ファイル テキストから EULA を参照するか、
  2. アプリケーションを初めて起動した際に EULA を表示するかを実装して、アプリケーションの実行前にユーザに同意を求めることができます。

特別な考慮事項
アプリケーションやコンテンツが特殊な要件を持っていて、標準のインストーラ テンプレートでそれを扱えない場合には、オートデスクにお知らせください。

例えば、アプリケーションが、単一ユーザへの書き込みをする特殊な要件を持っている場合には、オートデスクはカレント ユーザにだけインストールをするインストーラを作成することができます。

カスタム インストールに必要とされるその他の特別な作業が必要な場合には、Windows Installer Merge Modules(.msm)の形式の中で、それらを提供することもできます。オートデスクは、御社アプリケーション用に作成する Windows インストーラ(.msi)ファイルで、その msm ファイルをマージします。そのようなシナリオの例は、アプリケーションが使用するライセンス システム用のレジストリ エントリの書き込み、他のベンダーによるコンポーネントに依存するインストール、カスタム スクリプトの実行、などです。不明な点は、appsubmissions@autodesk.com までお問い合わせください。

ビデオ チュートリアル

次のビデオ シリーズは、Autodesk App ストアに Revit アプリを公開するプロセスを説明、デモするものです。

トピック

長さ(分:秒)形式: ビデオと ppt
(英語)
1. Goals and Agenda1:33Videoppt
2. Store Overview4:19Videoppt
3. Preparing Apps for the Store:Guidelines8:30Videoppt
4. Preparing Publishing Information5:10Videoppt
5. Submission Process9:13Videoppt
6. Publishing Revit 2013 Apps2:37Videoppt
7. FAQ3:49Videoppt
8. Summary1:57Videoppt
9. Multi-Language Considerations6:49Videoppt

その他の情報


ADN チームは、成功裏に Autodesk App ストアのパブリッシャーになるお手伝いをします。もし、ご質問等があれば、appsubmissions@autodesk.com まで電子メールをお送りください。他のドキュメントは、www.autodesk.com/developapps に記載されています。Autodesk App ストアへの参加をご検討いただきまして、誠にありがとうございます。