WebOTX Manual V10.3 (第4版) 目次を表示

---

2. ポータル

本章では、WebOTX Portalで使用する運用管理機能について説明します。

2.1. 運用管理コマンド

ここでは、otxadminコマンドを使用したポータルリソース操作のコマンドについて説明します。

2.1.1. ポータルサイト作成

ポータルサイトを作成するために以下のcreate-portal-siteコマンドを実行します。ポータルサイトを作成するには、コマンドのオプションを指定することで一つずつポータルサイトを作成する手順と、CSVファイルを使用し、一括でポータルサイトを作成する手順のいずれかの方法で行うことができます。

• オプションを指定してポータルサイトを作成する場合
• CSVファイルを使用してポータルサイトを作成する場合

2.1.1.1. ポータルサイトをオプション指定で作成する場合

1. 以下のコマンドを実行し、WebOTX Portalが動作しているドメインにログインします。

   otxadmin > login --user <管理ユーザ名> --password <管理ユーザパスワード> --port <管理ポート番号>
   

2. create-portal-siteコマンドを実行し、ポータルサイトの作成を行います。
   
   シングルテナントの場合(一般サイト)

   otxadmin > create-portal-site --ownerId <オーナID> --ownerType <オーナのタイプ> --siteId <サイトID> --authorId <サイト作成者のID>
   

   シングルテナントの場合(会社管理者サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --admin=true
   

   シングルテナントの場合(ログイン前サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --anonymous=true
   

   シングルテナント(共通サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --shared=true
   

   マルチテナントの場合(一般サイト)

   otxadmin > create-portal-site --ownerId <オーナID> --ownerType <オーナのタイプ> --siteId <サイトID> --authorId <サイト作成者のID> --companyId <会社ID>
   

   マルチテナントの場合(会社管理者サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --companyId <会社ID> --admin=true
   

   マルチテナントの場合(ログイン前サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --companyId <会社ID> --anonymous=true
   

   マルチテナントの場合(共通サイト)

   otxadmin > create-portal-site --siteId <サイトID> --authorId <サイト作成者のID> --companyId <会社ID> --shared=true
   

   create-portal-siteコマンドで指定できるオプションは以下の通りです。

   オプション名	説明	必須項目
   ownerId	作成するポータルサイトのオーナのIDを指定します。ここで指定するオーナのIDはユーザリソースのディレクトリサーバ(EDS)にあらかじめ登録されている必要があります。 指定できる文字数は32文字までです。33文字以上のIDは指定できません。ディレクトリサーバ(EDS)上に33文字以上のIDが登録されている場合は、ディレクトリサーバ(EDS)に定義されているユーザリソースのIDを見直してください。 会社管理者サイトを作成する場合は、本オプションを指定する必要はありません。	△
   ownerType	作成するポータルサイトのオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。 会社管理者サイトを作成する場合は、本オプションを指定する必要はありません。	△
   authorId	ポータルサイトを作成するユーザのIDを指定します。ここで指定するIDはユーザリソースのディレクトリサーバ(EDS)に登録されているユーザのIDを指定する必要があります。指定できる文字数は64文字までです。	○
   siteId	作成するポータルサイトのIDを指定します。指定できる文字列長は、36文字です。サイトIDに使用できない値は以下の表の通りです。	○
   description	作成するポータルサイトの説明を指定します。指定できる文字数は255文字までです。2バイト文字も使用可能です。	×
   lang	descriptionオプションに指定した説明の言語を選択します。指定可能な値はja(日本語)、en(英語)となります。	×
   themeId	サイトのテーマのIDを指定します。存在しないテーマIDを指定した場合や本オプションを指定しない場合は、「既定」のテーマが使用されます。	×
   admin	会社管理者サイトを作成する場合に指定します。デフォルト値はfalseです。	×
   anonymous	ログイン前サイトを作成する場合に指定します。デフォルト値はfalseです。	×
   shared	共通サイトを作成する場合に指定します。デフォルト値はfalseです。	×
   companyId	マルチテナント時にサイトを作成する会社IDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。	△

• 例：シングルテナント環境でユーザ(ID:00001)のサイトを作成する場合
  

  otxadmin > create-portal-site --ownerId 00001 --ownerType USER --siteId site00001 --authorId 00001
  

• 例：シングルテナント環境でグループ/組織(ID:SOUMU)のサイトを作成する場合
  

  otxadmin > create-portal-site --ownerId SOUMU --ownerType GROUP --siteId siteSOUMU --authorId 00001
  

• 例：シングルテナント環境で管理者のサイトを作成する場合
  

  otxadmin > create-portal-site --siteId siteAdmin --authorId 00001 --admin=true
  

• 例：シングルテナント環境でログイン前サイトを作成する場合
  

  otxadmin > create-portal-site --siteId siteAnonymous --authorId 00001 --anonymous=true
  

• 例：シングルテナント環境で共通サイトを作成する場合
  

  otxadmin > create-portal-site --siteId siteShared --authorId 00001 --shard=true
  

• 例：マルチテナント環境で会社NECに所属するユーザ(ID:00001)のサイトを作成する場合
  

  otxadmin > create-portal-site --ownerId 00001 --ownerType USER --siteId siteNEC00001 --authorId 00001 --companyId NEC
  

• 例：マルチテナント環境で会社NECのグループ/組織(ID:SOUMU)のサイトを作成する場合
  

  otxadmin > create-portal-site --ownerId SOUMU --ownerType GROUP --siteId siteNECSOUMU --authorId 00001 --companyId NEC
  

• 例：マルチテナント環境で会社NECの管理者のサイトを作成する場合
  

  otxadmin > create-portal-site --siteId siteNECAdmin --authorId 00001 --companyId NEC --admin=true
  

• 例：マルチテナント環境で会社NECのログイン前サイトを作成する場合
  

  otxadmin > create-portal-site --siteId siteNECAnonymous --authorId 00001 --companyId NEC --anonymous=true
  

• 例：マルチテナント環境で共通サイトを作成する場合(サイト作成者がNECに所属している場合)
  

  otxadmin > create-portal-site --siteId siteShared --authorId 00001 --companyId NEC --shared=true
  

Caution
filepathオプションを指定しない場合は、必ずowenrId,ownerType,siteId,authorIdオプションを指定する必要があります。
1ユーザ、1グループ/組織が持てるポータルサイトは最大で一つまでです。
siteIdに使用できない文字の一覧は以下の通りです。

2.1.1.2. CSVファイルを使用してポータルサイトを一括で作成する場合

1. ポータルサイト作成に使用するCSVファイルを作成します。CSVファイルの一行目には以下の項目を記載します。二行目以降に作成するポータルサイトのオーナやサイトのIDを定義します。
   

   項目名	説明
   ownerId	siteIdで指定するサイトのオーナのIDを指定します。定義できる最大文字列長は32文字です。ownerIdの列で重複した値定義することはできません。重複した値が定義されている場合はエラーとなります。また、空文字を定義することはできません。
   ownerType	作成するポータルサイトのオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。
   siteId	作成するポータルサイトのIDを指定します。定義できる最大文字列長は36文字です。siteIdの列で重複した値を定義することはできません。定義した場合エラーとなります。また、空文字を定義することはできません。siteIdに使用できない文字はこちらを参照ください
   description	サイトの説明を定義することができます。定義できる最大文字数は0〜255文字です。本項目は任意項目です。2バイト文字も指定可能です
   themeId	サイトのテーマのIDを指定します。存在しないテーマIDを指定した場合や本項目を指定しない場合は、「既定」のテーマが使用されます。本項目は任意項目です。

   例えば、以下のように定義することができます。実際のサンプルはこちらで確認することができます。

   1行目	ownerId	ownerType	siteId
   2行目	00001	USER	site00001
   3行目	00002	USER	site00002
   4行目	00003	USER	site00003
   5行目	NEC	GROUP	NEC

2. create-portal-siteコマンドを実行し、ポータルサイトの作成を行います。
   シングルテナントの場合

   otxadmin > create-portal-site --filepath <手順1で作成したCSVファイルへのパス> --authorId <サイト作成者のID>
   

   マルチテナントの場合

   otxadmin > create-portal-site --filepath <手順1で作成したCSVファイルへのパス> --authorId <サイト作成者のID> --companyId <会社ID>
   

   CSVファイルを使用したポータルサイト作成時に指定可能なオプションは以下の通りです。

   オプション名	説明	必須項目
   authorId	作成するポータルサイトを作成するユーザのIDを指定します。ここで指定するIDはユーザリソースのディレクトリサーバ(EDS)に登録されているユーザのIDを指定する必要があります。指定できる文字数は64文字までです	○
   filepath	手順の1で作成したCSVファイルへのパスを指定します。	○
   lang	description項目で指定した説明の言語を指定します。指定可能な値はja(日本語)、en(英語)となります。	×
   companyId	マルチテナント時にサイトを作成する会社IDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。	△

Caution
本コマンド実行にfilepathオプションを指定した場合、同時に指定できるオプションはauthorIdのみです。
CSVファイルを使用して一括作成できるポータルサイトの数は1000までとなっています。
1ユーザ、1グループ/組織が持てるポータルサイトは最大で一つまでです。

2.1.2. ポータルサイト削除

1. delete-portal-siteコマンドを実行し、ポータルサイトの削除を行います。
   
   シングルテナントの場合(一般サイト)

   otxadmin > delete-portal-site --ownerId <オーナID> --ownerType <オーナのタイプ> --siteId <サイトID>
   

   シングルテナントの場合(管理者サイト・ログイン前サイト・共通サイト)

   otxadmin > delete-portal-site --siteId <サイトID>
   

   マルチテナントの場合(一般サイト)

   otxadmin > delete-portal-site --ownerId <オーナID> --ownerType <オーナのタイプ> --siteId <サイトID> --companyId <会社ID>
   

   マルチテナントの場合(管理者サイト・ログイン前サイト)

   otxadmin > delete-portal-site --siteId <サイトID> --companyId <会社ID>
   

   マルチテナントの場合(共通サイト)

   otxadmin > delete-portal-site --siteId <サイトID>
   

   オプション名	説明	必須項目
   ownerId	削除するポータルサイトのオーナのIDを指定します。管理者サイトを削除する場合は指定する必要はありません。	△
   ownerType	削除するポータルサイトのオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。管理者サイトを削除する場合は指定する必要はありません。	△
   siteId	削除するポータルサイトのIDを指定します。	○
   companyId	マルチテナント時にサイトを削除する会社IDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。	△

Caution
delete-portal-siteコマンドで指定するownerIdとownerType、siteIdの組み合わせが正しくない場合はサイトの削除に失敗します。例えば、siteIdは正しい値を指定しているが、ownerIdが間違っている場合は削除に失敗します。

2.1.3. ポータルサイト更新

1. update-portal-siteコマンドを実行し、ポータルサイトの削除を行います。
   
   シングルテナントの場合

   otxadmin > update-portal-site --siteId <更新を行うサイトID> --ownerId <新しいオーナID> --ownerType <新しいオーナのタイプ> --siteName <新しいサイトのタイトル>
   

   マルチテナントの場合

   otxadmin > update-portal-site --siteId <更新を行うサイトID> --ownerId <新しいオーナID> --ownerType <新しいオーナのタイプ> --siteName <新しいサイトのタイトル> --companyId <新しいオーナが所属する会社ID>
   

   オプション名	説明	必須項目
   siteId	更新を行うポータルサイトのサイトIDを指定します。	○
   ownerId	siteIdで指定したサイトの新しいオーナのIDを指定します。ここで指定するオーナのIDはユーザリソースのディレクトリサーバ(EDS)にあらかじめ登録されている必要があります。指定できる文字数は32文字までです。33文字以上のIDは指定できません。ディレクトリサーバ上に33文字以上のIDが登録されている場合は、ディレクトリサーバ(EDS)に登録されているユーザリソースのIDを見直してください。	×
   ownerType	更新するポータルサイトの新しいオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。	×
   siteName	更新するポータルサイトのタイトルを変更します。ポータルサイトのタイトルの長さは最大255文字までです。	×
   lang	更新するポータルサイトのタイトルの言語指定します。指定可能な値はja(日本語)、en(英語)となります。	×
   companyId	マルチテナント環境でかつ、サイトのオーナを変更する場合に新しいサイトのオーナが所属する会社のIDを指定する	×

Caution
ownerIdを指定する場合は、必ずownerType指定してください。

2.1.4. ポータルサイトの確認

1. list-portal-siteコマンドを実行し、指定したユーザリソースがオーナとなっているポータルサイトの一覧を表示します。
   
   シングルテナントの場合

   otxadmin > list-portal-site --ownerId <サイトオーナID> --ownerType <オーナのタイプ>
   

   マルチテナントの場合

   otxadmin > list-portal-site --ownerId <サイトオーナID> --ownerType <オーナのタイプ> --companyId <オーナが所属する会社ID> 
   

   管理者サイト・ログイン前サイトを確認する場合

   otxadmin > list-portal-site --ownerId <会社ID> --ownerType COMPANY 
   

   オプション名	説明	必須項目
   ownerId	ユーザリソースのIDを指定します。本オプションで指定したユーザリソースがオーナとなっているサイトのIDを確認できます	○
   ownerType	ownerIdオプションで指定したユーザリソースのタイプを指定します。指定できる値はUSER、GROUPまたはCOMPANYです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。管理者サイトのIDを確認する場合はCOMPANYを指定してください。	○
   companyId	マルチテナント時にサイトのオーナが所属する会社のIDを指定します。シングルテナント時は指定する必要はありません。	△

2.1.5. ポータルサイトのコピー

1. copy-portal-siteコマンドを実行し、指定したサイトと同一構成のサイトを新規に作成することができます。
   
   シングルテナントの場合

   otxadmin > copy-portal-site --srcSiteId <コピー元のサイトID> --destSiteId <コピー先のサイトID> --ownerId <コピー先サイトのオーナID> --ownerType <コピー先サイトのオーナのタイプ> --authorId <コピー先サイトの作成者ID>
   

   マルチテナントの場合

   otxadmin > copy-portal-site --srcSiteId <コピー元のサイトID> --destSiteId <コピー先のサイトID> --ownerId <コピー先サイトのオーナID> --ownerType <コピー先サイトのオーナのタイプ> --authorId <コピー先サイトの作成者ID> --companyId <オーナが所属する会社ID>
   

   オプション名	説明	必須項目
   srcSiteId	コピー元のサイトIDを指定します。存在しないサイトを指定した場合はエラーとなります。また、本オプションに指定できるサイトの種類は、一般サイト、共通サイトです。会社管理者サイト、ログイン前サイトを指定することはできません。	○
   destSiteId	コピー先のサイトIDを指定します。すでに存在するサイトIDを指定することはできます。	○
   ownerId	ユーザリソースのIDを指定します。本オプションで指定したユーザリソースがコピー先サイトのオーナとなります。	○
   ownerType	ownerIdオプションで指定したユーザリソースのタイプを指定します。指定できる値はUSER、GROUPです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。	○
   authorId	コピー先のサイトの作成者のIDを指定します。	○
   companyId	マルチテナント時にサイトのオーナが所属する会社のIDを指定します。シングルテナント時は指定する必要はありません。	△
   siteName	コピー元とコピー先のサイト名を変更する場合に指定します。以下のように言語ごとに指定可能です。 ja=サイト1:en=site1	×
   accessControl	コピー元サイトのアクセス権をコピー先サイトに引き継ぐ場合に指定します。テナントをまたいでコピーする場合、共通サイトをコピーする場合は本オプションにtrueを指定することはできません。	×
   userPreference	コピー元サイトに登録されているポートレットの個人設定を引き継ぐか指定します。	×
   force	コピー元サイトが編集モードの場合でもサイトコピーを実行するか指定します。コピー元サイトが編集モード時かつ、本オプションを指定しない場合はサイトコピーに失敗します。	×

2.1.6. ユーザリソース整合性確認

1. directory-matchingコマンドを使用することで、オーナがユーザリソースのディレクトリサーバ(EDS)上に登録されていないサイトIDの一覧がコマンド上に表示されます。
   
   シングルテナントの場合

   otxadmin > directory-matching
   

   マルチテナントの場合

   otxadmin > directory-matching --companyId <整合性確認を実施する会社のID>
   

2. directory-matchingコマンドの実行結果の例は以下のようになります。

   サイトID	オーナID	オーナタイプ
   site00000	00000	USER
   site00001	00001	USER
   site00002	00002	USER
   site00003	00003	USER
   site00004	00004	USER

2.1.7. ユーザリソース削除通知

• 一件ごとにユーザリソース削除通知を行う場合
• CSVファイルを使用してユーザリソース削除通知を行う場合

2.1.7.1. 一件ごとにユーザリソース削除通知を行う場合

1. notify-delete-user-resourceコマンドのownerId,ownerTypeオプションを指定して削除したユーザリソース情報を指定します。
   
   シングルテナントの場合

   otxadmin > notify-delete-user-resource --onwerId <ディレクトリサーバから削除したユーザリソースID> --ownerType <削除したユーザリソースのタイプ>
   

   マルチテナントの場合

   otxadmin > notify-delete-user-resource --onwerId <ディレクトリサーバから削除したユーザリソースID> --ownerType <削除したユーザリソースのタイプ> --companyId <削除したユーザリソースが所属していた会社のID>
   

   オプション名	説明	必須項目
   ownerId	ディレクトリサーバ(EDS)から削除されたユーザリソースのIDを指定します。	○
   ownerType	ディレクトリサーバ(EDS)上から削除されたユーザリソースのタイプを指定します。指定可能な値はUSER、GROUP、ROLEのみです。	○
   portalSiteDelete	ディレクトリサーバ(EDS)上から削除されたユーザリソースがポータルサイトのオーナの場合、そのポータルサイトの削除を行う。(規定値:true)	×
   companyId	ディレクトリサーバ(EDS)上から削除されたユーザリソースが存在していた会社のIDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。	△

Caution
ownerIdオプションを指定した場合、必ずownerTypeオプションも同時に指定しなければなりません。filepathオプションと同時に指定することはできません。

2.1.7.2. CSVファイルを使用してユーザリソース削除通知を行う場合

1. CSVファイルを使用してユーザリソースのディレクトリサーバ(EDS)からユーザ、グループ/組織、ロール情報の削除を行う
2. notify-delete-user-resourceコマンドのfilepathオプションを指定して１で使用したCSVファイルへのパスを指定します。
   
   シングルテナントの場合

   otxadmin > notify-delete-user-resource --filepath <1で使用したCSVファイルへのパス>
   

   マルチテナントの場合

   otxadmin > notify-delete-user-resource --filepath <1で使用したCSVファイルへのパス> --companyId <削除したユーザリソースが所属していた会社のID>
   

   オプション名	説明	必須項目
   filepath	ディレクトリサーバ(EDS)からユーザリソース情報の削除に使用したCSVファイルへのパスを指定します。	○
   portalSiteDelete	ディレクトリサーバ(EDS)上から削除されたユーザリソースがポータルサイトのオーナの場合、そのポータルサイトの削除を行う。(規定値:true)	×
   companyId	ディレクトリサーバ(EDS)上から削除されたユーザリソースが存在していた会社のIDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。	△

Caution
本コマンドの実行にfilepathオプションを指定した場合は同時にonwerId、ownerTypeオプションを指定することはできません

2.1.8. 基本ポートレットアクセス付与

1. add-fundamental-portlet-permissionコマンドを実行し、指定したユーザリソースに対して基本ポートレットの公開を行います。
   
   シングルテナントの場合

   otxadmin > add-fundamental-portlet-permission --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名>
   

   マルチテナントの場合

   otxadmin > add-fundamental-portlet-permission --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名> --companyId <ユーザリソースが所属する会社ID>
   

   オプション名	説明	必須項目
   subjectId	アクセス権を付与する対象となるユーザリソースのIDを指定してください。シングルテナントで全員を指定する場合はALL_USERSを指定してください。マルチテナント環境ではALL_USERSは使用できません。	○
   subjectType	subjectIdに指定したユーザリソースの種別。指定可能な文字列は、USER、GROUP、ROLE、COMPANY、ALL_USERSです。subjectIdにALL_USERを指定した場合はALL_USERを指定してください。	○
   targetRange	subjectTypeにGROUPを指定した場合の直下(direct)・配下(includeSub)を指定する。デフォルトは直下となります。	×
   limitRankRange	職位の範囲を指定します。公開する範囲の下限値と上限値をハイフンでつないで指定します。下限のみを指定する場合は、[下限値-]と指定し、上限値のみを指定する場合は[-上限値]と指定してください。	×
   portletApplicationName	アクセス権を付与する基本ポートレットが含まれるアプリケーション(warファイル)名を指定してください。	○
   companyId	subjectIdに指定したユーザリソースが所属する会社のIDを指定します。subjectTypeにCOMPANYを指定した場合やシングルテナント環境では指定する必要はありません。	△

   オペランド	アクセス権を付与する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

2.1.9. 基本ポートレットアクセス権削除

1. delete-fundamental-portlet-permissionコマンドを実行し、指定したユーザリソースに対して付与された基本ポートレットのアクセス権を削除します。
   
   シングルテナントの場合

   otxadmin > delete-fundamental-portlet-permission --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名>
   

   マルチテナントの場合

   otxadmin > delete-fundamental-portlet-permission --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名> --companyId <ユーザリソースが所属する会社ID>
   

   オプション名	説明	必須項目
   subjectId	アクセス権を削除する対象となるユーザリソースのIDを指定してください。	○
   subjectType	subjectIdに指定したユーザリソースの種別。指定可能な文字列は、USER、GROUP、ROLE、COMPANY、ALL_USERSです。	○
   portletApplicationName	アクセス権を削除する基本ポートレットが含まれるアプリケーション(warファイル)名を指定してください。	○
   companyId	subjectIdに指定したユーザリソースが所属する会社のIDを指定します。subjectTypeにCOMPANYを指定した場合やシングルテナント環境では指定する必要はありません。	△

   オペランド	アクセス権を削除する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

2.1.10. 基本ポートレットアクセス権確認

1. list-fundamental-portlet-permissionコマンドを実行し、指定したユーザリソースに対して付与された基本ポートレットのアクセス権を確認します。
   
   

   otxadmin > list-fundamental-portlet-permission --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名>
   

   オプション名	説明	必須項目
   portletApplicationName	アクセス権を確認する基本ポートレットが含まれるアプリケーション(warファイル)名を指定してください。	○

   オペランド	アクセス権を確認する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

2.1.11. サイトアクセス権一括付与

1. add-access-controlコマンドを実行し、指定したサイト配下に登録されたポータルリソース(ページ、ポートレット)に対して一括して同じアクセス件の付与を行います。
   
   シングルテナントの場合

   otxadmin > add-access-control --siteId <サイトID> --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> <付与するアクセス権>
   

   マルチテナントの場合

   otxadmin > add-access-control --siteId <サイトID> --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --companyId <ユーザリソースが所属する会社ID> <付与するアクセス権>
   

   オプション名	説明	必須項目
   siteId	アクセス権を付与するサイトのIDを指定してください。	○
   subjectId	アクセス権を付与する対象となるユーザリソースのIDを指定してください。シングルテナントで全員を指定する場合はALL_USERSを指定してください。マルチテナント環境ではALL_USERSは使用できません。	○
   subjectType	subjectIdに指定したユーザリソースの種別。指定可能な文字列は、USER、GROUP、ROLE、COMPANY、ALL_USERSです。subjectIdにALL_USERを指定した場合はALL_USERを指定してください。	○
   targetRange	subjectTypeにGROUPを指定した場合の直下(direct)・配下(includeSub)を指定する。デフォルトは直下となります。	×
   limitRankRange	職位の範囲を指定します。公開する範囲の下限値と上限値をハイフンでつないで指定します。下限のみを指定する場合は、[下限値-]と指定し、上限値のみを指定する場合は[-上限値]と指定してください。	×
   companyId	subjectIdに指定したユーザリソースが所属する会社のIDを指定します。subjectTypeにCOMPANYを指定した場合やシングルテナント環境では指定する必要はありません。	△

   オペランド	付与するアクセス権を指定してください。指定可能なアクセス権は以下のとおりです。 参照権：VIEW 引用権：QUOTE コピー権：COPY 個人設定権：EDIT 複数のアクセス権を同時に付与する場合はコロン(:)区切りで指定してください。 例：VIEW:QUOTE:COPY:EDIT

2.1.12. サイトアクセス権一括削除

1. delete-access-controlコマンドを実行し、指定したサイト配下に登録されたポータルリソース(ページ、ポートレット)に対して一括して同じアクセス権の削除を行います。
   
   シングルテナントの場合

   otxadmin > delete-access-control --siteId <サイトID> --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> <付与するアクセス権>
   

   マルチテナントの場合

   otxadmin > delete-access-control --siteId <サイトID> --subjectId <ユーザリソースID> --subjectType <subjectIdに指定したユーザリソースのタイプ> --companyId <ユーザリソースが所属する会社ID> <付与するアクセス権>
   

   オプション名	説明	必須項目
   siteId	アクセス権を削除するサイトのIDを指定してください。	○
   subjectId	アクセス権を削除する対象となるユーザリソースのIDを指定してください。シングルテナントで全員を指定する場合はALL_USERSを指定してください。マルチテナント環境ではALL_USERSは使用できません。	○
   subjectType	subjectIdに指定したユーザリソースの種別。指定可能な文字列は、USER、GROUP、ROLE、COMPANY、ALL_USERSです。subjectIdにALL_USERを指定した場合はALL_USERを指定してください。	○
   companyId	subjectIdに指定したユーザリソースが所属する会社のIDを指定します。subjectTypeにCOMPANYを指定した場合やシングルテナント環境では指定する必要はありません。	△

   オペランド	削除するアクセス権を指定してください。指定可能なアクセス権は以下のとおりです。 参照権：VIEW 引用権：QUOTE コピー権：COPY 個人設定権：EDIT 複数のアクセス権を同時に付与する場合はコロン(:)区切りで指定してください。 例：VIEW:QUOTE:COPY:EDIT

2.1.13. 認証連携Webアプリケーション登録

1. WebOTX Portal と認証連携を行う Webアプリケーションを登録する場合、add-authentication-serviceコマンドを使用します。
   
   シングルテナントの場合

   otxadmin > add-authentication-service --serviceId <サービスID> --serviceName <en=サービス名(英語):ja=サービス名(日本語)> --hostName <ホスト名(IPアドレス)> --portNumber <ポート番号> --authenticationItems <パラメータ名1=パラメータ値1:パラメータ2=パラメータ値2:...> --authenticationURL <認証URL> --authenticationType <GET or POST> --availableOfficeIds <利用可能な組織ID>
   

   マルチテナントの場合

   otxadmin > add-authentication-service --serviceId <サービスID> --serviceName <en=サービス名(英語):ja=サービス名(日本語)> --hostName <ホスト名(IPアドレス)> --portNumber <ポート番号> --authenticationItems <パラメータ名1=パラメータ値1:パラメータ2=パラメータ値2:...> --authenticationURL <認証URL> --authenticationType <GET or POST> --availableOfficeIds <利用可能な組織ID> --companyId <会社ID>
   

   オプション名	説明	必須項目
   serviceId	サービスID 登録する連携対象Webアプリケーションの識別子を指定します。 アプリケーション毎に重複しない名前を指定してください。	○
   serviceName	サービス名 登録する連携対象Webアプリケーションの名前を指定します。 記述方法は言語名=サービス名になります。複数設定する場合はコロン(:)区切りで指定します。 (例：--serviceName en=Name:ja=名前) 同じキー名(言語)がされた場合は、後に定義された方が有効になります。	○
   hostName	ホスト名 登録する連携対象Webアプリケーションが配備されたWeb/APサーバのホスト名(IPアドレス)を指定します。 通常利用では指定する必要はありません。	×
   portNumber	ポート番号 登録する連携対象Webアプリケーションが配備されたWeb/APサーバのバインドポート番号を指定します。 通常利用では指定する必要はありません。	×
   authenticationItems	認証用パラメータ アプリケーションが認証時に必要とするパラメータ名とパラメータ値を、 名前=値 の形式で指定します。 パラメータ名・パラメータ値には1バイト文字のみを指定してください。 パラメータ名・パラメータ値に英数字以外の文字や日本語・特殊文字が含まれる場合は、 パラメータ名・パラメータ値をURLエンコードしてください。 たとえば、パラメータ名が name1 で、 パラメータ値として abc:xyz という文字列を指定したい場合、パラメータ値のカンマ ':' (0x3a) をURLエンコードして、name1=abc%3Axyz と書く必要があります。 パラメータが複数ある場合には、1バイト文字のカンマ ':' (0x3a) で区切ります。同一名称のパラメータを複数設定することはできません。 パラメータ値として以下の文字列を指定した場合は、 現在ポータルにログインしているユーザ情報に置換されます。 <USERID>: ポータルにログインしているユーザのユーザＩＤに置換 <PASSWORD>: ポータルにログインしているユーザのパスワードに置換 (*1) <NEXTURL>: serviceURLで指定した実行用ページのURLに置換 <USERNAME>: ポータルにログインしているユーザの氏名に置換 <GROUPID>: ポータルにログインしているユーザの所属番号に置換 <GROUPNAME>: ポータルにログインしているユーザの所属名に置換 <POSITIONID>: ポータルにログインしているユーザの役職番号に置換 <POSITIONNAME>: ポータルにログインしているユーザの役職に置換	×
   authenticationType	認証タイプ 連携対象Webアプリケーションが認証情報を受け取る際に、HTTP POST / GET のどちらの形式で受け取るかを指定します。 POST: HTTP POSTによる認証を行う。 GET: HTTP GETによる認証を行う。	○
   authenticationURL	認証用URL 連携対象Webアプリケーションが認証を行うページのURLを指定します。	○
   availableOfficeIds	利用可能な組織のID 利用可能な組織のIDを指定します。 通常利用では指定する必要はありません。	×
   companyId	会社ID 連携対象Webアプリケーションが所属する会社のIDを指定します。	△(*2)

   (*1)認証サーバ連携機能を利用してWebOTX Portalの認証を行っている場合、 <PASSWORD> はポータルにログインしているユーザのパスワード情報に置換されません。
   (*2)マルチテナントモードの場合は必須です。

2.1.14. 認証連携Webアプリケーション削除

1. add-authentication-serviceコマンドで登録された連携対象Webアプリケーションを削除する場合、delete-authentication-serviceコマンドを使用します。
   
   シングルテナントの場合

   otxadmin > delete-authentication-service --serviceId <サービスID>
   

   マルチテナントの場合

   otxadmin > delete-authentication-service --serviceId <サービスID> --companyId <会社ID>
   

   オプション名	説明	必須項目
   serviceId	サービスID 削除する連携対象Webアプリケーションの識別子を指定します。 アプリケーション毎に重複しない名前を指定してください。	○
   companyId	会社ID 削除する連携対象Webアプリケーションが所属する会社のIDを指定します。	△(*1)

   (*1)マルチテナントモードの場合は必須です。

2.1.15. 認証連携Webアプリケーション一覧確認

1. add-authentication-serviceコマンドで登録された連携対象Webアプリケーションの一覧を確認する場合、list-authentication-serviceコマンドを使用します。
   
   シングルテナントの場合

   otxadmin > list-authentication-service
   

   マルチテナントの場合

   otxadmin > list-authentication-service --companyId <会社ID>
   

   オプション名	説明	必須項目
   companyId	会社ID 削除する連携対象Webアプリケーションが所属する会社のIDを指定します。	△(*1)

   (*1)マルチテナントモードの場合は必須です。

2.1.16. ポートレットで利用可能な認証連携サービスの登録

1. add-portlet-usable-serviceコマンドを実行し、指定した認証連携サービスをポートレットから使用可能にします。
   
   シングルテナントの場合

   otxadmin > add-portlet-usable-service --serviceId <登録済み認証連携サービスID> --serviceName <ポートレットに表示するサービス名> --serviceType <使用するサービスの種類> --portletType <ポートレットの種類>
   

   マルチテナントの場合

   otxadmin > add-portlet-usable-service --serviceId <登録済み認証連携サービスID> --serviceName <ポートレットに表示するサービス名> --serviceType <使用するサービスの種類> --portletType <ポートレットの種類> --companyId <登録する会社ID>
   

   オプション名	説明	必須項目
   serviceId	登録済みの認証連携サービスのIDを指定してください。	○
   serviceName	ポートレットに表示するサービス名を[言語]=[サービス名]の形式で指定します。複数言語を同時に指定する場合は、コンマ(:)区切りで指定してください。サービス名の最大文字数は1000文字です。 例：ja=サービス1:en=service1	○
   serviceType	登録するサービスの種類を指定します。V8.4ではservice(認証連携サービス)のみ指定可能です。	○
   portletType	サービスを使用可能にするポートレットの種類を指定します。認証連携ポートレットで使用する場合はauthn、メニューポートレットで使用する場合はmenuを指定してください。	○
   companyId	サービスを使用可能にする会社IDを指定します。シングルテナント環境では指定する必要はありません。	△

2.1.17. ポートレットで利用可能な認証連携サービスの削除

1. delete-portlet-usable-serviceコマンドを実行し、指定した認証連携サービスをポートレットから使用できないようにします。
   
   シングルテナントの場合

   otxadmin > delete-portlet-usable-service --serviceId <登録済みのサービスID> --serviceType <削除するサービスの種類> --portletType <ポートレットの種類>
   

   マルチテナントの場合

   otxadmin > delete-portlet-usable-service --serviceId <登録済みのサービスID> --serviceType <削除するサービスの種類> --portletType <ポートレットの種類> --companyId <削除する会社のID>
   

   オプション名	説明	必須項目
   serviceId	削除するサービスのIDを指定してください。	○
   serviceType	削除するサービスの種類を指定します。V8.4ではservice(認証連携サービス)のみ指定可能です。	○
   portletType	サービスを使用できなくするポートレットの種類を指定します。認証連携ポートレットの場合はauthn、メニューポートレットの場合はmenuを指定してください。	○
   companyId	サービスを使用不可能にする会社IDを指定します。シングルテナント環境では指定する必要はありません。	△

2.1.18. ポートレットで利用可能な認証連携サービス一覧確認

1. list-portlet-usable-serviceコマンドを実行し、登録済みの使用可能な認証連携サービス一覧が表示されます。
   
   シングルテナントの場合

   otxadmin > list-portlet-usable-service
   

   マルチテナントの場合

   otxadmin > list-portlet-usable-service --companyId <一覧を確認する会社のID>
   

   オプション名	説明	必須項目
   companyId	使用可能なサービス一覧を確認する会社のIDを指定します。シングルテナント環境では指定する必要はありません。	△

2. 実行結果は以下のようになります。

   ServiceId	ServiceType	PortletType	CompanyId	ServiceName
   service1	Authentication Service	Authentication Portlet	000000	en=service1:ja=サービス1
   service2	Authentication Service	Menu Portlet	000000	en=MenuService:ja=メニューポートレット用サービス

2.1.19. 永続ユニットの作成

1. add-persistence-unitコマンドで永続ユニットを作成します。

   otxadmin > add-persistence-unit <永続ユニット名>
   

Caution
利用できる永続ユニット名はunit_001からunit_010となります

2.1.20. 永続ユニットの削除

1. remove-persistence-unitコマンドで永続ユニットを作成します。

   otxadmin > remove-persistence-unit <削除する永続ユニット名>
   

2.1.21. ストレージキャッシュ機能有効化

1. invokeコマンドでキャッシュ機能の有効化を行います。

   otxadmin > invoke server.portal.portal-storage.enableCache
   

2.1.22. ストレージキャッシュ機能無効化

1. invokeコマンドでキャッシュ機能の無効化を行います。

   otxadmin > invoke server.portal.portal-storage.disableCache
   

2.1.23. ストレージキャッシュクリア

1. invokeコマンドでキャッシュクリアを行います。

   otxadmin > invoke server.portal.portal-storage.clearCache <永続ユニット名>
   

2.1.24. ディレクトリサーバキャッシュクリア

1. invokeコマンドでディレクトリサーバのキャッシュクリアを行います。

   otxadmin > invoke server.portal.directory-server.cacheClear
   

2.1.25. ディレクトリサーバへのコンテキストキャッシュのクリア

1. invokeコマンドでディレクトリサーバの接続コンテキストキャッシュをクリアします。

   otxadmin > invoke server.portal.directory-server.clearContextCache
   

2.1.26. ポータルスキンの有効化

1. enable-portal-skinコマンドでポータルスキンを新規に追加します。ポータルスキンの作成方法については、[5.コンフィグレーション > 5.7. UIカスタマイズ > 5.7.2. リソースの作成 > 5.7.2.1. ポータルスキン]を参照してください。

   otxadmin > enable-portal-skin --id portalSkin1 --name ja=ポータルスキン1:en=portalSkin1 --defaultName portalSkin1 --targetId portalSkinId1
   

2.1.27. ページレイアウトの登録

1. add-page-layoutコマンドでページレイアウトを新規に追加します。ページレイアウトの作成方法については、[5.コンフィグレーション > 5.7. UIカスタマイズ > 5.7.2. リソースの作成 > 5.7.2.4. レイアウトパターン]を参照してください。

   otxadmin > add-page-layout --id pageLayout1 --name ja=ページレイアウト1:en=pageLayout1 --defaultName pageLayout
   

2.1.28. ポートレットスキンの有効化

1. enable-portlet-skinコマンドでポートレットスキンを新規に追加します。ポートレットスキンの作成方法については、[5.コンフィグレーション > 5.7. UIカスタマイズ > 5.7.2. リソースの作成 > 5.7.2.2. ポートレットスキン]を参照してください。

   otxadmin > enable-portlet-skin --id portletSkin1 --name ja=ポートレットスキン1:en=portletSkin1 --defaultName portletSkin1 --targetId portletSkinId1
   

2.1.29. サイトテーマの有効化

1. enable-themeコマンドでサイトテーマを新規に追加します。サイトテーマの作成方法については、[5.コンフィグレーション > 5.7. UIカスタマイズ > 5.7.2. リソースの作成 > 5.7.2.3. テーマ]を参照してください。

   otxadmin > enable-theme --id theme1 --name ja=サイトテーマ1:en=siteTheme1 --defaultName siteTheme1 --targetId siteTheme1
   

2.1.30. ポータルスキンの無効化

1. disable-portal-skinコマンドでポータルスキンを無効化します。

   otxadmin > disable-portal-skin --id portalSkin1
   

2.1.31. ページレイアウトの削除

1. delete-page-layoutコマンドでページレイアウトを削除します。

   otxadmin > delete-page-layout --id pageLayout1
   

2.1.32. ポートレットスキンの無効化

1. disable-portlet-skinコマンドでポートレットスキンを無効化します。

   otxadmin > disable-portlet-skin --id portletSkin1
   

2.1.33. サイトテーマの無効化

1. disable-themeコマンドでサイトテーマを無効化します。

   otxadmin > disable-theme --id themeId1
   

2.1.34. ポータルスキン一覧確認

1. list-portal-skinコマンドで有効化されているポータルスキンの一覧を取得します。

   otxadmin > list-portal-skin
   

2. 実行結果は以下のようになります。

   id	name	defaultName	targetId
   portalSkin1	ja=ポータルスキン1:en=portalSkin1	portalSkin1	portalSkinId1

2.1.35. ページレイアウト一覧確認

1. list-page-layoutコマンドで登録されているページレイアウトの一覧を取得します。

   otxadmin > list-page-layout
   

2. 実行結果は以下のようになります。

   id	name	defaultName
   layoutPattern1	ja=パターン1:en=pattern1	pattern1

2.1.36. ポートレットスキン一覧確認

1. list-portlet-skinコマンドで有効化されているポートレットスキンの一覧を取得します。

   otxadmin > list-portlet-skin
   

2. 実行結果は以下のようになります。

   id	name	defaultName	targetId
   portletSkin1	ja=ポートレットスキン1:en=porletSkin1	portletSkin1	portletSkinId1

2.1.37. サイトテーマ一覧確認

1. list-themeコマンドで有効化されているサイトテーマの一覧を取得します。

   otxadmin > list-theme
   

2. 実行結果は以下のようになります。

   id	name	defaultName	targetId
   theme1	ja=テーマ1:en=theme1	theme1	themeId1

2.1.38. 認証設定再読み込みコマンド

1. invokeコマンドで PortalConfiguration.properties ファイルの再読み込みを行います。

   otxadmin > invoke server.portal.resetAuthenticationConfig
   

2. 実行に成功した場合は何も表示されません。失敗した場合はエラーメッセージと原因が表示されます。

2.1.39. 強制ログアウトコマンド

1. logout-portal-user コマンドでポータルシステムにログインしているユーザを強制的にログアウトさせます。

   otxadmin > logout-portal-user  --targetType  ユーザ種別  --portalServer  ポータルサーバが稼働しているマシンのホスト名
   

2.1.40. ログイン抑止コマンド

1. suppress-portal-login コマンドでポータルシステムに、一般ユーザがログインできなくなります。

   otxadmin > suppress-portal-login
   

2.1.41. ログイン抑止解除コマンド

1. unsuppress-portal-login コマンドでポータルシステムに、一般ユーザがログインできるようになります。

   otxadmin > unsuppress-portal-login
   

2.1.42. ログイン抑止状態確認コマンド

1. get-portal-login-setting コマンドで、ログイン抑止状態かどうかを確認できます。

   otxadmin > get-portal-login-setting
   

2. 実行に成功した場合は、一般ユーザがログインできるかどうかを示すメッセージが表示されます。失敗した場合はエラーメッセージと原因が表示されます。

2.1.43. システム認証種別設定コマンド

1. set-sys-auth-mode コマンドで、システム認証種別を設定をします。

   otxadmin > set-sys-auth-mode --authType PS_FA
   

2.1.44. システム認証種別確認コマンド

1. get-sys-auth-mode コマンドで、システム認証種別を取得します。

   otxadmin > get-sys-auth-mode
   

2.1.45. ユーザ認証種別設定コマンド

1. set-user-auth-mode コマンドで、システム認証種別を設定をします。

   otxadmin > set-user-auth-mode --userId 00001 --authType PS_FA
   

2.1.46. ユーザ認証種別確認コマンド

1. get-user-auth-mode コマンドで、システム認証種別を設定をします。

   otxadmin > get-user-auth-mode --userId 00001
   

2.2. 運用管理WebAPI

• ログイン/ログアウト
• ポータルサイトの登録/削除/取得
• 認証連携サービスの登録/削除/取得
• ポートレットで利用可能な認証連携サービスの登録/削除/取得

2.2.1. ログイン/ログアウト

2.2.1.1. ログイン

{
  "result"  : "200"
}

{
  "result"  : "401",
  "message" : "失敗原因メッセージ"
}

2.2.1.2. ログアウト

{
  "result"  : "200"
}

2.2.2. ポータルサイト

2.2.2.1. ポータルサイト登録

{
  "portalsites" : [ {
    "ownerType" : "USER",
    "siteId" : "00000",
    "ownerId" : "00000",
    "themeId" : "th-3",
    "description" : "テスト用サイト"
  } ]
}

2.2.2.2. ポータルサイト削除

2.2.2.3. ポータルサイト取得

2.2.3. 認証連携サービス

2.2.3.1. 認証連携サービス登録

{
  "services" : [ {
    "hostName" : null,
    "portNumber" : "0",
    "serviceName" : [ "en=service1", "ja=サービス1", ],
    "serviceId" : "service1",
    "serviceURL" : null,
    "authenticateItems" : {
      "authenticateItemInfos" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value2"
      } ]
    },
    "authenticateType" : "GET",
    "authenticateURL" : "http://localhost/",
    "availableGroupIds" : [ "BU1" ],
    "listnerURL" : null,
    "serviceType" : "service"
  } ]
}

2.2.3.2. 認証連携サービス削除

2.2.3.3. 認証連携サービス一覧取得

2.2.4. ポートレットで利用可能な認証連携サービス

2.2.4.1. ポートレットで利用可能な認証連携サービス登録

{
  "availableservice" : {
    "portletType" : "authn",
    "serviceList" : [ {
      "serviceItems" : [ {
        "serviceId" : "service1",
        "serviceName" : [ "ja=サービス1","en=service1" ]
      } ],
      "serviceType" : "service"
    } ]
  }
}

2.2.4.2. ポートレットで利用可能な認証連携サービス削除

2.2.4.3. ポートレットで利用可能な認証連携サービス一覧取得