HCL Volt MX Go
VMXGo-Dev-100
Lesson 1: Domino REST API
要件情報

DOMINO REST API に関する必要な情報

もくじ
はじめに .......................................................................................................................................... 3
前提条件 .......................................................................................................................................... 4
Lesson 1 - Domino REST API に関する必要な情報 ........................................................................... 5
Appendix I – HCL SoFy ....................................................................................................................... 9
Appendix II – Volt MX Go Get Started .............................................................................................. 14
Appendix III - Domino を初めて使う人のための DRAPI の詳細 .................................................... 21
法的ステートメント ..................................................................................................................... 23
免責事項 ........................................................................................................................................ 24

2© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

はじめに

HCL Volt MX Go VMXGo-DEV-100 トレーニングコースは、現在のリリースである Volt MX Go
v2.0.1 (https://opensource.hcltechsw.com/voltmxgo-documentation/references/whatisnew.html) 以降のHCL Volt MX Go ツールを学ぶための開発者向けスタートコースです。

Volt MX Go の開発者が知っておかなければならない 2 つの主要なツールは、1) DesignImport と 2) VoltFormula です。Design Import は、Volt MX Go Iris（別名 Volt Iris）のプロジ
ェクト、UI、Domino とデータを交換するロジックをゼロから作成する必要がなく、開発者の時間と労力を大幅に削減します。VoltFormula を使用すると、依存する Domino ロジックを HCL Volt MX プロジェクトで使用できるため、JavaScript でロジックを書き直す時間と労力を節約できます。

Design Import は、Domino バージョン 12.0.2 以降でホストされている HCL Domino アプリ

ケーション（Domino REST API、別名 DRAPI に公開済み）を Volt MX Go の Volt Iris プロジ

ェクトと Volt MX Go の Volt Foundry アプリ（Foundry ミドルウェアサービスのコレクション）にインポートします。Design Import の最終的な出力は、Volt Iris Web アプリで、すぐに機能し、完全に開発され、Domino アプリケーションを表すすべての Volt Iris フォームとウィジェットが含まれ、OAuth2 Identity サービス、Integration サービス、Volt MX Go のFoundry Domino アダプターを使用する Object サービスを持つ Foundry アプリに関連付けられています。

Design Import 後における Volt MX Go アプリ開発の一般的な流れは、組織のブランディングや UI 要件に合わせて UI のリブランド/リファクタリングを行い、Domino 文書のリストにソートやフィルタリング機能を追加することです。

この HCL Volt MX Go VMXGo-DEV-100 トレーニングには、上記を扱う 6 つのレッスンが含まれています。レッスンは以下の通りです。

1. Lesson 1 - Domino REST API 必須情報

2. Lesson 2 - Design Import のセットアップ
3. Lesson 3 - Design のインポート
4. Lesson 4 - VoltFormula

5. Lesson 5 - UI のリブランディング

6. Lesson 6 - セグメントのソートとフィルタリング

3© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
このコースでは、HCL Volt MX Go First Touch Recipe Catalog アプリとその資産（DominoDB（レシピ保存用）、First Touch Recipe Domino REST API スキーマ、スコープ、DRAPI アプリ（https://opensource.hcltechsw.com/voltmxgo-documentation/tutorials/firsttouch.html）を含む）を活用します。DRAPI First Touch Recipe アプリで Design Import を実行し、Volt Iris アプリにVoltFormula を追加し、Iris アプリのログイン画面とダッシュボード画面/フォームをリブラン ドし、Iris アプリにソートとフィルタリング機能を追加します。

前提条件

このコースを修了するには、HCL Volt MX Go の Volt Foundry（ミドルウェア）と Volt Iris（IDE）に加え、Domino REST API を含む Domino 環境が必要です。Domino と Volt MX Go

サーバーのオンプレミスインストールの代わりに、HCL SoFy プラットフォーム（https://hclsofy.com）の HCL Volt MX Go サンドボックスを使用できます。HCL SoFy サンドボックスには、Domino、Domino REST API、および Volt MX Go Foundry が含まれます。
SoFy が提供するトライアルサンドボックスを使用するには、付録 I を参照してください。
オンプレミス••••••••HCL Domino server 12.0.2+

HCL Domino REST API (DRAPI) サービス (タスクとサービスが稼動)

HCL Domino REST API Console URL

HCL Domino REST API Admin User Credentials (ユーザーID とパスワード)

HCL Volt MX Go Foundry v2.0.1

HCL Volt MX Go Foundry Console URL

HCL Volt MX Go Foundry Admin User Credentials (ユーザーID とパスワード)

HCL Volt MX Go Iris v2.0.1

HCL SoFy プラットフォーム (https://hclsofy.com)•

HCL Volt MX Go サンドボックス (手順は Appendix I を参照)

4

© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

Lesson 1 - Domino REST API に関する必要な情報

Volt MX Go Design Import を使用して、Domino REST API (DRAPI) にすでに公開されているFirst Touch Recipe Domino アプリのインポートを開始するには、事前に以下の情報が必要です。必要な情報は次のとおりですa) The Domino REST API URL, or DRAPI URL,b) The Domino REST API First Touch Recipe App’s Client ID,c) The Domino REST API First Touch Recipe App’s Client Secret.

d) The Domino REST API First Touch Recipe App’s Scope.

注意：First Touch Recipe アプリが Domino および Volt MX Go 環境でセットアップされていない場合、Volt MX Go の First Touch Get Started プロセスを実行して、First Touch

Recipe Domino DB を Domino REST API サービスに公開する必要があります。これを行わない場合はこのレッスンで必要な情報を取得できません。以下の手順の前に、Domino REST API への手動設定を含む、付録 II - Volt MX Go Get Started の指示に従ってください。

ブラウザで Domino REST API コンソール/管理 UI を起動します。

5© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
1. Domino REST API URL を記録します。

2. 最初のボックスの Configuration をクリックします。次に 3 番目のボックスのApplication Management - OAUTH をクリックすると DRAPI Active Applications がすべて表示されます。

6© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
3. スクロールして First Touch Recipes アプリケーションを探します。

4. ファーストタッチレシピアプリの App ID を記録します。

5. ファーストタッチレシピのシークレットを記録します。

App Secret は App ID のすぐ下にあります。以下の注意は必ず読んでください。App Secretが表示されず、DRAPI アプリのオリジナル作成者からコピーを取得できない場合は、アプリ
ケーショ ンボックスの右上にある 4 つのアイコンのグループの左側にある最初の丸いアイコンをクリックします。

注意：新しい App Secret を生成すると、その App ID や App Secret を使用 している全てのアプリケーションに影響が及びます。すべてのアプリケーションは、OAuth2 アイ
デンティティセットアップで新しい App Secret を使用するように変更する必要があります。もしあなたがこのアプリケーションと統合しているユーザーグループの中にいて、この App ID と App Secret の組み合わせに依存しているのであれば、最初に App7

© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
Secret を生成したこのアプリケーションのオリジネータ/クリエータが DRAPI で既に知っている App Secret を取得するのがベストでしょう。

6. First Touch Recipes のスコープ名を確認するには、右上の鉛筆アイコン（Edit）をクリックします（緑色の四角の中）。アプリケーションの編集画面が表示されます。

7. First Touch Recipes Application のスコープ名を記録し Close をクリックします。

Lesson1 が終了しました。Lesson 2 - Design Import Setup を始める準備ができました。
次のレッスンに進んでください。

8© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

Appendix I – HCL SoFy

以下の手順に従って、HCL SoFy プラットフォームを使用して、Domino、Domino REST

API、および Volt MX Go Foundry を含む HCL Volt MX Go のトライアル環境をデプロイします。

1. 適当な Web ブラウザを開き、https://hclsofy.com、ブラウザ右上の Request
Access をクリックして情報を入力します。

2. 登録後、Login をクリックして認証情報を入力し SoFy にログインします。

3. 検索ボックスに Volt MX Go と入力して Search をクリックします。

4. HCL Volt MX Go Sandbox が表示されます。LAUNCH をクリックします。

5. HCL Volt MX Go サンドボックスは約 10 分でデプロイされます。サンドボックスの概要スナップショットが表示されます。

9© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

6. サンドボックスはデフォルトの有効期限である 6 時間で失効します。この時間を延長する必要があります。この表示の右上にある時計のアイコンをクリックすると、有効期限が延長されます。

7. VIEW SOFY CONSOLE ボタンをクリックします。

8. General Information をクリックすると Volt Foundry と the Domino REST API のコンソールが表示されます。

10© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
9. リンクをクリックすると Volt Foundry コンソールと Domino REST API コンソールが起動します。両方のコンソールに対して認証情報（ユーザー ID とパスワード）が提供されます。

注：この SoFy コンソールの General Information をブックマークしておくと、Foundry と DRAPI の URL とログイン認証情報をコピーする際にすぐに戻ってこられます。

10. 同じ General Information の画面から Volt MX Go Iris IDE をダウンロードできます。
下にスクロールすると Mac 用と MS Windows OS 用の Iris インストーラーのダウンロードが表示されます。

11. HCL Volt MX Go Foundry が 1 つのランタイム環境を持っていることを確認します。
Foundry ランタイム環境とは公開されたサービスが実行される場所です。

•SoFy の General Information 画面から Foundry Home Page → Open Link をクリ•SoFy の General Information 画面に表示されている Foundry のユーザーID とパ•ックします。

スワードを使用してログインします。

Foundry の左ナビゲーションを使用して Environments に移動します。

11© 2023 HCLSoftware

DOMINO REST API に関する必要な情報•

Foundry Environments 画面で、利用可能なランタイム環境が少なくとも 1 つ表示されていれば、ステップ 11 の続きをスキップできます。以下は、環境が 1 つある Foundry の例です。

•No Environments Present（環境が存在しません）というメッセージが表示され•Add a New Environment ポップアップで、環境に名前を付け、Server タブでたら ADD New（新規追加）ボタンをクリックします。

SoFy General Information 画面から Sofy Foundry URL を入力し、Test
Connection をクリックし、Save をクリックします。

12© 2023 HCLSoftware

DOMINO REST API に関する必要な情報•

これで 1 つの Foundry ランタイム環境ができたことになります。

注意：HCL Volt MX Foundry は、複数のランタイム環境を持つことができます。

Foundry Environments（ファウンドリ環境）画面に複数の環境が表示されている場合は、使用するランタイム環境を 1 つ選び、その名前を覚えておくとよいでしょう。Volt
Iris IDE（レッスン 2）で Foundry のランタイム環境を確認するよう求められたら、希望のランタイム環境を選択してください。

サービスの開発中に Foundry サービスのバージョン管理をサポートするために複数の環境を作成する場合、Foundry は複数のランタイム環境を持つことができます。また、開発、単体テスト、統合テスト、QA テストなど、さまざまな開発活動をサポートするために複数の環境を作成することもできます。

これで付録 I のすべての手順を完了しました。レッスン 1 に戻ってください。

13© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

Appendix II – Volt MX Go Get Started

以下の手順で Volt MX Go の First Touch Get Started プロセスを実行し、First Touch Recipe

Domino DB を DRAPI に公開します。プロセスが完了すると、First Touch Recipe DRAPI ス
キーマ、DRAPI スコープ、DRAPI アプリケーショ ンができます。Volt MX Go の Design

Import を実行するにはこれらの DRAPI 資産が必要です。First Touch Get Started プロセスは Volt MX Go Foundry にあります。では、始めましょう。

1. Sofy から提供された Volt MX Go Foundry コンソールを起動するか、独自のローカルデプロイメントから起動し、Volt MX クレデンシャルを使用してログインします。

2. Foundry コンソールの左側のナビゲーションを展開し、Apps をクリックします。

3. We have something new for you! と Volt MX Go | First Touch のバナーが表示されます。バナーの下にある Get Started ボタンをクリックしてください。

4. 要求された情報を入力し next をクリックします。

14© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
5. Domino REST API サーバー URL (SoFy または独自の Domino デプロイメント)、SoFy
DRAPI URL の例は https://drapi.sbx0091.play.hclsofy.com/ です。

6. DRAPI ユーザー名、Sofy DRAPI ユーザー名の例は "mxgo admin" です。
7. DRAPI パスワード

8. First Touch Recipe アプリがインストールされるまで待ちます。

9. First Touch Recipe アプリがインストールされると Congratulations! の画面が表示されます。Cancel ボタンでキャンセルすることもできますし、Launch をクリックして、事前に構築された First Touch Recipe Web アプリを起動することもできます。
この Web アプリは Domino DB にレシピを保存し管理するものです。

注：First Touch Recipe Web アプリは、Volt MX Go の design Import 機能により生成された Volt Iris Web アプリであり、ベース部分に加えて UI にリブランディングとリファクタリングが実施されています。その結果、Domino アプリがモダナイズ、強化されたものの例になっています。

15© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
この First Touch Recipe Web アプリをブックマークしておいてください。この Web アプリを使用して、あなた自身の Volt MX Go Design Import 生成アプリと Domino レシ
ピデータを比較できます。

重要： Volt MX Go の First Touch Get Started プロセスを実行すると、Volt MX Go

Foundry に First Touch Recipes という名前の新しい Foundry アプリが作成されます。
このアプリには、DRAPI に対する 1 つの OAuth2 ID サービスが含まれます。ID サービスは、「First Touch Recipe DRAPI アプリ」の Client Secret (App Secret)を持っています。他の場所でシークレットを取得できない場合は、この OAuth2 アイデンティティサービスから Client Secret/App Secret をコピーできます。以下のスナップショットを参照してください。

16© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
10. 次に、Domino REST API コンソール（別名 DRAPI Admin UI）の a) First Touch

Recipe DRAPI スキーマ、b) DRAPI スコープ、c) DRAPI アプリにいくつかの手動設定を適用する必要があります。

11. ブラウザ（SoFy または独自のもの）で Domino REST API コンソール/管理 UI を起動し、 DRAPI 認証情報を使用してログインします。

12. Configuration ボックスをクリックします。

13. 最初の箱の Database Management – REST API (create/update schema) をクリックします。

17© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
14. First Touch Recipes のスキーマボックスをクリックします。

15. Database Views をクリックします。DRAPI スキーマに Recipe Domino ビュー"($All)" を追加する必要があります。

16. ビューのステータスを非アクティブからアクティブに変更します。右側のラベル"Status"の下にある緑色のボタン "Active"をクリックします。変更したステータスはすぐに保存されます。

17. DRAPI コンソールの左ナビゲーションで Scopes をクリックします (上記参照)。

18. スコープ管理に First Touch Recipes のスコープが表示されます。スコープをクリックします。

18© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
19. DRAPI スコープの Maximum Access Level を Designer に変更し、UPDATE をクリックします。変更はすぐに保存されます。

20. DRAPI 左ナビゲーションを使って Applications に移動します。First Touch Recipe ボックスにマウスカーソルを合わせ、ボックスの上部付近に 4 つのアイコンが表示されるまでクリックします。鉛筆のアイコンをクリックし、First Touch Recipes DRAPIアプリケーションを編集します。

21. DRAPI アプリケーションスコープに$DATA スコープと$SETUP スコープを追加します。スコープのテキストボックスに$DATA と入力し、+ ボタンをクリックします。
$SETUP も同様にします。UPDATE をクリックします。変更はすぐに保存されます。

19© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

22. これで付録Ⅱのすべてのステップが完了しました。レッスン 1 に戻ってください。

20© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

Appendix III - Domino を初めて使う人のための DRAPIの詳細
1. 設計のインポート時に使用するスコープの目的は何ですか？

ここでのスコープは Domino REST API の成果物です。スコープは DRAPI に公開されるDomino DB と結びついています。公開される Domino アプリケーションのすべての側面をスコープがカプセル化します。各データベース単位で以下のものが含まれます。
a. Domino フォーム
b. Domino ビュー

c. Domino エージェント

したがって、このレシピアプリの DRAPI スコープでは、レシピ DB のフォーム、ビュー、エージェントを公開します。

2. firsttouchrecipesscope、$DATA、$SETU の 3 つのスコープの目的は何ですか？

DRAPI スコープは API アクセスが使用するリソースを決定します。詳細は以下のリンクを参照してください。

https://opensource.hcltechsw.com/Domino-restapi/references/usingdominorestapi/scopes.html

firsttouchrecipesscope: 公開された Recipe Domino フォーム、ビュー、およびエージェントをカプセル化$DATA: DRAPI ユーザーがアクセスできるすべてのアプリケーションへのアクセス$SETUP: 書き込み操作を実行するエンドポイントへのアクセス制御
3. クライアント ID とクライアントシークレットの目的は何ですか？

クライアント ID とシークレットは、クライアント（Iris アプリ）が認証されたものであることを確認することで、クライアント（Iris アプリ）と DRAPI 間の統合を安全にします。したがって、Iris アプリは DRAPI とデータを交換する前に、DRAPI アプリから提供されたシークレットを知っておく必要があります。何らかの理由でアプリやハッカーがバックエンドのログイン認証情報を得た場合、ハッカーのアプリは ID とシークレットを提示しない限り、DRAPI とやりとりすることはできません。

4. Design Import 時に使用するサービス名は何のためですか？
21© 2023 HCLSoftware

DOMINO REST API に関する必要な情報
サービス名は、Volt Foundry のサービス（ID サービス、統合サービス、オブジェクトサービス）で識別できるようにする必要があります。サービス名の先頭には "MXGO "が付けられ、この組み合わせが Volt Foundry API レベルの ID、統合、オブジェクトデータモ
デルの名前として設定されます。なお、Iris プロジェクト名は、Foundry サービスではなく、Foundry アプリ名として使用されます。

22© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

法的ステートメント

このエディションは、HCL Volt MX Go のリリース 2.0.1、および新しいエディションで別段の記載がない限り、それ以降のすべてのリリースおよび変更に適用されます。

あなたが HCL Technologies Ltd.に情報を送信する場合、あなたは HCL Technologies Ltd.に、あなたに対していかなる義務を負うことなく、適切と思われる方法で情報を使用または配布する非独占的な権利を付与します。

c2023 Copyright HCL Technologies Ltd and others. 無断複写・転載を禁じます。

米国政府ユーザーへの注意 - 制限された権利に関連する文書 - 使用、複製、または開示は、HCL Technologies Ltd.との GSA ADP スケジュール契約に規定された制限に従うものとします。

23© 2023 HCLSoftware

DOMINO REST API に関する必要な情報

免責事項

本レポートは、HCL 利用規約（https://www.hcl.com/terms-of-use）および以下の免責事項の対象となります：

本レポートに含まれる情報は、情報提供のみを目的としています。本レポートに含まれる情報は、情報提供のみを目的として提供されるものであり、本書に含まれる情報の完全性および正確性を確認するよう努めたが、商品性、非侵害性、特定目的への適合性の黙示保証を含むがこれに限定されない、明示または黙示を問わずいかなる保証もなく、現状のまま提供されるものである。また、本情報は、HCL 社の現在の製品計画および戦略に基づいており、HCL 社により予告なく変更される場合があります。HCL は、本レポートまたはその他の資料の使用またはその他の関連から生じる直接的、間接的、偶発的、結果的、特別またはその他の損害について責任を負わないものとします。本書に含まれるいかなる内容も、HCL 社またはその供給業者やライセンサーによる保証や表明を意図するものではなく、またそのような効果をもたらすものでもありません。

本レポートにおける HCL の製品、プログラム、サービスへの言及は、HCL が事業を展開するすべての国でそれらが利用可能になることを意味するものではありません。本プレゼンテーションで言及されている製品のリリース日や機能は、市場機会やその他の要因に基づき、HCL の独自の裁量で随時変更される可能性があり、将来の製品や機能の提供を約束するものではありません。これらのレポートをサポートするために使用される基礎データベースは、毎週更新されます。この Web ツールを使用して生成されたレポートと他のHCL ドキュメンテーションソースの間に見られる不一致は、このツールと他のソースの公開および更新サイクルが異なることに起因する場合も、そうでない場合もあります。本レ
ポートに含まれるいかなる内容も、あなたが行った活動が特定の売上、収益の増加、節約、またはその他の結果をもたらすことを意図したものではなく、またそのような効果を持つものでもありません。利用者は、本レポートの結果として利用者が得た結果または利用者が行った決定について、単独で責任を負うものとします。HCL 利用規約

(https://www.hcl.com/terms-of-use)にかかわらず、本サイトの利用者は、本ツールから生成されたレポートを利用者自身の内部業務目的のためにコピーおよび保存することが許可されています。それ以外の使用は許可されません。

24© 2023 HCLSoftware