1. ポータル

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

1.1. 運用管理コマンド

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

1.1.1. ポータルサイト作成

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

1.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コマンドで指定できるオプションは以下の通りです。
    表1.1.1.1-1
    オプション名 説明 必須項目
    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を指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。

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

表1.1.1.1-2
記号 説明 使用不可の例
左のシングルクォーテーション
site‘
右のシングルクォーテーション
sit’e
;
セミコロン
site;
|
縦線
|site
*
アスタリスク
site*
`
バッククォート
site`
^
キャレット
site^
<
小なり
site<
>
大なり
site>
 
スペース
si te
"
ダブルクオーテーション
"site
#
シャープ
site#
%
パーセント
site%
{
開く中括弧
site{
}
閉じる中括弧
site}
\
エンマーク
site\
~
チルダ
site~
[
開く角括弧
site[
]
閉じる角括弧
site]
.
ピリオド。ただし、先頭、最後、連続したもののみ使用不可
.site,stie.,si..te
/
スラッシュ
site/
?
疑問符
site?
:
コロン
site:
@
アットマーク
site@
=
イコール
site=
&
アンパーサンド
site&
_
先頭のアンダーバー
_site
+
プラス
+site

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

  1. ポータルサイト作成に使用するCSVファイルを作成します。CSVファイルの一行目には以下の項目を記載します。二行目以降に作成するポータルサイトのオーナやサイトのIDを定義します。
    表1.1.1.2-1
    項目名 説明
    ownerId siteIdで指定するサイトのオーナのIDを指定します。定義できる最大文字列長は32文字です。ownerIdの列で重複した値定義することはできません。重複した値が定義されている場合はエラーとなります。また、空文字を定義することはできません。
    ownerType 作成するポータルサイトのオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。
    siteId 作成するポータルサイトのIDを指定します。定義できる最大文字列長は36文字です。siteIdの列で重複した値を定義することはできません。定義した場合エラーとなります。また、空文字を定義することはできません。siteIdに使用できない文字はこちらを参照ください
    description サイトの説明を定義することができます。定義できる最大文字数は0〜255文字です。本項目は任意項目です。2バイト文字も指定可能です
    themeId サイトのテーマのIDを指定します。存在しないテーマIDを指定した場合や本項目を指定しない場合は、「既定」のテーマが使用されます。本項目は任意項目です。
    例えば、以下のように定義することができます。実際のサンプルはこちらで確認することができます。
    表1.1.1.2-2
    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ファイルを使用したポータルサイト作成時に指定可能なオプションは以下の通りです。
    表1.1.1.2-3
    オプション名 説明 必須項目
    authorId 作成するポータルサイトを作成するユーザのIDを指定します。ここで指定するIDはユーザリソースのディレクトリサーバ(EDS)に登録されているユーザのIDを指定する必要があります。指定できる文字数は64文字までです
    filepath 手順の1で作成したCSVファイルへのパスを指定します。
    lang description項目で指定した説明の言語を指定します。指定可能な値はja(日本語)、en(英語)となります。
    ×
    companyId マルチテナント時にサイトを作成する会社IDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。

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

1.1.2. ポータルサイト削除

不要になったポータルサイトを削除するには、delete-portal-siteコマンドを使用します。
  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>
    
    表1.1.2-1
    オプション名 説明 必須項目
    ownerId 削除するポータルサイトのオーナのIDを指定します。管理者サイトを削除する場合は指定する必要はありません。
    ownerType 削除するポータルサイトのオーナに指定するユーザリソースのタイプを指定します。指定できる値はUSERまたはGROUPのみです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。管理者サイトを削除する場合は指定する必要はありません。
    siteId 削除するポータルサイトのIDを指定します。
    companyId マルチテナント時にサイトを削除する会社IDを指定します。マルチテナント環境では必須項目です。シングルテナント環境では指定する必要はありません。

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

1.1.3. ポータルサイト更新

すでに作成済みのポータルサイトのオーナを変更する、またサイト名を変更する場合はupdate-portal-siteコマンドを使用します。
  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>
    
    表1.1.3-1
    オプション名 説明 必須項目
    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指定してください。

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

登録されたポータルサイトのうち、list-portal-siteコマンドを使用することで、指定したユーザリソースがオーナとなっているサイトIDの一覧を表示することができます。
  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 
    
    表1.1.4-1
    オプション名 説明 必須項目
    ownerId ユーザリソースのIDを指定します。本オプションで指定したユーザリソースがオーナとなっているサイトのIDを確認できます
    ownerType ownerIdオプションで指定したユーザリソースのタイプを指定します。指定できる値はUSER、GROUPまたはCOMPANYです。ownerIdで指定したIDがユーザの場合はUSERを、ownerIdに指定したIDがグループ/組織の場合はGROUPを指定する必要があります。管理者サイトのIDを確認する場合はCOMPANYを指定してください。
    companyId マルチテナント時にサイトのオーナが所属する会社のIDを指定します。シングルテナント時は指定する必要はありません。

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

すでに登録されているポータルサイトの利用して同一構成のサイトを作成する場合、copy-portal-siteコマンドを使用します。
  1. copy-portal-siteコマンドを実行し、指定したサイトと同一構成のサイトを新規に作成することができます。

    シングルテナントの場合
    otxadmin > copy-portal-site --srcSiteId <コピー元のサイトID> --destSiteId <コピー先のサイトID> --ownerId <> --ownerType <> --authorId <>
    
    マルチテナントの場合
    otxadmin > copy-portal-site --srcSiteId <コピー元のサイトID> --destSiteId <コピー先のサイトID> --ownerId <コピー先のサイトのオーナID> --ownerType <コピー先サイトのオーナのタイプ> --authorId <> --companyId <オーナが所属する会社ID>
    
    表1.1.5-1
    オプション名 説明 必須項目
    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 コピー元サイトが編集モードの場合でもサイトコピーを実行するか指定します。コピー元サイトが編集モード時かつ、本オプションを指定しない場合はサイトコピーに失敗します。
    ×

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

ディレクトリサーバ(EDS)上からユーザリソースを削除した場合、ユーザリソース削除通知機能を実行し、ポータルリソースに通知し不要なポータルサイトやアクセス権情報の削除を行う必要がある。システム管理者が何かしらの原因でポータルリソースへの通知を実行しなかった場合、存在しないユーザやグループ/組織がオーナとなっているポータルサイトが登録されている場合があります。不要なポータルサイトの存在を確認するために、directory-matchingコマンドを使用します。
  1. directory-matchingコマンドを使用することで、オーナがユーザリソースのディレクトリサーバ(EDS)上に登録されていないサイトIDの一覧がコマンド上に表示されます。

    シングルテナントの場合
    otxadmin > directory-matching
    
    マルチテナントの場合
    otxadmin > directory-matching --companyId <整合性確認を実施する会社のID>
    
  2. directory-matchingコマンドの実行結果の例は以下のようになります。
    表1.1.6-1
    サイトID オーナID オーナタイプ
    site00000 00000 USER
    site00001 00001 USER
    site00002 00002 USER
    site00003 00003 USER
    site00004 00004 USER

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

ユーザリソースのディレクトリサーバ(EDS)からユーザ、グループ/組織、ロールが削除されたが、ポータルリソース側に不要な情報(ポータルサイト、アクセス権情報など)が残ってしまいます。そのため、ユーザリソースが削除されたことをポータルリソース側に通知し不要な情報を削除する必要があります。 ユーザリソースの削除をポータルリソース側に通知するには、以下の二つの手順があります。

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

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

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

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

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

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

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

配備した基本ポートレットを公開する範囲を設定する場合、add-fundamental-portlet-permissionコマンドを使用します。
  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>
    
    表1.1.8-1
    オプション名 説明 必須項目
    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を指定した場合やシングルテナント環境では指定する必要はありません。
    表1.1.8-2
    オペランド アクセス権を付与する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

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

配備した基本ポートレットの公開変更(削除)する場合、delete-fundamental-portlet-permissionコマンドを使用します。
  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>
    
    表1.1.9-1
    オプション名 説明 必須項目
    subjectId アクセス権を削除する対象となるユーザリソースのIDを指定してください。
    subjectType subjectIdに指定したユーザリソースの種別。指定可能な文字列は、USER、GROUP、ROLE、COMPANY、ALL_USERSです。
    portletApplicationName アクセス権を削除する基本ポートレットが含まれるアプリケーション(warファイル)名を指定してください。
    companyId subjectIdに指定したユーザリソースが所属する会社のIDを指定します。subjectTypeにCOMPANYを指定した場合やシングルテナント環境では指定する必要はありません。
    表1.1.9-2
    オペランド アクセス権を削除する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

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

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

    otxadmin > list-fundamental-portlet-permission --portletApplicationName <基本ポートレットが含まれるWebアプリケーション名(warの名前)> <基本ポートレット名>
    
    表1.1.10-1
    オプション名 説明 必須項目
    portletApplicationName アクセス権を確認する基本ポートレットが含まれるアプリケーション(warファイル)名を指定してください。
    表1.1.10-2
    オペランド アクセス権を確認する基本ポートレット名を指定します。portlet.xmlの属性portlet-nameに指定されている値を指定してください。

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

特定のサイト配下のポータルリソースにアクセス権を同じアクセス権を一括して付与を行う場合、add-access-controlコマンドを使用します。
  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> <付与するアクセス権>
    
    表1.1.11-1
    オプション名 説明 必須項目
    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を指定した場合やシングルテナント環境では指定する必要はありません。
    表1.1.11-2
    オペランド 付与するアクセス権を指定してください。指定可能なアクセス権は以下のとおりです。

    参照権:VIEW
    引用権:QUOTE
    コピー権:COPY
    個人設定権:EDIT

    複数のアクセス権を同時に付与する場合はコロン(:)区切りで指定してください。
    例:VIEW:QUOTE:COPY:EDIT

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

特定のサイト配下に付与されたアクセス権を削除する場合、delete-access-controlコマンドを使用します。
  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> <付与するアクセス権>
    
    表1.1.12-1
    オプション名 説明 必須項目
    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を指定した場合やシングルテナント環境では指定する必要はありません。
    表1.1.12-2
    オペランド 削除するアクセス権を指定してください。指定可能なアクセス権は以下のとおりです。

    参照権:VIEW
    引用権:QUOTE
    コピー権:COPY
    個人設定権:EDIT

    複数のアクセス権を同時に付与する場合はコロン(:)区切りで指定してください。
    例:VIEW:QUOTE:COPY:EDIT

1.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 <1 or 2> --availableOfficeIds <利用可能な組織ID>
    
    マルチテナントの場合
    otxadmin > add-authentication-service --serviceId <サービスID> --serviceName <en=サービス名(英語):ja=サービス名(日本語)> --hostName <ホスト名(IPアドレス)> --portNumber <ポート番号> --authenticationItems <パラメータ名1=パラメータ値1:パラメータ2=パラメータ値2:...> --authenticationURL <認証URL> --authenticationType <1 or 2> --availableOfficeIds <利用可能な組織ID> --companyId <会社ID>
    
    表1.1.13-1
    オプション名 説明 必須項目
    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>: ポータルにログインしているユーザのユーザIDに置換
    <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)マルチテナントモードの場合は必須です。

1.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>
    
    表1.1.14-1
    オプション名 説明 必須項目
    serviceId

    サービスID

    削除する連携対象Webアプリケーションの識別子を指定します。 アプリケーション毎に重複しない名前を指定してください。

    companyId

    会社ID

    削除する連携対象Webアプリケーションが所属する会社のIDを指定します。

    △(*1)

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

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

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

    シングルテナントの場合
    otxadmin > list-authentication-service
    
    マルチテナントの場合
    otxadmin > list-authentication-service --companyId <会社ID>
    
    表1.1.15-1
    オプション名 説明 必須項目
    companyId

    会社ID

    削除する連携対象Webアプリケーションが所属する会社のIDを指定します。

    △(*1)

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

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

登録済みの認証連携サービスを認証連携ポートレット、メニューポートレットで使用するための登録をadd-portlet-usable-serviceコマンドを使用して実施します。
登録可能なサービスは最大で50件となりますが、以下のシステムプロパティを設定することで最大値は1000まで拡大可能です。
-Dcom.nec.webotx.portal.portlet.serviceNumber=<サービス登録数:例1000>
  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>
    
    表1.1.16-1
    オプション名 説明 必須項目
    serviceId 登録済みの認証連携サービスのIDを指定してください。
    serviceName ポートレットに表示するサービス名を[言語]=[サービス名]の形式で指定します。複数言語を同時に指定する場合は、コンマ(:)区切りで指定してください。サービス名の最大文字数は1000文字です。

    例:ja=サービス1:en=service1
    serviceType 登録するサービスの種類を指定します。V8.4ではservice(認証連携サービス)のみ指定可能です。
    portletType サービスを使用可能にするポートレットの種類を指定します。認証連携ポートレットで使用する場合はauthn、メニューポートレットで使用する場合はmenuを指定してください。
    companyId サービスを使用可能にする会社IDを指定します。シングルテナント環境では指定する必要はありません。

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

登録済みのポートレットで使用可能な認証連携サービスを削除する場合、delete-portlet-usable-serviceコマンドを使用します。削除後はポートレットから当該の認証連携サービスは使用できなくなります。なお、認証連携サービスの情報自体を削除する場合は、delete-authentication-serviceコマンドを実行する必要があります。
  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>
    
    表1.1.17-1
    オプション名 説明 必須項目
    serviceId 削除するサービスのIDを指定してください。
    serviceType 削除するサービスの種類を指定します。V8.4ではservice(認証連携サービス)のみ指定可能です。
    portletType サービスを使用できなくするポートレットの種類を指定します。認証連携ポートレットの場合はauthn、メニューポートレットの場合はmenuを指定してください。
    companyId サービスを使用不可能にする会社IDを指定します。シングルテナント環境では指定する必要はありません。

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

登録済みのポートレットが使用可能な認証連携サービスの一覧を確認する場合、list-portlet-usable-serviceコマンドを使用します。結果はカンマ区切りで表示されます。
  1. list-portlet-usable-serviceコマンドを実行し、登録済みの使用可能な認証連携サービス一覧が表示されます。

    シングルテナントの場合
    otxadmin > list-portlet-usable-service
    
    マルチテナントの場合
    otxadmin > list-portlet-usable-service --companyId <一覧を確認する会社のID>
    
    表1.1.18-1
    オプション名 説明 必須項目
    companyId 使用可能なサービス一覧を確認する会社のIDを指定します。シングルテナント環境では指定する必要はありません。
  2. 実行結果は以下のようになります。
    表1.1.18-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=メニューポートレット用サービス

1.1.19. 永続ユニットの作成

永続ユニットを作成するために、add-persistence-unitコマンドを実行します。
  1. add-persistence-unitコマンドで永続ユニットを作成します。
    otxadmin > add-persistence-unit <永続ユニット名>
    

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

1.1.20. 永続ユニットの削除

永続ユニットを削除するにはremove-persistence-unitコマンドを使用します。
  1. remove-persistence-unitコマンドで永続ユニットを作成します。
    otxadmin > remove-persistence-unit <削除する永続ユニット名>
    

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

キャッシュ機能無効化操作後や、キャッシュ機能に障害が発生した場合に、キャッシュ機能を有効化します。 分散キャッシュ利用時は、更新通知で利用しているJMSサーバとの再接続が行われますので、JMSサーバが復旧していることを確認して本操作を行ってください。 既にキャッシュ機能が有効になっている場合や、有効化処理中の場合は何もしません。 有効化処理の結果はイベントログ(syslog)で確認してください。
  1. invokeコマンドでキャッシュ機能の有効化を行います。
    otxadmin > invoke server.portal.portal-storage.enableCache
    

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

ストレージのキャッシュ機能を利用できないようにします。障害発生時などに、強制的にキャッシュ機能を無効化する場合に利用します。
  1. invokeコマンドでキャッシュ機能の無効化を行います。
    otxadmin > invoke server.portal.portal-storage.disableCache
    

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

接続先ドメインのストレージキャッシュをクリアします。ドメイン内の全プロセスが対象です。 障害からの復旧後などにストレージキャッシュとデータベースとの不整合をなくす場合に実行します。
  1. invokeコマンドでキャッシュクリアを行います。
    otxadmin > invoke server.portal.portal-storage.clearCache <永続ユニット名>
    

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

ドメイン起動中にディレクトリサーバからユーザエントリの更新を実施した場合、ドメイン内に保持されたキャッシュ情報とディレクトリサーバとの間で不整合が発生する可能性があります。不整合を解消するために、ドメイン内に保持されたキャッシュ情報をクリアを行います。
  1. invokeコマンドでディレクトリサーバのキャッシュクリアを行います。
    otxadmin > invoke server.portal.directory-server.cacheClear
    

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

ドメイン起動中にポータルサーバ、ディレクトリサーバ間のコンテキストのキャッシュのクリアを行います。
  1. invokeコマンドでディレクトリサーバの接続コンテキストキャッシュをクリアします。
    otxadmin > invoke server.portal.directory-server.clearContextCache
    

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

新たにポータルスキンを追加する場合にenable-portal-skinコマンドを使用します。
  1. enable-portal-skinコマンドでポータルスキンを新規に追加します。ポータルスキンの作成方法については、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.1. ポータルスキン]を参照してください。
    otxadmin > enable-portal-skin --id portalSkin1 --name ja=ポータルスキン1:en=portalSkin1 --defaultName portalSkin1 --targetId portalSkinId1
    
表1.1.26-1
オプション名 説明 必須項目
id 有効化するポータルスキンのIDを指定します。既定のディレクトリ配下にポータルスキンIDと同じ名前のディレクトリを作成し、ポータルスキンの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.1. ポータルスキン]参照してください。
name 有効化するポータルスキンの名前を設定します。名前に言語名を設定し、値に言語に対応したポータルスキン名を設定してください。
×
defaultName 有効化するポータルスキンのデフォルト名を設定します。ポータルスキン名に設定した言語と一致しない場合にデフォルト名で表示されます。
targetId 有効化するポータルスキンのターゲットIDを指定します。ポータルスキンIDのディレクトリ配下にターゲットIDと同じ名前のディレクトリを作成し、テーマの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、マニュアルを参照してください。

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

新たにページレイアウトを追加する場合にadd-page-layoutコマンドを使用します。
  1. add-page-layoutコマンドでページレイアウトを新規に追加します。ページレイアウトの作成方法については、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.4. レイアウトパターン]を参照してください。
    otxadmin > add-page-layout --id pageLayout1 --name ja=ページレイアウト1:en=pageLayout1 --defaultName pageLayout
    
表1.1.27-1
オプション名 説明 必須項目
id 登録するレイアウト・パターンのIDを指定します。既定のディレクトリ配下にレイアウト・パターンIDと同じ名前のディレクトリを作成し、レイアウト・パターンの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.4. レイアウトパターン]を参照してください。
name 登録するレイアウト・パターンの名前を設定します。名前に言語名を設定し、値に言語に対応したレイアウト・パターン名を設定してください。
×
defaultName 登録するレイアウト・パターンのデフォルト名を設定します。レイアウト・パターン名に設定した言語と一致しない場合にデフォルト名で表示されます。

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

新たにポートレットスキンを追加する場合にenable-portlet-skinコマンドを使用します。
  1. enable-portlet-skinコマンドでポートレットスキンを新規に追加します。ポートレットスキンの作成方法については、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.2. ポートレットスキン]を参照してください。
    otxadmin > enable-portlet-skin --id portletSkin1 --name ja=ポートレットスキン1:en=portletSkin1 --defaultName portletSkin1 --targetId portletSkinId1
    
表1.1.28-1
オプション名 説明 必須項目
id 有効化するポートレットスキンのIDを指定します。既定のディレクトリ配下にポートレットスキンIDと同じ名前のディレクトリを作成し、ポートレットスキンの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.2. ポートレットスキン]を参照してください。
name 有効化するポートレットスキンの名前を設定します。名前に言語名を設定し、値に言語に対応したポートレットスキン名を設定してください。
×
defaultName 有効化するポートレットスキンのデフォルト名を設定します。ポートレットスキン名に設定した言語と一致しない場合にデフォルト名で表示されます。
targetId 有効化するポートレットスキンのターゲットIDを指定します。ポートレットスキンIDのディレクトリ配下にターゲットIDと同じ名前のディレクトリを作成し、テーマの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.2. ポートレットスキン]を参照してください。

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

新たにサイトテーマを追加する場合にenable-themeコマンドを使用します。
  1. enable-themeコマンドでサイトテーマを新規に追加します。サイトテーマの作成方法については、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.3. テーマ]を参照してください。
    otxadmin > enable-theme --id theme1 --name ja=サイトテーマ1:en=siteTheme1 --defaultName siteTheme1 --targetId siteTheme1
    
表1.1.29-1
オプション名 説明 必須項目
id 有効化するテーマのIDを指定します。既定のディレクトリ配下にテーマIDと同じ名前のディレクトリを作成し、テーマの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.3. テーマ]を参照してください。
name 有効化するテーマの名前を設定します。名前に言語名を設定し、値に言語に対応したテーマ名を設定してください。
×
defaultName 有効化するテーマのデフォルト名を設定します。テーマ名に設定した言語と一致しない場合にデフォルト名で表示されます。
targetId 有効化するテーマのターゲットIDを指定します。テーマIDのディレクトリ配下にターゲットIDと同じ名前のディレクトリを作成し、テーマの定義ファイルを格納する必要があります。格納ディレクトリの詳細は、[6.コンフィグレーション > 6.7. UIカスタマイズ > 6.7.2. リソースの作成 > 6.7.2.3. テーマ]を参照してください。

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

ポータルスキンを無効化する場合にdisable-portal-skinコマンドを使用します。
  1. disable-portal-skinコマンドでポータルスキンを無効化します。
    otxadmin > disable-portal-skin --id portalSkin1
    
表1.1.30-1
オプション名 説明 必須項目
id 無効化するポータルスキンのIDを指定します

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

ページレイアウトを削除する場合にdelete-page-layoutコマンドを使用します。
  1. delete-page-layoutコマンドでページレイアウトを削除します。
    otxadmin > delete-page-layout --id pageLayout1
    
表1.1.31-1
オプション名 説明 必須項目
id 無効化するページレイアウトのIDを指定します

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

ポートレットスキンを無効化する場合にdisable-portlet-skinコマンドを使用します。
  1. disable-portlet-skinコマンドでポートレットスキンを無効化します。
    otxadmin > disable-portlet-skin --id portletSkin1
    
表1.1.32-1
オプション名 説明 必須項目
id 無効化するポートレットスキンのIDを指定します

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

サイトテーマを無効化する場合にdisable-themeコマンドを使用します。
  1. disable-themeコマンドでサイトテーマを無効化します。
    otxadmin > disable-theme --id themeId1
    
表1.1.33-1
オプション名 説明 必須項目
id 無効化するサイトテーマのIDを指定します

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

有効化されているポータルスキンの一覧を確認する場合にlist-portal-skinコマンドを使用します。
  1. list-portal-skinコマンドで有効化されているポータルスキンの一覧を取得します。
    otxadmin > list-portal-skin
    
  2. 実行結果は以下のようになります。
    表1.1.34-1
    id name defaultName targetId
    portalSkin1 ja=ポータルスキン1:en=portalSkin1 portalSkin1 portalSkinId1

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

有効化されているページレイアウトの一覧を確認する場合にlist-page-layoutコマンドを使用します。
  1. list-page-layoutコマンドで登録されているページレイアウトの一覧を取得します。
    otxadmin > list-page-layout
    
  2. 実行結果は以下のようになります。
    表1.1.35-1
    id name defaultName
    layoutPattern1 ja=パターン1:en=pattern1 pattern1

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

有効化されているポートレットスキンの一覧を確認する場合にlist-portlet-skinコマンドを使用します。
  1. list-portlet-skinコマンドで有効化されているポートレットスキンの一覧を取得します。
    otxadmin > list-portlet-skin
    
  2. 実行結果は以下のようになります。
    表1.1.36-1
    id name defaultName targetId
    portletSkin1 ja=ポートレットスキン1:en=porletSkin1 portletSkin1 portletSkinId1

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

有効化されているサイトテーマの一覧を確認する場合にlist-themeコマンドを使用します。
  1. list-themeコマンドで有効化されているサイトテーマの一覧を取得します。
    otxadmin > list-theme
    
  2. 実行結果は以下のようになります。
    表1.1.37-1
    id name defaultName targetId
    theme1 ja=テーマ1:en=theme1 theme1 themeId1

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

認証の設定ファイル PortalConfiguration.properties を読み込むためには invoke コマンドを使用します。
  1. invokeコマンドで PortalConfiguration.properties ファイルの再読み込みを行います。
    otxadmin > invoke server.portal.resetAuthenticationConfig
    
  2. 実行に成功した場合は何も表示されません。失敗した場合はエラーメッセージと原因が表示されます。

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

ポータルシステムにログインしているすべてのユーザ、もしくは管理者を除く一般ユーザのログイン状態を強制的にログアウトするには、logout-portal-user コマンドを使用します。 なお、このコマンドはログイン状態を「ログイン中」から「ログアウト済み」に遷移させるのみであり、ブラウザに表示される画面は次に利用者が操作するまで変化しません。
  1. logout-portal-user コマンドでポータルシステムにログインしているユーザを強制的にログアウトさせます。
    otxadmin > logout-portal-user  --targetType  ユーザ種別  --portalServer  ポータルサーバが稼働しているマシンのホスト名
    
表1.1.39-1
オプション名 説明 必須項目
targetType ALL を指定した場合は、管理者を含むすべてのユーザを強制的にログアウト状態にします。 USER を指定した場合は、管理者を除くすべてのユーザを強制的にログアウト状態にします。
portalServer ポータルサーバが稼働しているマシンのホスト名またはIPアドレス。指定したポータルサーバを経由してログインしたユーザ(管理者を含む)を強制的にログアウト状態にします。 省略した場合は、システムを構成する全ポータルサーバを経由してログインしたユーザを対象とします。
×

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

一般ユーザのポータルシステムへのログインを抑止するには、suppress-portal-login コマンドを使用します。
  1. suppress-portal-login コマンドでポータルシステムに、一般ユーザがログインできなくなります。
    otxadmin > suppress-portal-login
    

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

一般ユーザのポータルシステムへのログインを抑止している状態から、一般ユーザがログインできる状態に変更するには、unsuppress-portal-login コマンドを使用します。
  1. unsuppress-portal-login コマンドでポータルシステムに、一般ユーザがログインできるようになります。
    otxadmin > unsuppress-portal-login
    

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

一般ユーザのポータルシステムへのログインが、現在抑止されているかどうかを確認するには、get-portal-login-setting コマンドを使用します。
  1. get-portal-login-setting コマンドで、ログイン抑止状態かどうかを確認できます。
    otxadmin > get-portal-login-setting
    
  2. 実行に成功した場合は、一般ユーザがログインできるかどうかを示すメッセージが表示されます。失敗した場合はエラーメッセージと原因が表示されます。

1.2. 運用管理WebAPI

本節ではポータルリソース運用管理機能を提供するWebAPIについて説明します。WebAPIを使用することで以下の操作が可能です。
WebAPIを使用可能なユーザは会社管理者のみです。会社管理者でログイン後、それぞれの操作を提供するURLにPOSTでリクエストを送信する必要があります。

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

ログイン/ログアウトの操作を行うWebAPIは以下のURLで提供しています。
表1.2.1-1
操作名 URL メソッド
ログイン http://<ホスト名>:<ポート番号>/webotxportal/session/user POST
ログアウト http://<ホスト名>:<ポート番号>/webotxportal/logout GET

1.2.1.1. ログイン

ログイン用のURLにPOSTで以下のパラメータを送信してください。
表1.2.1.1-1
パラメータ名 説明 必須 備考
userID ユーザのID。
マルチテナントの場合は、会社ID+実ユーザIDで指定する。
password ログインユーザのパスワード。
locale ロケール情報。言語_国で指定します(例: ja_JP)。 × 未指定の場合は、「en_US」になります。

ログインに成功した場合は、戻り値(JSON)は以下のようになります。
{
  "result"  : "200"
}
ログインに失敗した場合は、戻り値(JSON)は以下のようになります。
{
  "result"  : "401",
  "message" : "失敗原因メッセージ"
}
失敗原因メッセージは、リクエストパラメータで指定したロケールで表示されます。

1.2.1.2. ログアウト

ログアウト用のURLにGETでアクセスしてください。
パラメータはありません。

ログアウトを行う場合、事前にログイン操作を行っている必要があります。

ログアウトの戻り値(JSON)は以下のようになります。
{
  "result"  : "200"
}

1.2.2. ポータルサイト

ポータルサイト関連の操作を行うWebAPIは以下のURLで提供しています。

本操作を行う場合、事前に会社管理者でログイン済みである必要があります。
表1.2.2-1
操作名 URL
登録 http://<ホスト名>:<ポート番号>/webotxportal/management/portalsite/create
削除 http://<ホスト名>:<ポート番号>/webotxportal/management/portalsite/delete
取得 http://<ホスト名>:<ポート番号>/webotxportal/management/portalsite/get

1.2.2.1. ポータルサイト登録

表1.2.2.1-2
パラメータ名 説明 必須項目
portalsites 登録するポータルサイトのJSON
ポータルサイト登録用のJSONは以下のように記載します。
{
  "portalsites" : [ {
    "ownerType" : "USER",
    "siteId" : "00000",
    "ownerId" : "00000",
    "themeId" : "th-3",
    "description" : "テスト用サイト"
  } ]
}
各項目については以下を参照してください。
表1.2.2.1-1
パラメータ名 説明 必須項目
siteId 登録するサイトのIDを指定します。すでに登録されているサイトIDと重複してはいけません。
ownerId 登録するサイトのオーナを指定します。すでにサイトのオーナとなっているユーザまたは組織を指定することはできません。
ownerType ownerIdに指定したオーナのタイプを指定します。ownerIdにユーザIDを指定した場合はUSERを、組織を指定した場合はGROUPを指定してください。
themeId サイトで使用するテーマを指定します。指定されない場合は、デフォルトの設定がされます。
×
description サイトの説明を指定します。
×

1.2.2.2. ポータルサイト削除

ポータルサイト削除用のURLにPOSTで以下のパラメータを送信してください。
表1.2.2.2-1
パラメータ名 説明
siteId 削除するサイトのサイトIDを指定します。

1.2.2.3. ポータルサイト取得

ポータルサイト取得用のURLにPOSTで以下のパラメータを送信してください。siteIdとownerNameはどちらかを指定してください。両方指定された場合は、siteIdが優先されます。
表1.2.2.3-1
パラメータ名 説明
siteId 取得するサイトIDを指定します。
ownerName サイトのオーナ名を指定します。
指定した条件に合致するポータルサイトが登録されている場合、ポータルサイトの情報がJSON形式で返されます。各項目の説明は[ポータルサイト登録]を参照してください。

1.2.3. 認証連携サービス

認証連携サービス関連の操作を行うWebAPIは以下のURLで提供しています。
表1.2.4-1
操作名 URL
登録 http://<ホスト名>:<ポート番号>/webotxportal/management/authenticationservice/create
削除 http://<ホスト名>:<ポート番号>/webotxportal/management/authenticationservice/delete
一覧取得 http://<ホスト名>:<ポート番号>/webotxportal/management/authenticationservice/get

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

認証連携サービスを登録する場合はWebOTX Portalへログイン後、認証連携登録用のURLにPOSTで以下のパラメータを送信します。

本操作を行う場合、事前に会社管理者でログイン済みである必要があります。
表1.2.3.1-1
パラメータ名 説明
services 登録する認証連携サービスのJSON
登録する認証連携サービスのJSONは以下のように記載します。
{
  "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"
  } ]
}
各項目の説明については以下を参照してください。
表1.2.3.1-2
パラメータ名 説明 必須項目
services 登録する認証連携サービスのJSON
serviceiId 登録する認証連携サービスのIDを指定します。すでに登録済みのIDと重複してはいけません。
serviceName 認証連携サービスの名前を指定します。指定の方法は<言語>=<サービス名>として指定します。言語に設定可能な値はja(日本語)、en(英語),zh(中国語)です。
authenticationType 認証タイプを指定します。GETまたはPOSTを指定してくだい。
authenticationURL 認証用URLを指定します。
hostName ホスト名を指定します。
×
portNumber ポート番号を指定します。
×
serviceURL サービスURLを指定します。
×
authenticationItems 認証用パラメータを指定します。authenticateItemInfosに "key" : "項目1","value" : "値1"というように指定してください。複数同時に指定可能です。
×
listenerURL リスナURLを指定します。
×
availableOfficeIds 認証連携サービスを利用可能な組織のIDを指定します。存在しない組織を指定した場合は登録エラーとなります。
×

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

認証連携サービス一覧取削除用のURLにPOSTで以下のパラメータを送信してください。
表1.2.3.2-1
パラメータ名 説明 必須項目
serviceId 削除する認証連携サービスのIDを指定してください。

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

認証連携サービス一覧取得にはリクエストに含めるパラメータはありません。URLにPOSTリクエストの送信してください。
認証連携サービスが登録されている場合、認証連携サービスの情報がJSON形式で返されます。返却されるJSONの例、および各項目の説明は[認証連携サービス登録]を参照してください。

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

ポートレットで利用可能な認証連携サービス関連の操作を行うWebAPIは以下のURLで提供しています。

本操作を行う場合、事前に会社管理者でログイン済みである必要があります。
表1.2.5-1
操作名 URL
登録 http://<ホスト名>:<ポート番号>/webotxportal/management/availableservice/create
削除 http://<ホスト名>:<ポート番号>/webotxportal/management/availableservice/delete
一覧取得 http://<ホスト名>:<ポート番号>/webotxportal/management/availableservice/get

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

ポートレットで利用可能な認証連携サービスを登録する場合はWebOTX Portalへログイン後、認証連携登録用のURLにPOSTで以下のパラメータを送信します。
表1.2.4.1-1
パラメータ名 説明
availableservices 登録するポートレットで利用可能な認証連携サービスのJSON
登録する認証連携サービスのJSONは以下のように記載します。
{
  "availableservice" : {
    "portletType" : "authn",
    "serviceList" : [ {
      "serviceItems" : [ {
        "serviceId" : "service1",
        "serviceName" : [ "ja=サービス1","en=service1" ]
      } ],
      "serviceType" : "service"
    } ]
  }
}
各項目の説明については以下を参照してください。
表1.2.4.1-2
パラメータ名 説明 必須項目
availableservice 当該のJSONがポートレットが利用可能な登録する認証連携サービスのJSONであることを宣言します。
portletType 認証連携サービスを利用するポートレットの種類を指定します。指定可能な文字列はauthn(認証連携ポートレット)、menu(メニューポートレット)です。
serviceList 登録するポートレットが利用する認証連携サービスのリストを指定します。
serviceId ポートレットが利用する認証連携サービスのIDを指定します。本項目に指定したIDの認証連携サービスが事前に登録されている必要があります。
serviceName ポートレットが利用可能な認証連携サービスの名前を指定します。ここで指定した名前がポートレット上に表示されます。指定の方法は<言語>=<サービス名>として指定します。言語に設定可能な値はja(日本語)、en(英語),zh(中国語)です。
serviceType serviceと指定してください。

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

ポートレットで利用可能な認証連携サービス削除用のURLにPOSTで以下のパラメータを送信してください。serviceIdとportletTypeの組み合わせに合致する情報が登録されている場合に削除処理が成功します。
表1.2.4.2-1
パラメータ名 説明
serviceId 削除する認証連携サービスのIDを指定します。
portletType 認証連携サービスを利用しているポートレットの種類を指定します。指定可能な文字列はauthn(認証連携ポートレット)、menu(メニューポートレット)です。

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

ポートレットで利用可能な認証連携サービス一覧取得用のURLにPOSTで以下のパラメータを送信してください。
表1.2.4.3-1
パラメータ名 説明
portletType 認証連携サービスを利用しているポートレットの種類を指定します。指定可能な文字列はauthn(認証連携ポートレット)、menu(メニューポートレット)です。

ポートレットで利用可能な認証連携サービスが登録されている場合、ポートレットで利用可能な認証連携サービスの情報がJSON形式で返されます。各項目の説明は[ポートレットで利用可能な認証連携サービス登録]を参照してください。