FINS IFX XML Converter Methods and Arguments
The FINS IFX XML Converter methods and arguments are described in the following tables. The following table describes the FINS IFX XML Converter methods.
Method | Display Name | Function |
---|---|---|
PropSetToXML |
PropSetToXML |
Generate the XML message to be sent. |
PropSetToXMLPropSet |
PropSetToXMLPropSet |
Prepare the DOM structure of the XML message to be sent. |
XMLPropSetToPropSet |
XMLPropSetToPropSet |
Convert the XML message received into hierarchical property sets. |
XMLToPropSet |
XMLToPropSet |
Prepare the hierarchical property sets from DOM structure of the XML message received. |
Generate Envelope Only |
Generate Envelope Only |
Generate an IFX document that contains only an IFX envelope and header. No body portion. |
The following table describes the arguments common to FINS IFX XML Converter methods.
Argument | Value | Description |
---|---|---|
Client Application Name |
<Client application name> |
Required input string. Value of <Name> of <ClientApp> aggregate. |
Client Application Organization |
<Client organization name> |
Required input string. Value of <Org> of <ClientApp> aggregate. |
Client Application Version |
<Client application version> |
Required input string. Value of <Version> of <ClientApp> aggregate. |
Date Input Format |
<Date format> |
Optional input string. Default value: YYYY-MM-DD |
Date Output Format |
<Date format> |
Optional input string. Default value: YYYY-MM-DD |
DateTime Input Format |
<Date, time format> |
Optional input string. Default value: YYYY-MM-DDTHH:mm:ss.0Z |
DateTime Output Format |
<Date, time format> |
Optional input string. Default value: YYYY-MM-DDTHH:mm:ss.0Z |
Time Input Format |
<Time format> |
Optional input string. Default value: HH:mm:ss.0Z |
Time Output Format |
<Time format> |
Optional input string. Default value: HH:mm:ss.0Z |
YrMon Input Format |
<Year, month format> |
Optional input string. Default value: YYYY-MM |
YrMon Output Format |
<Year, month format> |
Optional input string. Default value: YYYY-MM |
Enable Data Formatting |
true, false |
Optional input string. Default value: false. See additional explanation in Siebel Versus IFX Data Formats. |
IFX Application Business Service Name |
<Business service name> |
Optional input string. Business service name that contains out-called functionality. If no value is entered, the connector uses default functionality. See the next section for further information about outcalls. |
Is Log Out |
true, false |
Optional input string. Set to “true" for signing off IFX session. |
Is Client |
true, false |
Optional input string. Set to “true" if connector is used at client side. Default value: “True". |
Service Provider Name |
<IFX service provider name> |
Optional input string. Value of <SPName> of <xxxSvcRq> aggregate. |
XMLEnvIntObjectName |
<Integration object name> |
Required input string. Name of the integration object that defines IFX envelope. |
XML Property Set |
<XML hierarchy> |
Required input hierarchy. |
The following table provides specifications for the PropSetToXML method arguments.
Name | Display Name | Date Type | Type | Optional |
---|---|---|---|---|
Client Application Name |
Client Application Name |
String |
Input |
No |
Client Application Organization |
Client Application Organization |
String |
Input |
No |
Client Application Version |
Client Application Version |
String |
Input |
No |
Date Output Format |
Date Output Format |
String |
Input |
Yes |
DateTime Output Format |
DateTime Output Format |
String |
Input |
Yes |
Time Output Format |
Time Output Format |
String |
Input |
Yes |
YrMon Output Format |
YrMon Output Format |
String |
Input |
Yes |
Enable Data Formatting |
Enable Data Formatting |
String |
Input |
Yes |
IFX Application Business Service Name |
IFX Application Business Service Name |
String |
Input |
Yes |
Is Log Out |
Is Log Out |
String |
Input |
Yes |
Is Client |
Is Client |
String |
Input |
Yes |
Service Provider Name |
Service Provider Name |
String |
Input |
Yes |
XMLEnvIntObjectName |
XMLEnvIntObjectName |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Output |
No |
The following table provides specifications for the PropSetToXMLPropSet method arguments.
Name | Display Name | Date Type | Type | Optional |
---|---|---|---|---|
Client Application Name |
Client Application Name |
String |
Input |
No |
Client Application Organization |
Client Application Organization |
String |
Input |
No |
Client Application Version |
Client Application Version |
String |
Input |
No |
Date Output Format |
Date Output Format |
String |
Input |
Yes |
DateTime Output Format |
DateTime Output Format |
String |
Input |
Yes |
Time Output Format |
Time Output Format |
String |
Input |
Yes |
YrMon Output Format |
YrMon Output Format |
String |
Input |
Yes |
Enable Data Formatting |
Enable Data Formatting |
String |
Input |
Yes |
IFX Application Business Service Name |
IFX Application Business Service Name |
String |
Input |
Yes |
Is Log Out |
Is Log Out |
String |
Input |
Yes |
Is Client |
Is Client |
String |
Input |
Yes |
Service Provider Name |
Service Provider Name |
String |
Input |
Yes |
XMLEnvIntObjectName |
XMLEnvIntObjectName |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Output |
No |
The following table provides specifications for the XMLPropSetToPropSet method arguments.
Name | Display Name | Date Type | Type | Optional |
---|---|---|---|---|
Date Input Format |
Date Input Format |
String |
Input |
Yes |
DateTime Input Format |
DateTime Input Format |
String |
Input |
Yes |
Time Input Format |
Time Input Format |
String |
Input |
Yes |
YrMon Input Format |
YrMon Input Format |
String |
Input |
Yes |
Enable Data Formatting |
Enable Data Formatting |
String |
Input |
Yes |
IFX Application Business Service Name |
IFX Application Business Service Name |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Input |
No |
XML Property Set |
XML Property Set |
String |
Output |
No |
The following table provides specifications for the XMLToPropSet method arguments.
Name | Display Name | Date Type | Type | Optional |
---|---|---|---|---|
Date Input Format |
Date Input Format |
String |
Input |
Yes |
DateTime Input Format |
DateTime Input Format |
String |
Input |
Yes |
Time Input Format |
Time Input Format |
String |
Input |
Yes |
YrMon Input Format |
YrMon Input Format |
String |
Input |
Yes |
Enable Data Formatting |
Enable Data Formatting |
String |
Input |
Yes |
IFX Application Business Service Name |
IFX Application Business Service Name |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Output |
No |
The following table provides specifications for the Generate Envelope Only method arguments.
Name | Display Name | Date Type | Type | Optional |
---|---|---|---|---|
Client Application Name |
Client Application Name |
String |
Input |
No |
Client Application Organization |
Client Application Organization |
String |
Input |
No |
Client Application Version |
Client Application Version |
String |
Input |
No |
Date Output Format |
Date Output Format |
String |
Input |
Yes |
DateTime Output Format |
DateTime Output Format |
String |
Input |
Yes |
Time Output Format |
Time Output Format |
String |
Input |
Yes |
YrMon Output Format |
YrMon Output Format |
String |
Input |
Yes |
Enable Data Formatting |
Enable Data Formatting |
String |
Input |
Yes |
IFX Application Business Service Name |
IFX Application Business Service Name |
String |
Input |
Yes |
Is Log Out |
Is Log Out |
String |
Input |
Yes |
Is Client |
Is Client |
String |
Input |
Yes |
Service Provider Name |
Service Provider Name |
String |
Input |
Yes |
XMLEnvIntObjectName |
XMLEnvIntObjectName |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Input |
Yes |
XML Property Set |
XML Property Set |
String |
Output |
No |