メッセージ コンテキストのプロパティの使用方法
システム プロパティとは、BizTalk メッセージング エンジンとそのコンポーネントによって主に内部で使用されるプロパティです。 一般的に、これらのプロパティのエンジンによって設定されている値を変更することは、エンジンの実行ロジックに影響を与えるため推奨されません。 ただし、変更できるプロパティは数多くあります。
次の表に、メッセージング エンジンによって昇格可能なメッセージ コンテキストのプロパティの一覧を示します。 これらのプロパティは、Microsoft BizTalk Server の送信ポートとオーケストレーションでフィルター式を作成するために使用できます。 たとえば、オブジェクトに適用された
PortName = MyMessage(BTS.ReceivePortName);
MyFileName = MyMessage(FILE.ReceivedFileName);
MySubject= MyMessage(POP3.Subject);
別の表に、一部の BizTalk アプリケーションで使用できる追加のプロパティを示します。これらは昇格できません。
| プロパティ | 昇格のタイミングと場所 | Type | 説明 |
|---|---|---|---|
| BTS.AckFailureCategory | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:int | 中断の場所と理由を示す ErrorCategory を識別します。 |
| BTS.AckFailureCode | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 中断の場所と理由を示す ErrorCode を識別します。 |
| BTS.AckID | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元の メッセージの MessageID を 識別します。 |
| BTS.AckInboundTransportLocation | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから InboundTransportLocation を識別します。 |
| BTS.AckOutboundTransportLocation | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから OutboundTransportLocation を識別します。 |
| BTS.AckOwnerID | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージからインスタンス ID を識別します。 |
| BTS.AckReceivePortID | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから ReceivePortID を識別します。 |
| BTS.AckReceivePortName | 受信確認メッセージのメッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから ReceivePortName を 識別します。 |
| BTS.AckSendPortID | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから SendPortID を識別します。 |
| BTS.AckSendPortName | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | 元のメッセージから SendPortName を 識別します。 |
| BTS.AckType | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:string | オーケストレーションにより受信確認と未受信を監視できます。 受信確認の値は ACK、否定受信確認の値は NACK になります。 |
| BTS.ActionOnFailure | このプロパティは、IBTTTransportBatch::SubmitMessage() API を呼び出して BizTalk にメッセージを送信する前にアダプターによって設定できます。 | xs:int | 受信パイプラインにエラーが発生した場合、メッセージング エンジンの動作を制御します。 通常、メッセージング エンジンでは失敗したメッセージが保留されますが、HTTP のような特定のアダプターは、受信パイプラインのエラー時にメッセージを保留するのではなく、エラーをクライアントに報告します。 有効な値: - Default. プロパティが存在しない場合、メッセージング エンジンは自動的にメッセージを保留しようとします。 - 0. メッセージング エンジンが自動的にメッセージを保留しないことを示します。 他の値は将来使用するために予約されています。 |
| BTS.CorrelationToken | このプロパティをメッセージ コンテキストに設定すると、メッセージング エンジンによって昇格されます。 このプロパティは、要求 - 応答のアダプターまたはオーケストレーションがメッセージ ボックス データベースに要求メッセージを送信する場合に、暗黙的にコンテキストに設定されます。 | xs:string | 要求 - 応答ポートへの応答のルーティングを有効にします。 |
| BTS.EpmRRCorrelationToken | 要求 - 応答メッセージの実行時にメッセージング エンジンによって昇格されます。 プロパティは、メッセージがメッセージ ボックス データベースに送信される前に昇格されます。 | xs:int | メッセージング エンジンによって内部で使用されます。 メッセージの要求応答ストリームのサーバー名、プロセス ID、および一意の GUID を指定します。 |
| BTS.InboundTransportLocation | 受信アダプターからメッセージを受信した後、メッセージ ボックス データベースに発行する前に、メッセージング エンジンによって昇格されます。 | xs:string | メッセージをハンドラーで受信する場所 (URI) を指定します。 |
| BTS.InboundTransportType | 受信アダプターからメッセージを受信した後、メッセージ ボックス データベースに発行する前に、メッセージング エンジンによって昇格されます。 | xs:string | このメッセージを受信して FILE、HTTP などのサーバーに送信したアダプターの種類を指定します。 |
| BTS.InterchangeSequenceNumber | 受信アダプターからメッセージを受け取った後、メッセージ ボックス データベースに公開する前に、メッセージング エンジンによって昇格されます。 | xs:int | インターチェンジのドキュメントのシーケンス番号を示します。 ドキュメントが個々のドキュメントに逆アセンブルされたインターチェンジの一部でない場合、この値は 1 になります。 プロパティは、オーケストレーション、送信パイプライン、送信アダプターで読み取ることができます。 |
| BTS.IsDynamicSend | メッセージ コンテキストで設定できます。 このプロパティは昇格されず、送信操作にのみ適用されます。 | xs:boolean | 送信操作が動的送信ポートを使用して行われる場合、メッセージング エンジンによって値が true に設定されメッセージ コンテキストに書き込まれます。 送信パイプラインで静的送信ポート用に動的にプロパティを設定する場合は、この値を true に設定する必要があります。 |
| BTS.MessageDestination | このプロパティは、GetNext() からメッセージが返されたときに、逆アセンブラー パイプライン コンポーネントによって受信パイプラインで設定できます。 | xs:string | このプロパティは、主に逆アセンブラーの [回復可能なインターチェンジ処理] のサポートに使用され、メッセージをメッセージ ボックスに公開するか、または保留キューに入れて中断するかを制御します。 パイプラインでインターチェンジに無効なメッセージが検出された場合、メッセージを中断して処理を続行するには、MessageDestination = SuspendQueue を設定します。またこれによって、エンジンが逆アセンブラーで GetNext() を呼び出したときにメッセージを返すことができます。 有効な値: - Default. プロパティが存在しない場合、メッセージは有効と見なされ、メッセージ ボックスに公開されます。 - SuspendQueue。 メッセージング エンジンにメッセージを中断するよう指示します。 メモ： 中断されたメッセージはパイプライン/マッピング後のメッセージであり、アダプターによって送信されたメッセージ (ワイヤ メッセージ) ではありません。 |
| BTS.MessageType | メッセージ解析中に逆アセンブラー パイプライン コンポーネントによって昇格されます。 | xs:string | メッセージの種類を指定します。 メッセージ型は、ドキュメント スキーマ名前空間とドキュメント ルート ノードの連結として定義されます: http://<MyNamespace>#<MyRoot>。 |
| BTS.OutboundTransportLocation | このプロパティをメッセージ コンテキストに設定すると、メッセージング エンジンによって昇格されます。 このプロパティは、オーケストレーションが送信ポートにメッセージを送信する場合に、暗黙的にメッセージ コンテキストに設定されます。 このプロパティは、オーケストレーションまたはパイプラインで明示的に設定することもできます。 | xs:string | メッセージが送信された送信先 URI を指定します。 URI には、 http:// などのアダプター プレフィックスが含まれている場合があります。 アダプター プレフィックスは、メッセージング エンジンで、メッセージを送信するときに使用するアダプターの種類を決定するのに使用されます。 アダプター プレフィックスと BTS の両方 の場合。OutboundTransportType プロパティが設定されます。これは、BTS からのアダプターの種類 です。OutboundTransportType は 、プレフィックスから決定されたアダプターの種類よりも常に優先されます。 有効な値: BizTalk メッセージ キュー: DIRECT=、 PRIVATE=、 PUBLIC= ファイル: file:// FTP: FTP:// HTTP: http:// と https:// SMTP: mailto: SOAP: SOAP:// SQL: SQL:// |
| BTS.OutboundTransportType | このプロパティをメッセージ コンテキストに設定すると、メッセージング エンジンによって昇格されます。 このプロパティは、オーケストレーションが送信ポートにメッセージを送信する場合に、暗黙的にコンテキストに設定されます。 このプロパティは、オーケストレーションまたはパイプラインで明示的に設定することもできます。 | xs:string | メッセージの送信に使用するアダプターの種類を指定します。 使用可能なアダプターの種類は、 FILE、 FTP、 HTTP、 SMTP、 SOAP、 SQL です。 このプロパティに設定される値とアドレスで指定されるアダプター プレフィックスは、大文字と小文字を区別しません。 |
| BTS.PropertiesToUpdate | 再送信または中断されたエラー メッセージの一部のプロパティ値を予約する場合、アダプターによってこのプロパティが設定されます。 つまり、メッセージが再送信または再開された場合、指定したプロパティがコンテキストに設定されます。 |
xs:string | プロパティ名、名前空間、および値を表す要素を持つ XML 文字列を含んでいます。 |
| BTS.ReceivePortID | 受信アダプターからメッセージを受信した後、メッセージ ボックス データベースに発行する前に、メッセージング エンジンによって昇格されます。 | xs:int | メッセージを受信した受信ポートを特定します。 |
| BTS.ReceivePortName | 受信アダプターからメッセージを受信した後、メッセージ ボックス データベースに発行する前に、メッセージング エンジンによって昇格されます。 | xs:string | メッセージを受信した受信ポートのユーザー フレンドリ名。 |
| BTS.RouteDirectToTP | ループ バックまたは要求 - 応答の実行時のメッセージでメッセージング エンジンによって昇格されます。 プロパティは、メッセージがメッセージ ボックス データベースに送信される前に昇格されます。 | xs:boolean | ループバックおよび要求 - 応答のシナリオを有効にするために、メッセージング エンジンによって内部で使用されます。 |
| BTS.SPGroupID | メッセージがオーケストレーションから送信ポートに送信されるときに、メッセージング エンジンによって昇格されます。 | xs:string | 送信ポート グループの ID を指定します。 |
| BTS.SPID | メッセージをオーケストレーションから送信ポートに送信したときに、メッセージング エンジンによって昇格されます。 | xs:string | 送信ポートの ID を指定します。 |
| BTS.SPName | 送信請求 - 応答の送信ポートから応答メッセージを公開しているときに、メッセージング エンジンによって昇格されます。 | xs:string | 送信請求 - 応答の送信ポートからの応答メッセージをサブスクライブするために使用します。 値は送信ポートの名前です。 |
| BTS.SPTransportBackupID | メッセージがオーケストレーションから送信ポートに送信されるときに、メッセージング エンジンによって昇格されます。 | xs:string | 送信ポートのバックアップ アダプターの ID を指定します。 |
| BTS.SPTransportID | メッセージがオーケストレーションから送信ポートに送信されるときに、メッセージング エンジンによって昇格されます。 | xs:string | 送信ポートのプライマリ アダプターの ID を指定します。 |
| BTS.SuspendAsNonResumable | このプロパティは、SubmitMessage() を呼び出す前、またはオーケストレーションでメッセージを送信ポートに送信する前に、アダプターによって設定できます。 メモ： SubmitRequestMessage() はこのプロパティを無視します。双方向メッセージは、常に再開不可として中断されます。 | xs:boolean | メッセージング エンジンでメッセージ エラー時にメッセージを再開不可として中断するかどうかを制御します。 通常、メッセージは再開可能として中断されますが、これが不適切な場合があります。たとえば、順次配送の送受信ポートのメッセージを再開すると、メッセージの順序が途切れます。 有効な値: -False。 メッセージは再開可能として中断されます (既定)。 -True。 メッセージは再開不可として中断されます。 |
| BTS.SuspendMessageOnRoutingFailure | 受信アダプターからメッセージを受信した後、メッセージ ボックス データベースに発行する前に、メッセージング エンジンによって昇格されます。 | xs:boolean | 受信メッセージにルーティング エラーが発生したときの動作を指定します。 有効な値: - 既定値/ False。 プロパティが存在しない、または False に設定されている場合、エンジンはルーティング エラーが発生したときにアダプターにエラーを通知します。 -True。 ルーティング エンジンは、ルーティング エラーが発生すると、自動的にメッセージを中断します。 メモ： 中断されたメッセージはパイプライン/マッピング後のメッセージであり、アダプターによって送信されたメッセージ (ワイヤ メッセージ) ではありません。 |
この名前空間には、一部の BizTalk アプリケーションに役立つ情報を含んでいる他のプロパティが多数あります。
| プロパティ | 昇格のタイミングと場所 | Type | 説明 |
|---|---|---|---|
| BTS.AckDescription | 受信確認メッセージをメッセージ ボックス データベースに公開する前に、メッセージング エンジンによって設定されます。 | xs:string | 中断の場所と理由を示す ErrorDescription を識別します。 |
| BTS.EncryptionCert | 昇格できません。 | xs:int | 暗号化証明書に対応する拇印を特定します。 署名された暗号化されたメッセージを受信している要求/応答ポートで応答暗号化を実行するには、パイプライン内の MIME/SMIME Encoder パイプライン コンポーネントの前に配置されたオーケストレーションまたはカスタム パイプライン コンポーネントでこのプロパティを設定します。 |
| BTS.InterchangeID | サーバーに到着する各メッセージのメッセージング エンジンによって設定されます。 | xs:string | 同じインターチェンジ メッセージから生成されたドキュメントをグループ化するために使用する一意の ID を定義します。 |
| BTS.Loopback | ループバック実行の要求メッセージを送信する場合に、アダプターによって設定されます。 | xs:boolean | メッセージをループバック実行のためにサーバーに送信するかどうかを定義します。 ループバック実行では、要求メッセージは、メッセージ ボックス データベースに公開され、そこで応答として受信アダプターに直接ルーティングされます。 |
| BTS.SignatureCertificate | メッセージをサーバーに送信するときに、一部のアダプターによって設定されます。 このプロパティは、パーティの解決パイプライン コンポーネントで使用されます。 | xs:string | BizTalk Server が受信したメッセージの署名に使用される署名証明書の拇印を特定します。 |
| BTS.SourcePartyID | 受信メッセージのパーティが特定された後で、パーティの解決パイプライン コンポーネントによって設定されます。 | xs:string | BizTalk パーティの ID。 |
| BTS.SSOTicket | 受信アダプターがこのプロパティをサポートする場合、メッセージをサーバーに公開するときに設定されます。 | xs:string | チケットには、現在のユーザーの暗号化されたドメインとユーザー名、およびチケットの有効期限が含まれています。 チケットは、送信先エンドポイントを認証する場合にユーザーの資格情報を取得するため、SSO 対応のアダプターで使用されます。 |
| BTS.WindowsUser | メッセージをサーバーに送信するときに、一部のアダプターによって設定されます。 このプロパティは、パーティの解決パイプライン コンポーネントで使用されます。 | xs:string | メッセージをサーバーに送信したユーザーのアカウントを指定します。 |
パイプライン コンポーネントとアダプターに関連付けられたプロパティとプロパティ スキーマについての追加情報は、以下のトピックを参照してください。