構成ファイル

データ・フロー・サービスが使用する構成ファイルの名前は Dataflowsconfig.xml であり、デフォルトのインストール・パスに配置されます。ファイルには、データ・ソース、データ・フロー、設定の 3 つのセクションがあります。ファイル内のタグと属性名は、すべて小文字にする必要があります。起動時に構成ファイルを検証するために使用できる XSD ファイルもあります。

<DataSources>

この<DataSources>構成ファイルのタグは、ソリューションが対話するように構成されているさまざまなデータ・ソースの集合を表します。構成を有効にするには、少なくとも 2 つのデータ・ソースが必要です。この<datasourcename>属性は固有でなければなりません。

<DataSource>
この<データ・ソース>タグは、 構成ドキュメントの<datasources>タグの子ノードであり、単一のデータ・ソースの構成情報を表します。
属性名 デフォルト値 必須 説明
datasourcename あり この属性は、データ・ソースを一意的に識別するために使用されます。この属性を使用すると、データ・ソースを各データ・フロー内の特定のアダプターにマッピングできます。
connectionstring あり これは、それぞれのデータ・ソースの URL です。例: https://<ipaddress/hostname>:{Port}/api (BigFix)

https://<InstanceID>.Service-Now.com/api/now/table (ServiceNow)
username システム生成 この属性は、ProvideCredentials コマンドを使用して管理されます。データは、構成ファイルに保持される前に暗号化されます
password システム生成 この属性は、ProvideCredentials コマンドを使用して管理されます。データは、構成ファイルに保持される前に暗号化されます
verifycert True なし この属性は、このデータ・ソースで SSL 証明書の検証を有効または無効にします。
proxy_host 該当なし あり この属性は、プロキシー・サーバー・ホストとポート番号 (形式: HTTP:// または HTTPS://proxy_host:proxy_port) を提供します。
proxy_username 該当なし オプション この属性は、 configureproxy コマンドを使用して管理されます。データは、構成ファイルに保持される前に暗号化されます。
proxy_password 該当なし オプション この属性は、 configureproxy コマンドを使用して管理されます。データは、構成ファイルに保持される前に暗号化されます。
Note: プロキシーで verifycert が True に設定されている場合は、プロキシー・マシン証明書がマシンのクライアントに追加されていることを確認します。

<DataFlows>

この<DataFlows>構成ファイルのタグは、ソリューションが実行するように構成されているさまざまなデータ・フローの集合を表します。

<DataFlow>
各<DataFlow>タグは、あるシステムから別のシステムへのデータ・フローのインスタンスを表し、SourceAdapter タグと TargetAdapter タグで構成されます。
属性名 必須 説明
displayname あり この属性は、個々のデータ・フローを記述するために使用されます。
datatype あり デフォルトでは、アセットに設定されています。
schedule* あり スケジュールの詳細については、こちらを参照してください。

Schedule*

cron 時刻ストリング形式: cron 時刻ストリング形式は、cron によって時間間隔に変換される 5 つのフィールドで構成されます。次に cron はこの間隔を使用して、データ・フローをスケジュールする頻度を決定します。5 つプレース値では、分、時、月の日付、月、曜日をそれぞれ指定します。

Table 1.
文字 記述子 許容される値
1 分 0～59、または * (特定の値なし)
2 時間 0～23、または * (任意の値)時刻はすべて UTC
3 日 1～31、または * (特定の値なし)
4 月 1～12、または * (特定の値なし)
5 曜日 0～7 (0 と 7 はどちらも日曜日を表す)、または * (特定の値なし)
ユースケースの例:
  • 毎時間、正時から特定の分数が過ぎた後に、データ・フローを実行する。
  • 毎週月曜日の特定の時刻 (UTC) にデータ・フローを実行する。
  • 5 分ごとにデータ・フローを実行する。
  • 2 時間ごとに正時にデータ・フローを実行する。

例 1: 0 10 15 * * の cron 時刻ストリングは、毎月 15 日の午前 10:00 UTC にコマンドを実行します。

例 2: 10/30 10 * * * の cron 時刻ストリングは、毎日 10 時 10 分とその後 30 分ごとにコマンドを実行します。

Note: データ・フロー・サービスの開始直後にデータ・フローを実行する必要がある場合は、スケジューラー値を現在時刻の 1 分後に構成する必要があります。例えば、現在時刻が 11:35:30 の場合、スケジューラーを 36 11 * * * に構成します。
Note: 統合を最初にテストするときには、スケジューラーで「今すぐ」を使用でき、データ・フローの実行を手動でテストできます。構成が機能したら、都合に合わせてスケジュールを構成します。例: schedule = "now"。
<FilterQuery>

この<FilterQuery>タグは、特定のアダプター・タグによってモニターされるレコードをフィルタリングするために使用されます。このタグは、選択したアダプター・タイプのネイティブ・クエリーで構成されます。BigFixRest の場合、これはセッション関連度になりますが、ServiceNowRest では SysParam_Query 値になります。

セッション関連度の詳細については「Relevance Language」、ServiceNow フィルターおよび照会についてはフィルターおよび照会で使用可能なオペレーターを参照してください。
Note: この<FilterQuery>は、以下の形式で指定されている場合は動作しません。

<filterquery>

<![CDATA[*********]]>

</filterquery>

この<FilterQuery>は、1 行で指定する必要があります。例:

<filterquery><![CDATA[*********]]></filterquery>

<SourceAdapter>
この<SourceAdapter>タグは、データの抽出元のソース・システムを識別します。少なくとも 2 つのプロパティーが有効なプロパティー・コレクションを含める必要があります。オプションで、使用される AdapterClass のネイティブ照会構文を利用する<FilterQuery>で構成されることもあります。
属性名 必須 説明
displayname あり この属性は、このアダプター構成を記述するために使用されます。
adapterclass あり オプション: bigfix または servicenow

この属性は、ソース・データ・ソースからデータを抽出するために使用されるアダプターを指定します。
datasourcename あり この属性値は、データ・ソース・コレクションで定義されているデータ・ソースの名前と一致する必要があります。アダプターに接続情報を提供するために使用されます。
<TargetAdapter>

この<TargetAdapter>タグは、データがロードされるターゲット・システムを識別します。少なくとも 2 つのプロパティーが有効なプロパティー・コレクションを含める必要があります。オプションで、使用される AdapterClass のネイティブ照会構文を利用する<FilterQuery>で構成されることもあります。

属性名 必須 説明
displayname あり この属性は、このアダプター構成を記述するために使用されます。
adapterclass あり オプション: bigfix または servicenow

この属性は、ソース・データ・ソースからデータを抽出するために使用されるアダプターを指定します。
datasourcename あり この属性値は、データ・ソース・コレクションで定義されているデータ・ソースの名前と一致する必要があります。アダプターに接続情報を提供するために使用されます。
<device_properties>
この<device_properties>タグは、特定のアダプター内のプロパティーのコレクションを表します。このコレクション内の各プロパティーは、対応するターゲット・アダプターまたはソース・アダプター内のコレクションへの位置によってマッピングされます。

この<sourcekey>タグは、アダプターの 1 次キーを定義します。各コレクションの 1 つのプロパティーのみを 1 次キーとして指定する必要があります。

この<targetkey>タグは、アダプターの外部キーを定義します。

Note: ソース列とターゲット列の位置は、デフォルトの構成ファイルで指定されている定義を変更しないでください。
<Property>
この<Property>タグは、 システムから抽出されるか、システムにロードされるデータの単一の列を表します。受信したデータの変換を容易にするためのシンプルな変換ロジックを含む場合があります。
属性名 必須 説明
displayname あり この属性は、構成されるプロパティーを記述するために使用されます
propertyname あり この属性は、各アダプターに固有の表記を使用して、対応する列を識別するために使用されます
datatype あり STRING、DATETIME、DATE、INT、DECIMAL、BOOLEAN のデータ型になります
Note: BigFix 列は、次の 2 つのパターンを使用して識別できます。Retrieved Property ID (int) または [SiteName]-[Analysis Name]-[PropertyNumber]
<IdentityProperty>
この<IdentityProperty>タグは、 システムから抽出されるか、システムにロードされるデータの単一の列を表します。受信したデータの変換を容易にするためのシンプルな変換ロジックを含む場合があります。
属性名 必須 説明
displayname あり この属性は、構成されるプロパティーを記述するために使用されます
propertyname あり この属性は、各アダプターに固有の表記を使用して、対応する列を識別するために使用されます
datatype あり STRING、DATETIME、DATE、INT、DECIMAL、BOOLEAN のデータ型になります
重み あり この属性は、プロパティーに重みを割り当てます。これは、レコードの重み付け信頼度の一致に使用されます。タイプ: int
delimiter なし この属性は、エントリーを複数の ID プロパティーに変換します。変換を無効にするには、空の区切り文字 "" を指定します。
Note: デバイス相関は、2 つのシステム間のマシン・レコードのマッピングです。顧客は、データ・ソース内のアダプターの「ID プロパティー」を構成し、重み付け信頼度アルゴリズムに基づいてレコードの相関を簡略化できます。
<TransformationLogic>

この<TransformationLogic>タグをプロパティー・タグと一緒に使用すると、システムから戻される値を操作できます。これらの変換はシンプルな Python エクスペリエンスであり、一般的には、特定の値に基づいたメンテナンス・ウィンドウまたは分類の解析に使用されます。

変換ロジックの構文: <transformationlogic><![CDATA[str(this_value).lower()]]></transformationlogic></identityproperty>

<Settings>

この<設定>タグは、ソリューションの設定のコレクションを表します。設定の詳細なリストについては、「構成設定」を参照してください。
属性名 必須 説明
key あり この属性は、構成中の設定の名前です。
value この属性は、構成中の設定の値です。