VB Studioプロジェクトでホストされるコンポーネント交換について

VB Studioプロジェクトでは、セキュアなコンポーネント交換をホストして、インスタンス内の開発者のみが使用できるコンポーネントを格納および配布できます。

各VB Studioプロジェクトには、コンポーネント交換compcatalogが含まれています。compcatalogは、プロジェクトに格納されているコンポーネントへのアクセスに使用されるサービスです。 compcatalogサービスは、デフォルトで各プロジェクトでプロビジョニングされます。ストレージがVB Studioインスタンスに対して有効になっている場合は、任意のプロジェクトを使用して交換をホストできます。コンポーネント開発者はサービスAPIを使用して、交換にコンポーネントを公開できます。

VB Studioプロジェクトのプライベート交換をVisual Builderインスタンスと統合するために、管理者はプロジェクトcompcatalogサービスのURLおよびプロジェクトにアクセスできるユーザーの資格証明を指定します。交換への接続に使用する資格証明は、交換をホストするVB Studioプロジェクトの所有者またはメンバーである必要があります。テナント内のすべての開発者は、これらの資格証明を使用して交換に接続し、プロジェクトで使用するコンポーネントおよびアプリケーション・テンプレートを取得します。

プロジェクト・コンポーネント・カタログ・サービスのURLは、次の形式です。 : https://<hostname>/<org_id>/s/<project_id>/compcatalog/0.2.0/

URLで、"compcatalog"はExchangeサービスで、"0.2.0"はサービスのAPIバージョンです。

compcatalogサービスのURLを決定するには、VB Studioプロジェクトに関する次の詳細を把握する必要があります:

<hostname>。これは、プロジェクトがホストされるVB Studioサーバーです。
<org_id>。これは組織(テナント)名です。
<project_id>。これは、テナントに対して一意のプロジェクト識別子です。これは、プロジェクト所有者が入力したプロジェクト表示名とは異なり、VB Studio UIには表示されません。

交換をホストするプロジェクトの<project_id>が不明な場合は、GitまたはMaven構成から取得するか、VB Studio Projects APIを使用して取得できます。次の表に、<project_id>の入手方法を示します。

メソッドステップ

メソッド	ステップ
GitまたはMaven構成から	VB Studioで、プロジェクトを開き、プロジェクトのホームページでRepositoriesタブを見つけます。 GitまたはMavenセクションを展開し、リポジトリURLをコピーします。 GitリポジトリのURLは、次のようになります : `https://{user_id}@{hostname}/{org_id}/s/my-org_testproject_5/scm/my-repo.git` MavenリポジトリのURLは次のようになります : `http://{hostname}/{org_id}/s/my-org_testproject_5/maven/` これらの例では、"my-org_testproject_5"がプロジェクト識別子です。この場合、'compcatalog'サービスのURLは`https://{hostname}/my-org/s/my-org_testproject_5/compcatalog/0.2.0/`に類似しています。
VB StudioプロジェクトAPIの使用	交換インスタンスを共有するプロジェクトの名前がわかっている場合は、VB Studio APIへのRESTコールを使用してプロジェクト・メタデータを取得できます。たとえば、cURLを使用して、次のようなRESTコールを送信できます: `curl -X GET -u '{username}:{password}'https://{hostname}/{org_id}/api/v2/projects/info/name:TestProject` 戻り値は、次のようになります: `[ { "organization":"my-org", "identifier":"my-org_testproject_5", "name":"TestProject", "urlId":"testproject", "description":null, "accessibility":"PRIVATE", "template":false, "state":"READY", "locked":false, "relation":{"membership":"OWNER","favorite":false} } ]` この例では、戻りの識別子プロパティは、compcatalogサービスURLに必要なプロジェクト識別子です。

GitまたはMaven構成から

VB Studioで、プロジェクトを開き、プロジェクトのホームページでRepositoriesタブを見つけます。
GitまたはMavenセクションを展開し、リポジトリURLをコピーします。

GitリポジトリのURLは、次のようになります : https://{user_id}@{hostname}/{org_id}/s/my-org_testproject_5/scm/my-repo.git

MavenリポジトリのURLは次のようになります : http://{hostname}/{org_id}/s/my-org_testproject_5/maven/

これらの例では、"my-org_testproject_5"がプロジェクト識別子です。この場合、'compcatalog'サービスのURLはhttps://{hostname}/my-org/s/my-org_testproject_5/compcatalog/0.2.0/に類似しています。

VB StudioプロジェクトAPIの使用

交換インスタンスを共有するプロジェクトの名前がわかっている場合は、VB Studio APIへのRESTコールを使用してプロジェクト・メタデータを取得できます。

たとえば、cURLを使用して、次のようなRESTコールを送信できます:

curl -X GET -u '{username}:{password}'https://{hostname}/{org_id}/api/v2/projects/info/name:TestProject

戻り値は、次のようになります:

[
  {
    "organization":"my-org",
    "identifier":"my-org_testproject_5",
    "name":"TestProject",
    "urlId":"testproject",
    "description":null,
    "accessibility":"PRIVATE",
    "template":false,
    "state":"READY",
    "locked":false,
    "relation":{"membership":"OWNER","favorite":false}
  }
]

この例では、戻りの識別子プロパティは、compcatalogサービスURLに必要なプロジェクト識別子です。