Version 24.2.9039

• Overview
• Connector Configuration
  • Settings Tab
    • Partner Info
    • WS-Security
    • Client Certificate
    • Server Certificates
  • Automation Tab
    • Automation Settings
    • Performance
  • アラートタブ
    • コネクタのE メール設定
    • サービスレベル（SLA）の設定
  • Advanced Tab
    • Token Authentication
    • TLS Client Authentication
    • HTTP Authentication
    • Custom Headers
    • Proxy Settings
    • Advanced Settings
    • Message
    • Logging
    • Miscellaneous
• Establishing a Connection
• SOAP Templates
• Macros
  • 例

SOAP connectors support sending SOAP messages to remote web services and retrieving the response.

Overview

The input to a SOAP connector should be the the full SOAP message to send to the web service. You can generate a template for the SOAP message by importing a WSDL for the target web service. Read the SOAP Templates section for details.

The SOAP connector supports HTTP Authentication, Token Authentication, and TLS Client Authentication, and can add digital encryption and signatures to the outgoing SOAP message for web service security. After sending the SOAP request, the connector stores the response or passes it along to the next connector in the CData Arc flow.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Partner Info

Settings for identifying the target web service.

• コネクタId コネクタの静的な一意の識別子。
• コネクタの種類 コネクタ名とその機能の説明が表示されます。
• コネクタの説明 コネクタとフローにおけるロールについて自由形式の説明を記載するオプションのフィールド。
• Service Endpoint The URL to which SOAP requests should be sent.
• SOAP Action The web service action to be triggered on the remote server.
• SOAP Version The version of SOAP you are using.
• Import from WSDL WSDLs can be imported from a URL or from a local file, and then automatically populate configuration fields in the connector. Importing a WSDL also allows for generating an XML template for SOAP requests when connected to an XML Map connector. See SOAP Templates for details.

WS-Security

Settings related to securing the web service transmissions.

• Send Message Security Whether to sign and/or encrypt outgoing SOAP requests.
• Receive Message Security Whether to require that signatures and encryption are present for incoming SOAP responses. An error is thrown if a received message does not have a required security parameter.
• Time To Live The length of time the connector waits for a connection response before throwing a timeout error.

Client Certificate

Settings related to the private local certificates.

• Private Certificate The private certificate used for signing outgoing requests and decrypting incoming responses.
• Certificate Password The password for accessing the private certificate.

Server Certificates

Settings related to the server’s public certificates.

• Encryption Certificate The public certificate used for encryption when sending messages and signature verification when receiving responses.
• TLS Server Certificate The public certificate used to verify the identity of an SSL/TLS server. Only required if you are sending requests over HTTPS (instead of HTTP). In the absence of a specific server certificate, you can leave this blank to allow the underlying OS/JVM to perform certificate validation, or you can set it to Any Certificate to trust the target server’s identity. Use Any Certificate with caution: the certificate verifies that you are connecting to the intended server.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

• Send Whether files arriving at the connector are automatically sent as SOAP requests.
• Retry Interval The amount of time before a failed send is retried. A retry is triggered when the server does not respond to a send attempt, or responds negatively to communicate that the file was not received.
• Max Attempts The maximum number of times the connector sends outgoing requests. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the request indefinitely.

Performance

コネクタへのリソースの割り当てに関する設定。

• 最大ワーカー数 このコネクタでファイルを処理するためにスレッドプールで消費されるワーカースレッドの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。
• 最大ファイル数 コネクタに割り当てられた各スレッドが送信するファイルの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。

アラートタブ

アラートとサービスレベル（SLA）の設定に関連する設定。

コネクタのE メール設定

サービスレベル（SLA）を実行する前に、通知用のE メールアラートを設定する必要があります。アラートを設定をクリックすると、新しいブラウザウィンドウで設定ページが開き、システム全体のアラートを設定することができます。詳しくは、アラートを参照してください。

サービスレベル（SLA）の設定

サービスレベルでは、フロー内のコネクタが送受信すると予想される処理量を設定し、その量が満たされると予想される時間枠を設定できます。CData Arc は、サービスレベルが満たされていない場合にユーザーに警告するE メールを送信し、SLA を At Risk（危険） としてマークします。これは、サービスレベルがすぐに満たされない場合に Violated（違反） としてマークされることを意味します。これにより、ユーザーはサービスレベルが満たされていない理由を特定し、適切な措置を講じることができます。At Risk の期間内にサービスレベルが満たされなかった場合、SLA はViolated としてマークされ、ユーザーに再度通知されます。

サービスレベルを定義するには、予想処理量の条件を追加をクリックします。

• コネクタに個別の送信アクションと受信アクションがある場合は、ラジオボタンを使用してSLA に関連する方向を指定します。
• 検知基準（最小）を、処理が予想されるトランザクションの最小値（量）に設定し、毎フィールドを使用して期間を指定します。
• デフォルトでは、SLA は毎日有効です。これを変更するには、毎日のチェックをOFF にし、希望する曜日のチェックをON にします。
• 期間終了前にステータスを’At Risk’ に設定するタイミングを使用して、SLA がAt Risk としてマークされるようにします。
• デフォルトでは、通知はSLA が違反のステータスになるまで送信されません。これを変更するには、‘At Risk’ 通知を送信のチェックをON にします。

次の例は、月曜日から金曜日まで毎日1000ファイルを受信すると予想されるコネクタに対して構成されたSLA を示しています。1000ファイルが受信されていない場合、期間終了の1時間前にAt Risk 通知が送信されます。

Advanced Tab

Token Authentication

Settings related to token client authentication.

• Token Authentication Check this to enable token authentication for outgoing messages. If enabled, outgoing messages include the user credentials set below.
• Username The username required to access the token.
• Password The password required to access the token.
• Password Type Use the radio buttons to specify whether the password is in plain text (Text) or is encrypted (Digest).

TLS Client Authentication

Settings related to client authentication when two-way TLS authentication is required.

• Private Certificate The private certificate presented during TLS client authentication.
• Certificate Password The password required to access the TLS client certificate.

HTTP Authentication

Settings related to HTTP client authentication.

• Use HTTP Authentication Check this to enable client HTTP Authentication.
• HTTP Authentication Type Whether to provide HTTP authentication credentials in an encrypted format (Digest) or in plain text (Basic). Basic authentication should only be used if the the connection is an HTTPS connection (rather than HTTP).
• User The User credential for HTTP client authentication.
• Password The Password credential for HTTP client authentication.

Custom Headers

A set of custom headers to include as part of the outgoing message.

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the SOAP connection should be routed. By default, this section uses the global settings on the Settings Page. Clear the checkbox to supply settings specific to your SOAP connector.

• プロキシの種類 プロキシベースのファイアウォールで使用されるプロトコル。
• プロキシホスト プロキシベースのファイアウォールの名前またはIP アドレス。
• プロキシポート プロキシベースのファイアウォールのTCP ポート。
• プロキシユーザー プロキシベースのファイアウォールでの認証に使用するユーザー名。
• プロキシパスワード プロキシベースのファイアウォールに認証するために使われるパスワード。
• 認証スキーム デフォルトのNone のままにするか、以下の認証スキームから1つを選択します：Basic、Digest、Proprietary、NTLM。

Advanced Settings

Settings not included in the previous categories.

• Connection Timeout The length of time the connector waits for a connection response before throwing a timeout error.
• Encryption Algorithm The algorithm to use when encrypting outgoing messages.
• Normalize Issuer Subject Whether certificate issuer data should be normalized into a simple string for validation by the web service.
• Allow ArcScript in URL Allows for the evaluation of ArcScript expressions in the URL before the query is issued. For example, [_|now('yyyy-MM-dd')] evaluates the current date.
• 処理の遅延 インプットフォルダに置かれたファイルの処理を遅延させる時間（秒）。これは旧式の設定です。代替として、ローカルファイルシステムの管理にはFile コネクタの使用がベストプラクティスです。
• Signature Algorithm The algorithm to use when signing outgoing messages. The same algorithm is requested for the corresponding MDN receipts.
• Sign Header Payload By default, the connector only signs the body of the SOAP message. Check this to have the connector also sign the headers.
• Security Token Format Determines the format used for security tokens in SOAP payloads.
  X509 references contain the certificate subject in DN (distinguished name) format.
  Binary tokens use the Base64 encoded contents of the entire public key.
  KeyIdentifier references contain the X509 Subject-Key-Identifier format.
• ローカルファイルスキーム コネクタがアウトプットするメッセージにファイル名を割り当てるスキーム。ファイル名にマクロを動的に使用して、識別子やタイムスタンプなどの情報を含めることができます。詳しくは、マクロ を参照してください。
• TLS Enabled Protocols The list of SSL/TLS protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. Keep in mind that some obsolete operating systems do not support TLS 1.2.
• Verification Certificate The public certificate used to verify incoming SOAP responses. This field is only necessary if a different certificate should be used to verify signatures than the public certificate set in Encryption Certificate.

Message

• Sent フォルダに保存 チェックすると、コネクタで処理されたファイルをコネクタのSent フォルダにコピーします。
• Sent フォルダのスキーム 選択された時間間隔に従ってSent フォルダ内のメッセージをグループ化するようコネクタに指示します。例えば、Weekly オプションを選択すると、コネクタは毎週新しいサブフォルダを作成してその週のすべてのメッセージをそのフォルダに格納します。ブランクに設定すると、コネクタはすべてのメッセージをSent フォルダに直接保存します。多くのメッセージを処理するコネクタの場合、サブフォルダを使用するとメッセージが整理されてパフォーマンスが向上します。

Logging

• Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
• Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
• Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

• Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.

Establishing a Connection

The Service Endpoint and Service Action for the target web service are required to establish a connection. Some web services might require one or more security features for SOAP requests:

• Encryption/Signing (WS-Security)
• Client SSL Authentication
• HTTP Authentication

SOAP Templates

The SOAP connector can simplify the process of generating SOAP requests through the use of a WSDL file and an XML Map connector that is connected to the SOAP connector in the flow. The WSDL file defines the appropriate XML structure for SOAP requests, and the XML Map connector can transform any XML structure into this target structure.

After using the Import WSDL button to import the file, connect an XML Map connector to the SOAP connector (so that files processed by the XML Map connector are then sent to the SOAP connector). After saving these flow changes, the XML Map connector can dynamically read the WSDL XML and use it as a Destination File template. Then, upload any source XML structure as the Source File in the XML Map connector.

After the Source File and Destination File are set in the XML Map connector, the visual designer is populated with the source and destination structures. Drag-and-drop elements from the source to the destination to map the relationship between the two XML structures. After the mapping is complete, files that match the Source File are automatically converted into SOAP requests by the XML Map connector.

Macros

ファイルの命名規則にマクロを使用することで、組織の効率とデータの文脈的理解を高めることができます。マクロをファイル名に組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を動的に含めることができ、各ファイルに有益なコンテキストを付与できます。これにより、組織にとって重要な詳細をファイル名に反映させることができます。

CData Arc はこれらのマクロをサポートしており、すべて次の構文を使用します：%Macro%

Macro	説明
ConnectorID	コネクタのConnectorID を返します。
Ext	コネクタが処理中のファイルの拡張子を返します。
Filename	コネクタが処理中のファイルのファイル名（拡張子を含む）を返します。
FilenameNoExt	コネクタが処理中のファイルのファイル名（拡張子なし）を返します。
MessageId	コネクタがアウトプットするメッセージのMessageId を返します。
RegexFilename:pattern	コネクタで処理中のファイルのファイル名にRegEx パターンを適用します。
Header:headername	コネクタが処理中のメッセージのヘッダー（headername）の値を返します。
LongDate	システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で返します。
ShortDate	システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で返します。
DateFormat:format	システムの現在の日時を指定されたフォーマット（format）で返します。使用可能な日付フォーマットについては、サンプル日付フォーマット を参照してください。
Vault:vaultitem	指定されたvault 項目の値を返します。

例

%Ext% や%ShortDate% などの引数を必要としないマクロもありますが、引数を必要とするマクロもあります。引数を渡すマクロはすべて次の構文を用います：%Macro:argument%

以下は、引数を渡すマクロの例です。

• %Header:headername%：headername はメッセージのヘッダー名です。
• %Header:mycustomheader% は、インプットメッセージで設定されたmycustomheader ヘッダーの値を返します。
• %Header:ponum% は、インプットメッセージで設定されたponum ヘッダーの値に対応します。
• %RegexFilename:pattern%：pattern は正規表現パターンです。例えば、%RegexFilename:^([\w][A-Za-z]+)% はファイル名の最初の単語と照合し、大文字と小文字を区別せずに結果を返します（test_file.xml はtest に変換されます）。
• %Vault:vaultitem%:vaultitem は、vault のアイテム名です。例えば、%Vault:companyname% はVault に保存されているcompanyname アイテムの値を返します。
• %DateFormat:format%：format は使用可能な日付フォーマットです（詳細はサンプル日付フォーマット を参照してください）。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% はファイルの日付とタイムスタンプを返します。

以下の例に示すように、より詳細なマクロを作成することもできます。

• 複数のマクロを1つのファイル名にまとめる：%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
• マクロの外側にテキストを含める：MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
• マクロ内にテキストを含める：%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%