2.13 ciwsetenv(環境の構築または削除)
形式
-
形式1(環境を構築する場合)
ciwsetenv -sid <system_id> -f <file_name>
-
形式2(環境を削除する場合)
ciwsetenv -sid <system_id> -del
-
形式3(環境をバージョンアップする場合)
ciwsetenv -sid <system_id> -vup <file_name>
-
形式4(オプションファイルを指定して実行する場合)※
ciwsetenv -file <option_file_name> [-encoding <character_set>]
-
形式5(コマンドの形式を表示する場合)※
ciwsetenv -h
- 注※
-
すべてのコマンドで同じ形式で指定します。詳細は,「1.5 コマンド共通のオプション」を参照してください。
機能
CSCIWの実行環境を構築,削除またはバージョンアップします。
-
環境を構築する場合
CSCIWの実行環境に必要な項目のデフォルト値を設定し,システムIDの設定情報を登録します。なお,このコマンドをほかのマシンで実行している場合は,システムIDの設定情報だけが,自マシンに登録されます。
環境構築の概要を次の図に示します。
図2‒3 環境構築の概要 図中の数字は,次に示す説明の項番と対応しています。
-
環境構築ファイルを作成します。環境構築ファイルに設定する項目については,「環境構築ファイル」を参照してください。
-
ciwsetenvコマンド(-fオプション)を実行すると,指定した環境構築ファイルを基に環境が構築されます。
ワーク管理データベースにシステム共通環境情報のデフォルト値が設定され,システム設定プロパティファイルにシステムIDの設定情報が登録されます。
-
ほかのマシンですでに環境の構築を実行している場合,ciwsetenvコマンド(-fオプション)を実行すると,自マシンのシステム設定プロパティファイルにシステムIDの設定情報だけが登録されます。
ワーク管理データベースのデフォルト値は設定されません。
-
-
環境を削除する場合
システムIDの設定情報を削除します。
環境削除の概要を次の図に示します。
図2‒4 環境削除の概要 図中の数字は,次に示す説明の項番と対応しています。
-
ciwsetenvコマンド(-delオプション)を実行すると,自マシンのシステム設定プロパティファイルに設定されているシステムIDの設定情報が削除されます。
-
-
環境をバージョンアップする場合
システムIDの設定情報および各種データを更新します。また,システム設定プロパティファイルを更新します。
バージョンアップは,環境を構築したすべてのマシンで実行してください。
また,バージョンアップを実行する前に,バージョンアップ用のSQLスクリプトファイルを実行し,ワーク管理データベースのテーブルをバージョンアップしてください。テーブルをバージョンアップする手順については,マニュアル「uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド」を参照してください。
環境のバージョンアップの概要を次の図に示します。
図2‒5 環境のバージョンアップの概要 図中の数字は,次に示す説明の項番と対応しています。
-
環境構築ファイルに環境構築時と同じ内容を指定します。環境構築ファイルに設定する項目については,「環境構築ファイル」を参照してください。
-
ciwsetenvコマンド(-vupオプション)を実行すると,環境がバージョンアップされます。
ワーク管理データベースのシステム共通環境情報および各データ(インスタンス情報など)が更新されます。また,システム設定プロパティファイルに登録されているシステムIDの設定情報が更新されます。
-
ほかのマシンですでに環境のバージョンアップを実行している場合,ciwsetenvコマンド(-vupオプション)を実行すると,自マシンのシステム設定プロパティファイルに登録されているシステムIDの設定情報だけが更新されます。
ワーク管理データベースの情報は更新されません。
-
実行条件
このコマンドを実行できるコンポーネントの稼働状態を次に示します。
コンポーネント |
稼働状態 |
|
---|---|---|
起動中 |
停止中 |
|
CSCIWManagementServer |
×※1 |
○ |
案件運用操作 |
×※1 |
○ |
CSCIWライブラリを使用した業務アプリケーション(J2EEアプリケーション) |
×※1 |
○ |
CSCIWライブラリを使用した業務アプリケーション(Javaアプリケーション) |
×※1 |
○ |
アプリケーション呼び出しサービス |
×※1 |
○ |
RESTサービス |
×※1 |
○ |
運用管理RESTサービス |
×※1 |
○ |
同一マシンでのほかのコマンド |
× |
○ |
異なるマシンでの同一コマンド |
○ |
○ |
異なるマシンでのほかのコマンド |
○ |
○ |
DBMS |
○ |
×※2 |
- (凡例)
-
○:コマンドを実行できます。
×:コマンドを実行できません。
- 注※1
-
異なるマシンで起動している場合は,起動中でもコマンドを実行できます。
- 注※2
-
-delオプション指定時は,停止中でもコマンドを実行できます。
引数
- -sid <system_id>
-
システムIDを指定します。指定したシステムIDの環境を構築または削除します。
指定できる値は,半角英大文字と半角数字で5文字以内です。ただし,先頭には半角英大文字を指定してください。
- -f <file_name>
-
環境構築時に必要な項目が設定されている環境構築ファイルの名称を指定します。指定した環境構築ファイルの内容に従って環境が構築されます。
環境構築ファイルに設定する項目については,「環境構築ファイル」を参照してください。
- -del
-
指定したシステムIDの環境を削除する場合に指定します。
なお,このオプションでは,DBMSの情報を削除できません。スキーマ,テーブルおよびインデクスは,DBMSの機能を使用して削除してください。
また,-delオプションを指定して環境を削除する前に,ciwlistsidコマンドを使用して異常終了したプロセスが存在しないことを確認してください。ciwlistsidコマンドの詳細は,「2.7 ciwlistsid(システムID情報の表示)」を参照してください。
異常終了したプロセスが存在する場合は,ciwcleanupコマンドでプロセス情報を正常化したあと,環境を削除してください。ciwcleanupコマンドの詳細は,「2.4 ciwcleanup(プロセス情報の正常化)」を参照してください。
- -vup <file_name>
-
環境をバージョンアップする場合に指定します。
環境構築ファイルは,環境構築時と同じ内容を指定します。
このオプションを実行すると,システム設定プロパティファイルの内容は,指定した環境構築ファイルの内容に書き換えられます。ただし,SystemDBTypeの値だけは書き換えられません。異なるSystemDBTypeを指定した場合はエラーになります。必ず,環境構築時の環境構築ファイルと同じ内容を指定してください。
環境構築ファイルに設定する項目については,「環境構築ファイル」を参照してください。
- -file <option_file_name>
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -encoding <character_set>
-
このオプションはすべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -h
-
このオプションはすべてのコマンドで指定できます。詳細は,「1.5.2 -hオプション」を参照してください。
戻り値
戻り値 |
内容 |
---|---|
0 |
正常終了 |
1 |
致命的なエラー |
9※ |
実行権限エラー |
51 |
パラメーター不正 |
100 |
環境不正 |
150 |
ファイルアクセスエラー |
254 |
異常終了 |
- 注※
-
Windowsの場合だけ発生します。
環境構築ファイル
環境構築ファイルはプロパティファイル形式で指定します。書式はJavaのプロパティファイルの仕様に従います。
値に「\」(半角円記号)を指定する場合は,「\」の前に「\」をエスケープ文字として指定してください。また,ファイルのエンコーディングはUTF-8とし,BOMを付けないで保存してください。
CSCIW 02-20以前で使用していた環境構築ファイル(Unicode形式のファイルを含む)を,そのまま使用することもできます。
環境構築ファイルに設定する項目を次の表に示します。
設定項目 |
内容 |
---|---|
SystemDBType |
使用するDBMSの種類を指定します。※ DBMSの種類には,「HiRDB」,「Oracle」,「SQLServer」または「PostgreSQL」を指定してください。 |
SystemDBURL |
JDBCのURLを指定します。URLについては,使用するDBMSのマニュアルを参照してください。 |
SystemDBDriverName |
使用するJDBCドライバの名称を指定します。JDBCドライバの詳細は,使用するDBMSのマニュアルを参照してください。 |
SystemDBUser |
CSCIWのテーブルを作成した認可識別子またはユーザ名を指定します。ここで指定した文字列が認可識別子またはユーザ名としてそのまま使用されるため,DBMSの仕様に従って指定してください。例えば,大文字小文字を区別する場合,HiRDBまたはOracleでは「"」で囲む必要がありますが,SQL ServerまたはPostgreSQLでは「"」で囲む必要はありません。 |
SystemDBPassword |
CSCIWのテーブルを作成した認可識別子またはユーザのパスワードを指定します。ここで指定した文字列が認可識別子またはユーザのパスワードとしてそのまま使用されるため,DBMSの仕様に従って指定してください。例えば,大文字小文字を区別する場合,HiRDBまたはOracleでは「"」で囲む必要がありますが,SQL ServerまたはPostgreSQLでは「"」で囲む必要はありません。 |
DBCharacterName |
CSCIWが使用するDBMSの文字セットに対応した,Javaでサポートされているエンコーディングの正準名を指定します。
|
SystemDBSchemaName |
CSCIWのテーブルを作成したスキーマ名を指定します。 指定した文字列の大文字小文字を区別する場合は,使用するDBMSの種類に関係なく,文字列を「"」(半角ダブルクォーテーション)で囲む必要があります。「"」で囲まなかった場合は,使用するDBMSによって,次を指定したとして扱われます。 HiRDB,OracleまたはSQL Serverの場合:すべて大文字 PostgreSQLの場合:すべて小文字 なお,スキーマ名は省略できます。省略した場合,SystemDBUserに指定した値がスキーマ名として設定されます。ただし,「"」を使用できないDBMSで大文字小文字を区別する必要があるときは,SystemDBUserで指定した値と,SystemDBSchemaNameで指定する値が同一の場合でも,SystemDBSchemaNameの指定は省略できません。 |
- 注※
-
使用するDBMSの種類が「HiRDB」または「SQLServer」のときに,環境構築ファイルの「SystemDBType」に「Oracle」を指定していても,コマンド実行時にエラーにならないで,環境構築ファイルの指定値で環境が構築されます。この場合,次に示す手順で対処してください。対処しないときは,そのあとの動作を保証できません。
-
このコマンドを実行し,構築した環境を削除します。
-
環境構築ファイルの「SystemDBType」の指定値を修正します。
-
このコマンドを実行し,環境を構築します。
-
- ヒント
-
環境構築ファイルのひな形として次のファイルを使用できます。
-
Windowsの場合
<CSCIWインストールディレクトリ>\sample\ciwsetenvInputInfo.properties
-
UNIXの場合
/opt/hitachi/CSCIW/sample/ciwsetenvInputInfo.properties
-
環境構築ファイルの設定例を次に示します。
- 例1(使用するDBMSの種類がHiRDBの場合)
-
SystemDBType=HiRDB SystemDBURL=jdbc:hitachi:hirdb://DBID=22200,DBHOST=hostA SystemDBDriverName=JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver SystemDBUser=USER1 SystemDBPassword=XXXXX DBCharacterName=UTF8
- 例2(使用するDBMSの種類がOracleの場合)
-
SystemDBType=Oracle SystemDBURL=jdbc:oracle:thin:@XX.XXX.XXX.XXX:1521:ORACLE10g SystemDBDriverName=oracle.jdbc.driver.OracleDriver SystemDBUser=USER1 SystemDBPassword=XXXXX DBCharacterName=UTF8
- 例3(使用するDBMSの種類がSQL Serverの場合)
-
SystemDBType=SQLServer SystemDBURL=jdbc:sqlserver://XXX.XXX.XXX.XXX:1433;selectMethod=cursor; SystemDBDriverName=com.microsoft.sqlserver.jdbc.SQLServerDriver SystemDBUser=USER1 SystemDBPassword=XXXXX SystemDBSchemaName=YYYYYY DBCharacterName=MS932
- 例4(使用するDBMSの種類がPostgreSQL場合)
-
SystemDBType=PostgreSQL SystemDBURL=jdbc:postgresql://XXX.XXX.XXX.XXX:5432/postgres SystemDBDriverName=org.postgresql.Driver SystemDBUser=USER1 SystemDBPassword=XXXXX SystemDBSchemaName=YYYYYY DBCharacterName=MS932
注意事項
このコマンドは,異なるシステムIDを指定しても,同一マシンで同時に実行できません。