Altova MapForce Server 2020 

addCredentialPropertiesFromMap

資格情報プロパティマップから現在の資格情報にプロパティを追加します。資格情報プロパティマップ (property_name, property_value)を引数として取ります。このメソッドは beginCredential() を呼び出す後、および endCredential() を呼び出す前にに呼び出される必要があります。メソッドを呼び出す代わりに、AddCredentialProperty() を呼び出すこともできます。

addCredentialProperty

現在の証明書にプロパティを追加する (例えば、ユーザー名、パスワード、または両方)。最初の引数は、プロパティの名前を指定し、2番目の引数はプロパティの値を指定します。有効なプロパティ名: username, password.MapForce Server Advanced Edition ではプロパティ名 oauth:token を追加でサポートしています。

このメソッドは beginCredential() を呼び出す後、および endCredential() を呼び出す前にに呼び出される必要があります。メソッドを呼び出す代わりに、addCredentialProperty() を呼び出すこともできます。

addParameter

マッピング内で定義されているパラメーターに値を割り当てます。

beginCredential

引数として与えられている新規の資格情報を作成します。このメソッドを呼び出す場合、 addCredentialProperty() or addCredentialPropertiesFromMap() を使用してプロパティを追加する必要があり、最後に endCredential() を呼び出して資格情報を閉じます。

clearCredentialList

前に設定された資格情報のリストをクリアする。オブジェクトのライフタイムのためにすべての資格情報は有効です。前に設定された資格情報を明示的にクリアする必要がある場合、このメソッドを呼び出します。

clearOptions

setOption() メソッドにより設定されたオプションのリストをクリアします。setOption メソッドにより設定されたすべてのオプションはオブジェクトのライフタイムの期間有効です。前に設定されたオプションを明示的にクリアする必要がある場合、このメソッドを呼び出します。

clearParameterList

addParameter メソッドを使用して設定されたパラメーターのリストをクリアします。

endCredential

beginCredential メソッドを使用して以前に作成された資格情報オブジェクトを閉じます。

getAPIMajorVersion

MapForce Server API のメジャーなバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

getAPIMinorVersion

MapForce Server API のマイナーバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

getAPIServicePackVersion

MapForce Server API のサービスパックバージョンを取得します。API が他のサーバーに接続されている場合、製品バージョンとは異なる場合があります。

getLastExecutionMessage

最後の run コマンド中に受け取ったメッセージを取得します。

getMajorVersion

1998 から始まる製品のメジャーバージョンを取得します (例えば、 Altova MapForce Server 2018 のために"20" など )。

getMinorVersion

製品のマイナーバージョンを取得します (例えば、Altova MapForce Server 2018 r2　のために"2" など)。

getOutputParameter

最後の run コマンドから生成された文字列の出力を取得します。出力が生成されない場合 null を返します。この関数は、 MapForce 内の出力コンポーネントの名前を識別する文字列パラメーターを必要とします。

getProductName

製品の名前を取得します (例えば、Altova MapForce Server など)。

getProductNameAndVersion

製品のの完全な名前とバージョンを取得します (例えば、 "Altova MapForce Server 2018 r2 sp1 (x64)")。

getServicePackVersion

製品のサービスパックのバージョンを取得します (例えば、 Altova MapForce Server 2018 r2 sp1 (x64)のために "1" など)。

is64bit

MapForce Server エンジンが 64 ビットの実行可能ファイルの場合、 true を返します。

run

MapForce Server 実行ファイル (.mfx ファイル)を実行します。成功の場合は、trueを返し、それ以外の場合、false を返します。

setOption

マッピングを実行する前のオプションを設定します。最初の引数は、オプションの名前を指定し、2番目の引数はオプションの値を指定します。このメソッドはマッピングがグローバルリソースを消費するためにデザインされている場合とても役に立ちます (Altova グローバルリソースを参照してください)。現在サポートされているオプションは以下の通りです:

•globalresourcefile (or gr) - グローバルリソースファイルパス(このオプションが指定されている場合、グローバルリソース構成名も指定されている必要があります。次のアイテムを参照してください)。

•globalresourcefile (or gr) - グローバルリソース構成名(このオプションが指定されている場合、グローバルリソースファイルパスも指定されている必要があります。次のアイテムを参照してください)。

•catalog - カスタム RootCatalog.xml ファイルへのパスこのオプションによりマッピングにより使用された URL を解決するために使用されたカスタムカタログファイルを指定します。デフォルトのカタログはプログラムインストールディレクトリのサブディレクトリ内にあります。

•taxonomy-package - マッピングにより必要とされている場合、カスタム XBRL タクソノミパッケージへのパスです。

•taxonomy-package - マッピングにより必要とされている場合、カスタム XBRL タクソノミパッケージ構成へのパスです。

設定されたすべてのオプションはオブジェクトのライフタイムの期間有効です。同じ名前でオプションを2回設定すると、前のオプションは上書きされます。明示的にすべてのオプションをクリアするために clearOptions() メソッドを呼び出します。

setServerPath

MapForce Server 実行可能ファイルへのパスを設定します

setWorkingDirectory

実行中のジョブのために現在のディレクトリを設定します (相対的パスは、作業ディレクトリに対して評価されます)。