インストール・マニフェストの作成および使用

親タグ ： <Invoke>、<Error>

<Invoke> または <Error> から呼び出されるメソッドに引数を渡します。

• Value—引数の値。

<Error Status="$$$NamespaceDoesNotExist">
        <Arg Value="${NAMESPACE}"/>
/>

親タグ ： <Configuration>

データベースからこの <Configuration> 項目を含むネームスペースへのクラス・マッピングを作成します。

• Package—マップするパッケージ。

• From—マッピングに使用するソース・データベース。

<ClassMapping Package="MYAPP"
     From="MYDB"/>

親タグ ： <Namespace>

%SYSTEM.OBJ.CompileOpens in a new tab(Class, Flags) を呼び出して、指定されたクラス名をコンパイルします。

• Class—コンパイルするクラスの名前。

• Flags—コンパイル・フラグ [ck]。

• IgnoreErrors—エラー時に続行するかどうかを指定します [0]。

<Compile  
    Class="MyPackage.MyClass"
    Flags="ck"
    IgnoreErrors=0/>

親タグ ： <Namespace>

子タグ ： <ClassMapping>、<Database>、<GlobalMapping>、<RoutineMapping>

<Namespace> 内で構成タグの親タグとして記述する必要があります。終了タグ (</Configuration>) は、ネームスペース内のデータベースのマッピングを有効化して、.cpf ファイルを更新します。

プロパティはありません。

<Configuration>
    <Database> . . . />
    <ClassMapping> . . . />
/>

親タグ ： <Namespace>

ソース・クラス定義をターゲットにコピーまたは移動します。

• Src—ソース・クラス。

• Target—ターゲット・クラス。

• Replace—ターゲット・クラスを上書きするかどうかを指定します [0]。

<CopyClass  
    Src="MyPackage.MyClass"
    Target="NewPackage.NewClass"
    Replace="0"/>

親タグ ： <Manifest>

ソース・ディレクトリをターゲットにコピーします。

• Src—ソース・ディレクトリ。

• Target—ターゲット・ディレクトリ。

• IgnoreErrors—エラー時に続行するかどうかを指定します [0]。

<CopyDir  
    Src="${MGRDIR}"
    Target="F:\MyTargetDir"
    IgnoreErrors="0"/>

親タグ ： <Manifest>

ソース・ファイルをターゲットにコピーします。

• Src—ソース・ファイル。

• Target—ターゲット・ファイル。

• IgnoreErrors—エラー時に続行するかどうかを指定します [0]。

<CopyFile  
    Src="${MGRDIR}\messages.log"
    Target="F:\${INSTANCE}_log"
    IgnoreErrors="0"/>

親タグ ： <Namespace>

Security.ApplicationsOpens in a new tab クラス内で定義されている 1 つ以上の Web アプリケーションを定義します (これらの各フィールドの詳細は、"アプリケーションの作成および編集" も参照してください)。

• AuthenticationMethods—有効な認証方法。(サポートされている認証方法と、対応する提供値については、"Security.Applications" の "AutheEnabled" プロパティを参照してください)。例えば、一般的に使用される値として、4=Kerberos、32=password、64=unauthenticated があります。

• AutoCompile—(CSP 設定で) 自動コンパイルするかどうかを指定します[1]。

• CSPZENEnabled—CSP/ZEN を有効にするかどうかを指定します [1]。

• ChangePasswordPage—パスワード変更ページへのパス。

• CookiePath—セッション cookie パス。

• CustomErrorPage—カスタム・エラー・ページへのパス。

• DefaultSuperclass—デフォルト・スーパークラス。

• DefaultTimeout—セッション・タイムアウト。

• Description—説明。

• Directory—CSP ファイルへのパス。

• EventClass—イベント・クラス名。

• Grant—システムにログインするときに割り当てられるロールのリスト。

• GroupById—ID でグループ化するかどうかを指定します。

• InboundWebServicesEnabled—着信 Web サービスを有効にするかどうかを指定します[1]。

• IsNamespaceDefault—ネームスペースの既定のアプリケーションかどうかを指定します[0]。

• LockCSPName—CSP名をロックするかどうかを指定します[1]。

• LoginClass—ログイン・ページへのパス。

• PackageName—パッケージ名。

• PermittedClasses—許可されるクラス。

• Recurse—繰り返す (サブディレクトリを提供する) かどうかを指定します[0]。

• Resource—Web アプリケーションにアクセスするために必要なリソース。

• ServeFiles—ファイルを提供するかどうかを指定します。[1]。

  • 0—提供しない

  • 1—常に提供する

  • 2—常に提供し、キャッシュする

  • 3—CSP セキュリティを使用する

• ServeFilesTimeout—静的ファイルをキャッシュする時間を秒単位で指定します。

• TwoFactorEnabled—2 ステップ認証を有効にするかどうかを指定します[0]。

• Url—Web アプリケーションの名前。

• UseSessionCookie—セッションに cookie を使用するかどうかを指定します。

<CSPApplication 
    Url="/csp/foo/bar"
    Description=""
    Directory="C\InterSystems\IRIS\CSP\Democode1"
    Resource=""
    Grant="%DB_%DEFAULT"
    Recurse="1"
    LoginClass=""
    CookiePath="/csp/demo1"
    AuthenticationMethods="64"/>

親タグ ： <Production>

アクセス資格情報を作成またはオーバーライドします。

• Name—アクセス資格情報の名前。

• Username—ユーザ名。

• Password—ユーザ・パスワード。

• Overwrite—アカウントが既に存在する場合は上書きします。

<Credential  
    Name="Admin"
    Username="administrator"
    Password="123jUgT540!f3B$#"
    Overwrite="0"/>

親タグ ： <Configuration>

ネームスペース内でデータベースを定義します。

以下のプロパティで制御するデータベース設定の詳細は、"システム管理ガイド" の “InterSystems IRIS の構成” の章にある "データベースの構成" を参照してください。

• BlockSize—データベースのブロック・サイズ (4096、8192、16384、32768、65536)。

• ClusterMountMode—起動時にクラスタの一部としてデータベースをマウントするかどうかを指定します。

• Collation—データベース内に作成される、グローバルの既定の照合。

• Create—新しいデータベースを作成するかどうかを指定します (yes/no/overwrite) [yes]

• Dir—データベース・ディレクトリ。

• Encrypted—データベースを暗号化するかどうかを指定します。

• EncryptionKeyID—暗号化キーの ID。

• InitialSize—データベースの初期サイズを MB 単位で指定します。

• ExpansionSize—必要な場合にデータベースを拡張するサイズを MB 単位で指定します。

• MaximumSize—データベースを拡張できる最大サイズ。

• MountAtStartup—インストールされたインスタンスを起動するときにマウントするかどうかを指定します。

• MountRequired—インスタンスを起動するたびにデータベースをマウントする必要があるかどうかを指定します。

• Name—データベース名。

• PublicPermissions—リソースを作成する必要がある場合、リソースに割り当てられる許可の値。リソースが既に存在する場合は無視されます。読み取り専用または読み書き可能です。

• Resource—データベースへのアクセスを制御するリソース。

• StreamLocation—データベースに関連付けられているストリームが格納されるディレクトリ。

<Database Name="${DBNAME}" 
    Dir="${MGRDIR}/${DBNAME}"  
    Create="yes"
    Resource="${DBRESOURCE}"
    Blocksize="8192"
    ClusterMountMode="0"
    Collation="5"
    Encrypted="0"
    EncryptionKeyID=
    ExpansionSize="0"
    InitialSize="1"
    MaximumSize="0"
    MountAtStartup="0"
    MountRequired="0"
    StreamLocation=
    PublicPermissions=""/>
<Database Name="MYAPP" 
    Dir="${MYAPPDIR}/db"  
    Create="no"
    Resource="${MYAPPRESOURCE}"
    Blocksize="8192"
    ClusterMountMode="0"
    Collation="5"
    Encrypted="0"
    EncryptionKeyID=
    ExpansionSize="0"
    InitialSize="1"
    MaximumSize="0"
    MountAtStartup="0"
    MountRequired="0"
    StreamLocation=
    PublicPermissions=""/>

親タグ ： <Manifest>

変数値がまだ設定されていない場合に、変数値を設定します。

• Name—変数名。

• Value—変数値。

• Dir—フォルダまたはファイルのパスを示す変数値。

<Default Name="blksiz"
    Value="8192" />

親タグ ： <If>

先行する <If> 文で定義される条件文が false の場合に実行されます。

プロパティはありません。

<If Condition='#
{##class(%File).Exists(INSTALL_"mgr\iris.key")}
'>
<Else/>
<CopyFile Src="C:\\InterSystems\key_files\iris300.key" Target="${MGRDIR}\iris.key" IgnoreErrors="0"/>
</If>

親タグ ： <Manifest>

子タグ ： <Arg>

エラーを生成します。

• Status ： エラー・コード。

• Source ： エラーの発生源。

<Error Status="$$$NamespaceDoesNotExist" Source=>
    <Arg Value="${NAMESPACE}"/>
</Error>

親タグ ： <Manifest>

指定されたインデックス・キーの繰り返しに使用する値を定義します。

• Index—変数名。

• Values—変数値のリスト。

<ForEach 
    Index="TargetNameSpace"
    Values="%SYS,User">
    <!--Code for each iteration of TargetNameSpace-->
</ForEach>

親タグ ： <Configuration>

グローバルを現在のネームスペースにマップします。

• Global ： グローバル名。

• From ： グローバルのソース・データベース。

• Collation ： グローバル照合 [IRIS Standard]。

<GlobalMapping Global="MyAppData.*"
    From="MYAPP" Collation="30"/> 
<GlobalMapping Global="cspRule" 
    From="MYAPP"/>

親タグ ： <Manifest>、<Namespace>

子タグ ： <Else>

条件付きアクションを指定します。

• Condition ： 条件文。

<If Condition='$L("${NAMESPACE}")=0'>
    <Error Status="$$$NamespaceDoesNotExist" Source=>
        <Arg Value="${NAMESPACE}"/>
    </Error>
</If>

親タグ ： <Manifest>、<Namespace>

変数が設定されている場合の条件付きアクションを指定します。

• Var ： 変数名。

<IfDef Var="DBCreateName">
   <Database Name="${DBNAME}" 
       Dir="${MGRDIR}/${DBNAME}"  
       Create="yes"
       ...
</IfDef>

親タグ ： <Manifest>、<Namespace>

変数が設定されていない場合の条件付きアクションを指定します。

• Var ： 変数名。

親タグ ： <Namespace>

%SYSTEM.OBJ.ImportDirOpens in a new tab(File,Flags,Recurse) または %SYSTEM.OBJ.LoadOpens in a new tab(File,Flags) を呼び出してファイルをインポートします。

• File—インポートするファイルまたはフォルダ。

• Flags—コンパイル・フラグ [ck]。

• IgnoreErrors—エラー時に続行するかどうかを指定します [0]。

• Recurse—再帰的にインポートするかどうかを指定します [0]。

親タグ ： <Namespace>

子タグ ： <Arg>

クラス・メソッドを呼び出して、実行結果を変数の値として返します。

• Class—クラス名。

• Method—メソッド名。

• CheckStatus—返されたステータスをチェックするかどうかを指定します。

• Return—結果の書き込み先の変数の名前。

<Invoke Class="SECURITY.SSLConfigs" Method="GetCertificate" CheckStatus="1" Return="CertContents"> 
    <Arg Value="iris.cer"/>
</Invoke>

親タグ ： <Namespace>

%SYSTEM.CSP.LoadPageOpens in a new tab(PageURL,Flags) または %SYSTEM.CSP.LoadPageDirOpens in a new tab(DirURL,Flags) を呼び出して CSP ページをロードします。

• Name—CSP ページの URL。

• Dir—CSP ページを含むディレクトリの URL。

• Flags—コンパイル・フラグ [ck]。

• IgnoreErrors—エラー時に続行するかどうかを指定します [0]。

親タグ ： <Manifest>

setup() メソッドで指定されたログのレベルが level プロパティの値以上の場合に、setup() メソッドで指定されたログにメッセージを記録します。

• Level—ログのレベル。-1 (none) から 3 (verbose) までの範囲です。

• Text—ログ・メッセージ (最大 32,000 文字の文字列)。

詳細は、"マニフェスト・ログへの書き込み" を参照してください。

親タグ ： なし (ルート・タグ。他のすべてのタグを含みます)

子タグ ： <CopyDir>、<CopyFile>、<Default>、<Else>、<Error>、<ForEach>、<If>、<IfDef>、<IfNotDef>、<Log>、<Namespace>、<Resource>、<Role>、<SystemSetting>、<User>、<Var>

プロパティはありません。

<Manifest>
    <Namespace ... >
        <Configuration>
            <Database .../>
            <Database .../>
        </Configuration>
    </Namespace>
</Manifest>

親タグ ： <Manifest>

子タグ ： <Compile>、<Configuration>、<CopyClass>、<CSPApplication>、<Else>、<If>、<IfDef>、<IfNotDef>、<Import>、<Invoke>、<LoadPage>、<Production>

ネームスペースを定義します。

• Name—ネームスペースの名前。

• Create—新しいネームスペースを作成するかどうかを指定します (yes/no/overwrite) [yes]

• Code—コード用データベース。

• Data—データ用データベース。

• Ensemble—相互運用対応のネームスペースかどうかを指定します [0]。

(相互運用 Web アプリケーションには他のプロパティを適用可能)

<Namespace Name="${NAMESPACE}" 
     Create="yes" 
     Code="${NAMESPACE}"
     Data="${NAMESPACE}"> 
          <Configuration> 
               <Database Name="${NAMESPACE}" . . . />
          </Configuration>
</Namespace>

親タグ ： <Namespace>

子タグ ： <Credential>、<Setting>

プロダクションを定義します。

• Name—プロダクション名。

• AutoStart—プロダクションを自動的に起動するかどうかを指定します [0]。

<Production Name="${NAMESPACE}" 
     AutoStart="1" />

親タグ ： <Manifest>

リソースを定義します。

• Name—リソース名。

• Description—リソースの説明。

• Permission—パブリック許可。

<Resource
    Name="%accounting_user" 
    Description="Accounting"
    Permission="RW"/>

親タグ ： <Manifest>

ロールを定義します。

• Name—ロール名。

• Description—ロールの説明 (コンマは使用できません)。

• Resources—ロールで保持されている特権 (リソースと特権のペア)。

• RolesGranted—指定されたロールで付与されるロール。

<Role 
    Name="%DB_USER"
    Description="Database user"
    Resources="MyResource:RW,MyResource1:RWU"
    RolesGranted= />

親タグ ： <Configuration>

ルーチン・マッピングを定義します。

• Routines ： ルーチン名。

• Type ： ルーチン・タイプ (MAC、INT、INC、OBJ、ALL)。

• From ： ルーチンのソース・データベース。

<RoutineMapping Routines="MyRoutine"
    Type="ALL" From="${NAMESPACE}" /> 

親タグ ： <Production>

Ens.Production.ApplySettings()Opens in a new tab メソッドを呼び出して、プロダクション内のアイテムを構成します。

• Item—アイテム名。

• Target—設定タイプ (Item、Host、Adapter)。

• Setting—設定名。

• Value—設定の構成値。

<Production Name="Demo.ComplexMap.SemesterProduction">
    <Setting Item="Semester_Data_FileService"
        Target="Item"
        Setting="PoolSize"
        Value="1"/>
    <Setting Item="Semester_Data_FileService"
        Target="Host"
        Setting="ComplexMap"
        Value="Demo.ComplexMap.Semester.SemesterData"/>
    <Setting Item="Semester_Data_FileService"
        Target="Adapter"
        Setting="FilePath"
        Value="C:\Practice\in\"/>
</Production>

親タグ ： <Manifest>

Config.CommonSingleMethodsOpens in a new tab から Modify() メソッドを継承する任意の Config クラスのプロパティの値を設定します。

• Name—Config クラスの Class.property。

• Value—プロパティに割り当てる値。

親タグ ： <Manifest>

ユーザを定義します。PasswordVar が含まれる場合、指定された変数名でユーザのパスワードを渡す必要があります。

• Username—ユーザ名。

• PasswordVar—ユーザ・パスワードが含まれる変数の名前 (以下の <Var> を参照)。

• Roles—ユーザを割り当てるロールのリスト。

• Fullname—ユーザのフルネーム。

• Namespace—ユーザの実行開始ネームスペース。

• Routine—ユーザの実行開始ルーチン。

• ExpirationDate—それ以降のユーザ・ログインが無効になる日付。

• ChangePassword—次回ログイン時にユーザにパスワードの変更を要求するかどうかを指定します。

• Enabled—ユーザが有効かどうかを指定します。

• Comment—オプションコメント。

<User 
    Username="Clerk1"
    PasswordVar="clerk1pw"
    Roles="Dataentry"
    Fullname="Data Entry Clerk"
    Namespace=
    Routine=
    ExpirationDate=
    ChangePassword=
    Enabled=
    Comment=""/>

親タグ ： <Manifest>

マニフェストで使用できる変数を定義および設定します。

• Name—変数名。

• Value—変数に割り当てる値。

<Var Name="Namespace" Value="MUSIC"/> 
<Var Name="GlobalDatabase" Value="${Namespace}G"/> 
<Var Name="RoutineDatabase" Value="${Namespace}R"/> 
<Var Name="AppDir" Value="C:\MyApp\${CFGNAME}"/> 
<Var Name="GlobalDatabaseDir" Value="${AppDir}\${GlobalDatabase}"/> 
<Var Name="RoutineDatabaseDir" Value="${AppDir}\${RoutineDatabase}"/> 
<Var Name="Resource" Value="%DB_${Namespace}"/> 
<Var Name="Role" Value="${Namespace}"/> 
<Var Name="CSPResource" Value="CSP_${Namespace}"/>