managed-settings.xml ファイルでの設定の定義

以下の手順に従って、 managed-settings.xml ファイルで設定を定義します。

このタスクについて

これは XML ファイルであり、XML ファイルのルールが適用されます。さらに、以下の項目を考慮する必要があります。

ファイル内に余分なブランク行を作成しない。
コメントを使用するには、行の先頭にハッシュタグ (#) を入力します。
タブ・キーを使用して行をインデントするのではなく、2 つのスペースを使用してください。
ページから一部のエンコードをコピーしてファイルのエラーを引き起こす場合があるため、ヘルプ・センターからテキストをコピーしてファイルで使用しないでください。
XML エディタを使用すると便利ですが、プレーン・テキスト・エディタも使用できます。プレーン・テキスト・エディタを使用する場合は、保存時にファイル拡張子を確認することが重要です (.txt ではなく.xml である必要があります)。

トラブルシューティング記事には、managed-settings.xml ファイルの例が添付されています。このファイルを使用して、新しい設定を作成する代わりに管理対象設定をテストできます。

この手順では、managed-settings.xml を作成し、7 日間チャットを自動的に保存するためのチャット履歴設定を定義する方法を示します。

手順

「managed-settings.xml」という名前の UTF-8 エンコードを使用してファイルを新規作成します。

注: 他のファイル名はサポートされていません。
開始ステートメントと終了ステートメントをファイルに入れます。
```
<?xml version="1.0"?> 

<ManagedSettings> 

 

</ManagedSettings>
```
<ManagedSettings> タグの間に設定を定義する必要があります。そのため、ファイルの最後の行は </ManagedSettings>になります。
定義可能な設定を確認します。この例ではチャットのロギング設定を変更します。

注: 他の設定を定義することもできます。この例では構文のデモンストレーションのみを行います。

<ManagedSettings> タグの間に settingGroup タグを入れます。

<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name=""> 

 

</settingGroup> 

</ManagedSettings>

設定資料のページでは、一部の表に settingGroup の名前が示されています。たとえば、チャット設定の表 2 はチャット履歴設定用です。settingGroup 名は com.ibm.collaboration.realtime.chat.logging です。この例で使用される設定は、「days.storage.max」と「logging.default」です。これにより、クライアント側のすべてのチャットを自動的にログに記録し、7 日間保持するようにユーザーのクライアントが構成されます。
settingGroup の名前を <settingGroup name=””> タグに入力します。
```
<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name="com.ibm.collaboration.realtime.chat.logging"> 

 

</settingGroup> 

</ManagedSettings> 
```
(settingGroup タグ内に配置される) 設定を定義する場合、いくつかのオプションがあります。設定名については表を参照してください。
上記の例で使用されている 2 つの設定は「days.storage.max」と「logging.default」です。これらは <setting name=”” value=””/> というタグで定義されます。これらの行は 2 つのスペースでインデントされています。
```
<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name="com.ibm.collaboration.realtime.chat.logging"> 

  <setting name=”logging.default” value=”0”/> 

  <setting name=”days.storage.max” value=”7”/> 

</settingGroup> 

</ManagedSettings> 
```
同じファイル内の他の settingGroups の設定を定義できます。スペースのフォーマットは同じにしてください。たとえば、デフォルトでグループをアルファベット順にソートするには、連絡先リストの設定を追加します。これらの設定については、連絡先リスト設定のトピックを参照してください。

ヘルプ・センターのトピックを開き、 settingGroup 名を見つけます。

設定名を見つけます。

新しい settingGroup を追加し、最初の settingGroup の下に設定名を追加します。
```
<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name="com.ibm.collaboration.realtime.chat.logging"> 

  <setting name=”logging.default” value=”0”/> 

  <setting name=”days.storage.max” value=”7”/> 

</settingGroup> 

<settingGroup name="com.ibm.collaboration.realtime.imhub"> 

  <setting name=”sortGroups” value=”true”/> 

</settingGroup> 

</ManagedSettings> 
```
オプションの機能を有効にします。
<settingGroup> タグには「lastModDate」という属性があります。これがある場合、設定グループを変更するたびに lastModDate 属性を変更する必要があります。この属性を変更しないと、新しい値が更新されません。「lastModDate」属性を使用しない場合、値は新しくなくても常に更新されます。

lastModDate タイムスタンプを使用する場合、形式は

java.text.SimpleDateFormat にします。構文は YYYYMMDDThhmmss (YYYY=年、MM=月、DD=日、hh=時間、mm=分、ss=秒) です。T に続く値はオプションです。
この例を以下に示します。
```
<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name="com.ibm.collaboration.realtime.chat.logging" lastModDate=”2021-02-11T17:39:21-05”> 

  <setting name=”logging.default” value=”0”/> 

  <setting name=”days.storage.max” value=”7”/> 

</settingGroup> 

</ManagedSettings> 
```
各 <setting> タグには、以下のオプションの属性を指定できます。
- isLocked - ブール。デフォルト値は true です。true の場合、設定は読み取り専用になり、管理者によって設定された値に対してユーザーまたはアプリケーションが行う変更は阻止されるか後で上書きされます。この属性が false に設定されている場合、管理者の設定は、ユーザーが変更可能なデフォルト値として扱われます。
```
<?xml version="1.0"?> 

<ManagedSettings> 

<settingGroup name="com.ibm.collaboration.realtime.chat.logging"> 

  <setting name=”logging.default” value=”0” isLocked=”false”/> 

  <setting name=”days.storage.max” value=”7” isLocked=”true”/> 

</settingGroup> 

</ManagedSettings> 
```
  上記の例では、ユーザーが設定を変更するまですべてのチャットが最初に自動的に保存され、チャット履歴は 7 日間保持されます。ロックされているため、ユーザーはこの設定を変更できません。
- overwriteUnlocked - ブール。デフォルト値は false です。デフォルトで、ロック解除されたものとして指定されている設定は、デフォルトとして扱われ、クライアント上の既存の値を上書きしません。これは、ユーザーが行った可能性のある適切な変更内容を元に戻さないようにするためのものです。ただし、これを true に設定すると、ロック解除されている値は、ユーザーの既存の値が削除されることになっても、この新しい値で上書きされます。
- restartRequired - ブール。デフォルト値は false です。この属性は、managed-settings.xml ファイルを使用してクライアント設定を自動更新する場合にのみ適用されます。この値を true に設定すると、管理対象設定の適用と同時にクライアントを再起動するためのユーザープロンプトが作成されます。この属性はオプションです。クライアントを再起動して設定をアクティブにする必要がある場合のみ、この属性を使用します。この属性を含む設定が更新された場合にのみ、再起動が行われます。
managed-settings.xml ファイルでフォーマット・エラーをテストします。ファイルを Web ブラウザーで開き、構文エラーがないことを確認します。エラーがある場合は、ファイルを編集して構文の問題を修正します。

次のタスク

managed-settings.xml ファイルまたは managed-community-configs.xml ファイルを Web サーバーにデプロイします。