ポートレット
ポートレットのコマンド
ポートレット用Webコンテンツの一覧表示：call_list
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./call_list [-group{GID}] [-format{list}] [-help] |
| 実行内容 | INSUITE®に登録されているポートレット用Webコンテンツを一覧表示します。 formatに指定するスイッチ一覧をご参照ください。 |
call_listのオプション説明
| オプション | 詳細 |
|---|---|
| 無し | INSUITE®に登録されている全てのポートレット用Webコンテンツを表示する。 |
| -group{GID} | {GID}に、グループの識別番号であるGIDを指定する。指定したグループに登録されているポートレット用Webコンテンツを表示する。 |
| -format{list} | {list}に、表示する情報に適したスイッチを指定する。 |
| -help | コマンドのヘルプを表示する。 |
formatに指定するスイッチ一覧
| スイッチ | 表示する情報 |
|---|---|
| i | ポートレット用WebコンテンツのID |
| s | ポートレット用Webコンテンツのログイン定義ID |
| g | ポートレット用Webコンテンツの登録グループ識別番号（GID） |
| d | 対象デバイス(「1:トップページ」「2:携帯電話」「3:PDA」「4:スマートページ」) |
| u | ポートレット用WebコンテンツのＵＲＬ |
| v | ポータルでの表示回数 |
| t | ポートレット用Webコンテンツのタイトル |
ポートレット用Webコンテンツのエクスポート：call_export
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./call_export < -id {ID} > < -out {PATH} > [-with_sso] [-oe (Shift_JIS|EUC-JP|UTF-8)] [-help] |
| 実行内容 | INSUITE® に登録されているポートレット用Webコンテンツをエクスポートします。call_exportコマンドで出力したデータをインポートするには、call_importコマンドを使用します（ただし、call_importは検証環境から本番環境への定義の移行等を想定したコマンドであるため、インポート先のINSUITE®にすでに定義済みのポートレットの定義を上書きするものではありません。必ず新規登録扱いになります）。 （call_exportコマンドでエクスポートされる情報内容およびデータフォーマットは下表をご参照ください。） |
call_exportのオプション説明
| オプション | 詳細 |
|---|---|
| -id{ID} | ◎必須項目。{ID}にエクスポート対象となるポートレット用WebコンテンツのＩＤを指定する。IDが不明の場合、call_listコマンドで取得できる。 |
| -out{PATH} | ◎必須項目。{PATH}にエクスポートするファイルのディレクトリパスを指定する。 |
| -with_sso | ログイン定義情報も出力する。 |
| -oe | 出力する定義ファイルの文字コードを指定する。 --- Shift_JIS : Shift_JISで出力 EUC-JP : EUC-JPで出力 UTF-8 : UTF-8で出力 --- ※省略した場合は、設定ファイル/home/DreamArts/data/system/command.datのパラメータdefault_oeで指定した文字コードが使用されます。 |
| -help | コマンドのヘルプを表示する。 |
ポートレット用Webコンテンツのインポート：call_import
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./call_import < -user{MID} > < -in{PATH} > [ |
| 実行内容 | INSUITE®にポートレット用Webコンテンツをインポートします。 「ポートレットのインポート用データのフォーマット」の項目をKEY＜TAB＞VALUEもしくはKEY＝VALUEの形式で設定したファイルでなくてはいけません。 |
call_importのオプション説明
| オプション | 詳細 |
|---|---|
| -user {MID} | ◎必須項目。{MID}にポートレット用Webコンテンツの登録ユーザとなるユーザの識別番号（MID）を指定する。 |
| -in {PATH} | ◎必須項目。{PATH}にインポート用データファイルのパスを指定する。 |
| -group | 登録するグループ識別番号（GID）を指定する。 |
| -sso_num | 登録するログイン定義番号を指定する。 |
| -device | 登録するポートレットタイプを指定する。 (「1: トップページ」 「2: 携帯電話」 「3: PDA」 「4: スマートページ」) |
| -force | インポート時、中間プログラム登録コード（insuite_codeで指定する値）が既に存在する場合、上書きを行う。insuite_codeで指定した値は、中間プログラムやイメージファイルをコピーするディレクトリ名として利用される。インポートする際に-forceオプションをつけると既存のディレクトリに対し上書きを実行する。オプション無しの場合、コピーを行わない。 |
| -ie | 入力する定義ファイルの文字コードを指定する。 --- Shift_JIS : Shift_JISで登録 EUC-JP : EUC-JPで登録 UTF-8 : UTF-8で登録 --- ※省略した場合は、設定ファイル/home/DreamArts/data/system/command.datのパラメータdefault_ieで指定した文字コードが使用されます。 |
| -help | コマンドのヘルプを表示する。 |
ポートレットのインポート用データのフォーマット
| KEY | VALUE | 可能な値 |
|---|---|---|
| agent | HTTP_USER_AGENT環境変数に設定する値を指定する。ただし、ここで設定した値はインラインフレームを使用しない場合にのみ有効。 | 半角英数50文字 以内。 |
| cache_on | トップページに読み込むポートレット用WebコンテンツのデータをINSUITE®サーバ上にキャッシュするか否かを指定する。 但し、この設定値はインラインフレームを使用しない場合にのみ有効。 0:キャッシュしない 1:キャッシュする |
0もしくは1を指定。 省略時は「0」が設定される。 |
| cache_embed | HTML埋め込み形式でのフィルタ使用フラグを指定する。 0:使用しない 1:使用する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| cache_frame | インラインフレーム形式でのフィルタ使用フラグを指定する。 0:しない 1:使用する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| cache_time | キャッシュの有効期間を指定する。 | 値は10分を「1」として指定する。【例】30分の場合は「3」、3時間の場合は「18」 |
| device | ポートレットの対象となるデバイスを指定する。 一度に複数指定する場合、カンマ（,）区切りで指定する。指定した値は全ユーザの「各種設定」-「ポートレット」画面に反映される。 1:トップページ 2:携帯電話 3:PDA 4:スマートページ |
1,2,3,4のいずれかを指定。 省略時は「1」が設定される。 |
| frame | ポートレット用WebコンテンツをINSUITE®のトップページにインラインフレームを使用して表示するか否かを指定する。 0:インラインフレームを使用しない 1:インラインフレームを使用する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| gid | ポートレット用Webコンテンツを登録するグループの識別番号(GID)を指定する。 | 整数7桁。 省略時は「2000000」（組織トップ）が指定される。 |
| height | インラインフレームの高さをピクセル単位で指定する。 | 数値を指定。 省略時は50が設定される。 |
| insuite | INSUITE®ユーザの識別番号を引数として渡すか否かを指定する。 0:渡さない 1:引数として渡す 「1:引数として渡す」を指定すると、セッション情報からこのユーザ識別番号を取得し、ポートレット用Webコンテンツ側に識別番号を引き渡すことができる。ポートレット用Webコンテンツ側には、例のような形式でユーザ識別番号が渡される。 【例】insuite=1000062 |
0もしくは1を入力。 省略時は「0」が設定される。 |
| insuite_code | ◎中間プログラムをINSUITE®サーバ内に保存する場合は、必須。中間プログラムの登録コードを指定する。insuite_codeで指定した値は次のディレクトリのサブディレクトリ名となる。 /home/DreamArts/cgi-bin/custom/{insuite_code} /home/DreamArts/images/custom/{insuite_code} このサブディレクトリに、中間プログラムおよび中間プログラムで使用するイメージファイルがコピーされる。 |
半角英数50文字以内。 |
| kanji_code | 次の日本語の文字コードを「JIS」、「SJIS」、「EUC」のいずれかより指定する。 ・INSUITE®から出力されるリクエスト内の日本語 ・ポートレット用Webコンテンツ側からのレスポンスとして返されるHTML内の日本語 |
SJIS,EUC,JISのいずれかを指定。 省略時は「SJIS」が設定される。 |
| method | CGI等に対するリクエストメソッドを「GET」、「POST」のいずれかより指定する。 インラインフレームを使用する場合は、常にGETメソッドが使用される。 |
GETもしくはPOSTを指定。 省略時は｢GET｣が設定される。 |
| style | 表示形式を指定する。 0:内容を表示する 1:リンク行を表示する |
0もしくは1を入力。 省略時は「0」が設定される。 |
| sso_num | ログイン定義ID。コマンドラインのsso_numオプションで指定された値で上書きされる。 | 整数 |
| sso_login | ブラウザログインを実行するフラグを指定する。 0:実行しない 1:実行する |
0もしくは1を入力。 省略時は「0」が設定される。 |
| sso_view | ログイン直後のページを表示するフラグを指定する。 0:表示しない 1:表示する |
0もしくは1を入力。 省略時は「0」が設定される。 |
| sso_view_filter | ログイン後のページにフィルタ設定を適用するフラグを指定する。 0:適用しない 1:適用する |
0もしくは1を入力。 省略時は「0」が設定される。 |
| timeout | INSUITE®がポートレット用Webコンテンツにリクエストを出した後、レスポンスが返るまでの待機時間を秒数で指定する。ただし、この設定値はインラインフレームを使用しない場合にのみ有効。 | 数値を指定。 省略時は5(秒)が設定される。 |
| title | ◎必須項目。ポートレット用Webコンテンツの登録名を指定する。 | 全角50文字以内。 |
| url | ◎必須項目。ポートレット用WebコンテンツのURLを指定する。 中間プログラムをINSUITE®サーバ内に保存する場合、次の形式で指定する。 http://{host}/cgi-bin/custom/{code}/{program}.cgi |
半角英数250文字以内。 |
| key1-9 | 引数1（～9）の引数名を入力する。 | 半角英数50文字以内。 |
| value1-9 | 引数1（～9）の引数値（デフォルト値）を入力する。 | 半角英数500文字以内。 |
| label1-9 | 引数1（～9）のラベルを入力する。 | 全角50文字以内。 |
| permit1-9 | 引数1（～9）のユーザ設定を許可するか否かを指定する。 0:許可しない 1:許可する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| crypt1-9 | 引数1（～9）の暗号化をするか否かを指定する。 0:暗号化しない 1:暗号化する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_auth | 「リンクにBASIC認証IDを埋め込む」フラグを使用するか否かを指定する。 0:埋め込まない 1:埋め込む |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_frame | INSUITE®の標準フレームを使用するか否かを指定する。 0:使用しない 1:使用する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_iframe | 「IFRAMEタグを無視する」フラグを使用するか否かを指定する。 0:無視しない 1:無視する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_param | ポートレット用WebコンテンツとしてHTMLページの一部を登録する場合、そのパラメータを指定する。 | 半角英数 |
| filter_replace | 「予約語を置換して出力する」フラグを使用するか否かを指定する。 0:置換しない 1:置換する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_script | 「スクリプトを無視する」フラグを使用するか否かを指定する。 0:無視しない 1:無視する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_target | 「リンク先を新しいウィンドウで表示する」フラグを使用するか否かを指定する。 0:表示しない 1:表示する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| filter_url | 「相対URLパスを絶対URLパスに変換する」フラグを使用するか否かを指定する。 0:変換しない 1:変換する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| header_path | 登録するポートレットのヘッダHTMLファイルのパス名を指定する。 | |
| footer_path | 登録するポートレットのフッタHTMLファイルのパス名を指定する。 | |
| explain_path | 登録するポートレットの説明文ファイルのパス名を指定する。 | |
| start_path | 登録するポートレットのコンテンツ・ヘッダHTMLファイルのパス名を指定する。 | |
| separator_path | 登録するポートレットのコンテンツ・セパレータHTMLファイルのパス名を指定する。 | |
| end_path | 登録するポートレットのコンテンツ・フッタHTMLファイルのパス名を指定する。 | |
| cgi_path | ◎中間プログラムをINSUITE®サーバ内に保存する場合、必須。中間プログラムの保存先ディレクトリを指定する。中間プログラムは、次の場所にコピーされる。 /home/DreamArts/cgi-bin/custom/{insuite_code} |
|
| img_path | ◎中間プログラムをINSUITE®サーバ内に保存する場合、必須。中間プログラムで使用するイメージファイルの保存先ディレクトリを指定する。イメージファイルは、次の場所にコピーされる。 /home/DreamArts/images/custom/{insuite_code} |
ポートレット用ログイン定義の一覧表示：sso_list
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./sso_list [-group{GID}] [-format{list}] [-help] |
| 実行内容 | INSUITE®に登録されているポートレット用ログイン定義を一覧表示します。 formatに指定するスイッチ一覧をご参照ください。 |
sso_listのオプション説明
| オプション | 詳細 |
|---|---|
| 無し | INSUITE®に登録されている全てのポートレット用ログイン定義を表示する。 |
| -group{GID} | {GID}に、グループの識別番号であるGIDを指定する。指定したグループに登録されているポートレット用Webコンテンツを表示する。 |
| -format{list} | {list}に、表示する情報に適したスイッチを指定する。 |
| -help | コマンドのヘルプを表示する。 |
formatに指定するスイッチ一覧
| スイッチ | 表示する情報 |
|---|---|
| i | ログイン定義のID |
| g | ログイン定義の登録グループ識別番号（GID） |
| t | ログイン定義のタイトル |
| l | ログイン定義のログインページURL |
| a | ログイン定義の認証アクションURL |
ポートレット用ログイン定義のエクスポート：sso_export
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./sso_export < -id{ID} > < -out{PATH} > [-oe(Shift_JIS|EUC-JP|UTF-8)][-help] |
| 実行内容 | INSUITE® に登録されているポートレット用ログイン定義をエクスポートします。sso_exportコマンドで出力したデータをインポートするには、sso_importコマンドを使用します。（sso_exportコマンドでエクスポートされる情報内容およびデータフォーマットは「sso_exportのオプション説明」をご参照ください。） |
sso_exportのオプション説明
| オプション | 詳細 |
|---|---|
| -id{ID} | ◎必須項目。{ID}にエクスポート対象となるポートレット用ログイン定義のＩＤを指定する。IDが不明の場合、sso_listコマンドで取得できる。 |
| -out{PATH} | ◎必須項目。{PATH}にエクスポートするファイルのディレクトリパスを指定する。 |
| -oe | 出力する定義ファイルの文字コードを指定する。 --- Shift_JIS : Shift_JISで出力 EUC-JP : EUC-JPで出力 UTF-8 : UTF-8で出力 ※省略した場合は、設定ファイル/home/DreamArts/data/system/command.datのパラメータdefault_oeで指定した文字コードが使用されます。 |
| -help | コマンドのヘルプを表示する。 |
ポートレット用ログイン定義のインポート：sso_import
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./sso_import < -user{MID} > < -in{PATH} > [-force][-ie(Shift_JIS|EUC-JP|UTF-8)][-help] |
| 実行内容 | INSUITE®にポートレット用ログイン定義をインポートします。 「ログイン定義のインポート用データのフォーマット」の項目をKEY＜TAB＞VALUEもしくはKEY＝VALUEの形式で設定したファイルでなくてはいけません。 |
sso_importのオプション説明
| オプション | 詳細 |
|---|---|
| -user{MID} | ◎必須項目。{MID}にポートレット用ログイン定義の登録ユーザとなるユーザの識別番号（MID）を指定する。 |
| -in{PATH} | ◎必須項目。{PATH}にインポート用データファイルのパスを指定する。 |
| -group | 登録するグループ識別番号（GID）を指定する。 |
| -ie | 入力する定義ファイルの文字コードを指定する。 Shift_JIS : Shift_JISで登録 EUC-JP : EUC-JPで登録 UTF-8 : UTF-8で登録 ※省略した場合は、設定ファイル/home/DreamArts/data/system/command.datのパラメータdefault_ieで指定した文字コードが使用されます。 |
| -help | コマンドのヘルプを表示する。 |
ログイン定義のインポート用データのフォーマット
| KEY | VALUE | 可能な値 |
|---|---|---|
| init_url | ログインページURLを指定する。 | 半角英数256文字以内。 |
| login_url | 認証アクションURLを指定する。 | 半角英数256文字以内。 |
| agent_url | CookieAgent URLを指定する。 | 半角英数256文字以内。 |
| basic_pass | BASIC認証用パスワードを指定する。 | 半角英数10文字以内。 |
| basic_user | BASIC認証用IDを指定する。 | 半角英数10文字以内。 |
| basic_change | BASIC認証用IDおよびパスワードのユーザ設定を許可するか否かを指定する。 0: 許可しない 1: 許可する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| gid | ポートレット用ログイン定義を登録するグループの識別番号(GID)を指定する。 | 整数7桁。 省略時は「2000000」（組織トップ）が指定される。 |
| ｋanji_ code | 次の日本語の文字コードを「JIS」、「SJIS」、「EUC」のいずれかより指定する。 | SJIS,EUC,JISのいずれかを指定。 省略時は「SJIS」が設定される。 |
| method | CGI等に対するリクエストメソッドを「GET」、「POST」のいずれかより指定する。 | GETもしくはPOSTを指定。省略時は｢GET｣が設定される。 |
| timeout | INSUITE® がポートレット用Webコンテンツにリクエストを出した後、レスポンスが返るまでの待機時間を秒数で指定する。 | 数値を指定。 省略時は5(秒)が設定される。 |
| title | ◎必須項目。ポートレット用ログイン定義の登録名を指定する。 | 全角50文字以内。 |
| hidden_over | INPUTタグの値を継承するか否かを指定する。 0: 継承しない 1: 継承する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| key1-9 | 引数1（～9）の引数名を入力する。 | 半角英数50文字以内。 |
| value1-9 | 引数1（～9）の引数値（デフォルト値）を入力する。 | 半角英数500文字以内。 |
| label1-9 | 引数1（～9）のラベルを入力する。 | 全角50文字以内。 |
| permit1-9 | 引数1（～9）のユーザ設定を許可するか否かを指定する。 0: 許可しない 1: 許可する |
0もしくは1を指定。 省略時は「0」が設定される。 |
| crypt1-9 | 引数1（～9）の暗号化をするか否かを指定する。 0: 暗号化しない 1: 暗号化する |
0もしくは1を指定。 省略時は「0」が設定される。 |
ポートレットのコピー：call_cpgrp
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./call_cpgrp < -from {GID} > < -to {GID} > [-help] |
| 実行内容 | グループに設定されているポートレット情報を他のグループにコピーします。 |
call_cpgrpのオプション説明
| オプション | 詳細 |
|---|---|
| -from {GID} | ◎必須項目。{GID}にコピー元のグループIDを指定する。 |
| -to {GID} | ◎必須項目。{GID}にコピー先のグループIDを指定する。 |
| -help | コマンドのヘルプを表示する。 |
ポートレットの削除：call_delgrp
| ファイルパス | /home/DreamArts/cmd |
| 実行コマンド | ./call_delgrp < -gid {GID} > [-help] |
| 実行内容 | グループに設定されているポートレット情報を削除します。 |
call_delgrpのオプション説明
| オプション | 詳細 |
|---|---|
| -gid {GID} | ◎必須項目。{GID}にポートレットを削除するグループIDを指定する。 |
| -help | コマンドのヘルプを表示する。 |