文字列のローカライズとメッセージ・ディクショナリ

メッセージ・ディクショナリの格納

各ユーザ定義ネームスペースは、そのメッセージ・ディクショナリを ^IRIS.Msg という添え字付きグローバルに格納します。^IRIS.Msg の添え字の順序は、ドメイン、言語、およびメッセージ ID です。

ネームスペースの ^IRIS.Msg を表示するには、以下の手順に従います。

1. 管理ポータルを起動します。

2. 目的のネームスペースに切り替えます。

3. [システム・エクスプローラ]→[グローバル] をクリックします。

4. [IRIS.Msg] の行で、[表示] をクリックします。

例を以下に示します。

^IRIS.Msg("mydomain")="en"
^IRIS.Msg("mydomain","en",338288369)="sample string"
^IRIS.Msg("mydomain","en",3486914925)="another sample string"

<MsgFile> 要素

<MsgFile> 要素は、XML メッセージ・ファイルの最上位コンテナで、1 つのファイルに存在する <MsgFile> 要素は 1 つだけです。

<MsgFile> 要素には 1 つの必須属性 Language があります。<MsgFile> の Language 属性の値は、すべて大文字の RFC1766Opens in a new tab コードであり、ファイルの言語を識別します。 これは、1 つ以上の部分で構成されます。つまり、主言語タグ (en や ja) の後に、オプションでハイフン (-) で区切られた 2 番目の言語タグを (en-gb や ja-jp) 記述します。

以下の例では、この言語は "en" (英語) です。

<?xml version="1.0" encoding="utf-8" ?>
<MsgFile Language="en">
    <MsgDomain Domain="sample">
        <Message Id="source">Source</Message>
        <Message Id="menu">Samples Menu</Message>
    </MsgDomain>
</MsgFile>

<MsgFile> には <MsgDomain> 要素が少なくとも 1 つ含まれる必要があります。複数の <MsgDomain> を含めることができます。

<MsgDomain> 要素

<MsgDomain> 要素には 1 つの必須属性 Domain があります。<MsgDomain> の Domain 属性の値は、アプリケーションのメッセージを編成するために使用しているドメイン名の 1 つです。

<MsgDomain> 要素には、0 個以上の <Message> 要素を含めることができます。

<Message> 要素

<Message> 要素には 1 つの必須属性 Id があります。<Message> の Id 属性の値は、アプリケーションのメッセージを編成するために使用しているメッセージ ID 文字列の 1 つです。

<Message> 要素にはテキスト文字列を含めることができます。文字列は、以下の項目を個別に構成するか、組み合わせて構成することができます。

• 使用可能なファイル形式のシンプル・テキスト

• 置換引数 %1、%2、%3、または %4

• HTML 形式

• ObjectScript 形式の文字列表現

以下の例では、%1、%2、太字書式の HTML タグ、および連続する 2 つの二重引用符は 1 つの二重引用符を示すという ObjectScript の文字列規約を使用しています。

<Message>
  The session $Username="&lt;b&gt;%1&lt;/b&gt;" $Roles="&lt;b>%2&lt;/b&gt;"
</Message>

XML メッセージ・ファイルのインポート

XML メッセージ・ファイルをインポートするには、ターミナルを開いて以下の操作を行います。

1. アプリケーションを開発しているネームスペースに変更します。

    set $namespace = "myNamespace"
   

   

2. import コマンドを実行します。既定では、各言語は別個の XML メッセージ・ファイルになっており、ファイル名の末尾にロケール名が付いています。したがって、以下のようになります。

   • 特定の言語のメッセージのみをインポートできます。

      SET file="C:\myLocation\Messages_ja-jp.xml"
      DO ##class(%Library.MessageDictionary).Import(file)
     

     

   • または、同じアプリケーションに対して複数の言語をインポートします。

      SET myFiles="C:\myLocation"
      DO ##class(%Library.MessageDictionary).ImportDir(myFiles,"d")
     

     

3. 同じネームスペース内の ^IRIS.Msg グローバルを調べて結果を確認します。

以下のトピックでは、両方のインポート方法を簡単に説明します。

classmethod Import(filepath As %String, flag As %String = "") returns %Status

classmethod ImportDir(directory As %String, flag As %String = "") returns %Status

XML メッセージ・ファイルのエクスポート

メッセージ・ディクショナリを XML メッセージ・ファイルにエクスポートするには、ターミナル内で以下の操作を行います。

1. アプリケーションを開発しているネームスペースに変更します。

    set $namespace = "myNamespace"
   

   

2. 出力ファイルとその場所を特定します。

    SET file="C:\myLocation\Messages.xml"
   

   

3. export コマンドを実行します。

   • 特定のドメインにあるメッセージのみをエクスポートすることが実際的な場合があります。この場合は次のように指定します。

      DO ##class(%Library.MessageDictionary).ExportDomainList(file,"myDomain")
     

     

   • ネームスペースにあるすべてのメッセージをエクスポートするには次のように指定します。

      DO ##class(%Library.MessageDictionary).Export(file)
     

     

以下のトピックでは、両方のエクスポート方法を簡単に説明します。

classmethod ExportDomainList(file As %String, domainList As %String, language As %String) returns %Status

classmethod Export(file As %String, languages As %String = "", flag As %String = "") returns %Status

メッセージの削除

メッセージを削除するには、以下のコマンドを使用します。

 Set status = ##class(%MessageDictionary).Delete(languages,flag)

languages は、オプションの言語コンマ区切りリストです。languages が指定されていない場合、すべての言語が削除されます。既定値では、アプリケーション・メッセージのみが削除されます。s フラグ (system) は、システム・メッセージも削除するかどうかを示すオプションのフラグです。インクルード・ファイルに関連付けられているメッセージ名は常に削除されますが、インクルード・ファイルは削除されません。d フラグ (display) もサポートされます。

メッセージのリスト

指定されたドメインに対してメッセージが読み込まれるすべての言語のリストを取得するには、GetLanguages() メソッドを使用します。

 Set list = ##class(%MessageDictionary).GetLanguages(domain,flag)

GetLanguages() は、%ListofDateTypes 形式の言語コードのリストを返します。言語コードは標準の RFC1766Opens in a new tab 形式で、すべて小文字です。domain が指定されている場合、指定されたドメインに対して存在する言語のみがリストに含まれます。指定されていない場合、すべての言語がリストに含まれます。s フラグ (system) は、システム・メッセージまたはアプリケーション・メッセージのどちらでサポートされている言語を返すかを示すオプションのフラグです。既定値では、アプリケーション・メッセージの言語が返されます。d フラグ (display) もサポートされます。