XML 基本
Ytria アプリケーションは、XML (eXtensible Markup Language) スクリプトを使用し様々なアクションを自動化することができます。
XML ファイルはプレーンなテキストファイルで、どのテキストエディター(例 メモ帳）でも作成できます。
UTF-8 または UTF-16 のエンコーディングのどちらも認識します。
スクリプトの構造
互換のある自動化スクリプトは、一連のアクションから作成されています。
これらのアクションは Ytria ツール内で機能のひとつとして実行できます（例：サーバーのロード、ID の切替、出力、レプリカの検知など）。
| 注意 | Ytria によって実行されるアクションのみこの自動化の対象となり、これらのアクションは直接 UI を通じて処理されるものになります。自動化スクリプトは Ytria ツールのバックエンドに対してユーザーにアクセスを許可するものではありません。 |
|---|
XML スクリプトのサンプル
次のスクリプトは viewEZ で ACME01/ACME という名のサーバー上にある mailbase.nsf というデータベースをロードするもので、この環境には適正な合致するファイルパスが記述されています。
加えて、ひとつの設計、NoteID h398e、がツリー内で選択されるものです。
<?xml version="1.0" encoding="UTF-8">
<ytriaAutomation Application="viewEZ" ApplicationVersion="16.5">
<Load Database="PROD\mailbase.nsf" Server="ACME01/ACME"/>
<UnSelect>
<SetParam Name="All"/>
</UnSelect>
<Expand Category="Designs" Target="Tree"/>
<Select>
<SetParam NoteID="h398e"/>
</Select>
</ytriaAutomation>
| 注意 | Ytria の XML についての決まり事については次のとおりです。
すべての自動化スクリプトは一般的な XML のガイドラインに従ってください。XML について詳しくない方は、こちらの ページ を参照して詳細をご確認ください。
ある操作を実行しようとする際にエスケープ文字を使用することがあるかもしれません（たとえば、式または値の名前の中にある特殊文字）。
念のため、エスケープすべき文字を含む処理を正常に実行できるよう、以下にその例を挙げます。
" は次のように定義します "
' は次のように定義します '
< は次のように定義します <
> は次のように定義します >
& は次のように定義します & |
|---|
スクリプトを構成するパーツ
上記のサンプルスクリプトはそれに続く異なる基本スクリプトのパーツへの参照として使用できます。
スクリプトのヘッダーとフッター
アクション
アクションの属性
アクションのパラメーター
スクリプトのヘッダーとフッター
スクリプトヘッダー
スクリプトヘッダーの最初の行は XML 宣言です。この行はすべての XML スクリプトで標準的に必要となり、XML バージョン (1.0) とエンコーディングを定義するものです。
<?xml version="1.0" encoding="UTF-8"?>
自動化スクリプトの内容の本当の第一行は ytriaAutomation タグを使用するところからです。
先ほどの例では次の属性が使用されています。
Application: これは自動化スクリプトを実行させようとするアプリケーションの名前です。大文字小文字を区別します。
| 注意 | 汎用的で複数の製品で使用できる自動化スクリプトもあります。 |
|---|
ApplicationVersion: これは製品のバージョンで、自動化を実行するバージョンを指定します。ここでは 16.5 としています。
<ytriaAutomation Application="databaseEZ" ApplicationVersion="16.5">
 Tip | 一般のヘッダーは必須ですが、 ytriaAutomation ヘッダータグはそうではありません。アクションのいくつかは異なる製品やバージョン間で互換がありません。そのため、内容を確認するうえでもこれらの属性を追加することがベストプラクティスだと認識してください。 |
|---|
Ytria 自動化スクリプトでの最低限必須となるヘッダーのサンプルが次のとおりです。
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation>
| Tip | ヘッダー用の任意追加パラメーター
- 自動化コンソールの非表示:
ytriaAutomation ヘッダータグにパラメーター Console="False" を追加することで、自動化スクリプトが実行中に自動化コンソールを非表示にできます。
自動化コンソールのダイアログは初期化のタイミングにのみ表示されます（XML スクリプトのロード時と解析時）。
例
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Console="False" Application="viewEZ" ApplicationVersion="16.5">
- ユーザー属性の追加:
ytriaAutomation ヘッダータグにユーザー属性を追加することで、特定の組織やユーザーのみスクリプトを使用できるよう制限を加えることができます。
たとえば、 user="John Doe/ACME" を行に追加すると、そのユーザーのみスクリプトを利用できるよう制限できます。
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="viewEZ" ApplicationVersion="16.5" user="John Doe/ACME">
ワイルドカードも利用できます。user="*/ACME" と行に追加すると ACME ドメインのすべてのユーザーがこのスクリプトを実行できます。
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="viewEZ" ApplicationVersion="16.5" user="*/ACME">
|
|---|
スクリプトフッター:
すべての Ytria 自動化スクリプトはスクリプトヘッダーで終了しなければなりません。
</ytriaAutomation>
^ トップへ戻る
アクション
アクションはタグの内部に配置し、スクリプト内の前述のアクションの完了に基づいて時系列順に実行します。
アクションのネスト化: スクリプトの構造で、アウターアクションは 「Parent (親)」アクション、インバーアクションは「Child(子)」アクションです。
たとえば、この基本的なサンプルスクリプトは次のとおりになります。
すべてのアクションが完了すると自動化コンソール内で、次のようなアクションの結果を表示します。
「Parent」アクションがキャンセルされた場合、その内部のすべての「Child」アクションもキャンセルされます。
このサンプルは replicationEZ での自動化コンソールを表示しています。
この ページ で利用できるアクションを網羅したリストを参照してください。
^ トップへ戻る
アクションの属性
属性はアクションへの引数として追加できます。
再度サンプルスクリプトを例に挙げると、に戻って、アクションは で示したもの、アクションの属性は で示しています。
特定のアクションと、そのアクションの属性についての詳細情報は こちら のページを参照してください。
^ トップへ戻る
アクションのパラメーター
通常 UI を通じてマニュアルで特定のアクションを実行する場合はダイアログボックスにパラメーターを指定したり、マニュアルで選択を行いますが、こういった選択を「Child」アクションの SetParam を使ってスクリプトで行うことができます。
^ トップへ戻る
|