Converter Methods and Arguments
The FINS ACORD XML Converter methods and arguments are described in the following tables. The following table describes the FINS ACORD XML Converter methods.
Method | Display Name | Description |
---|---|---|
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 the DOM structure of the XML message received. |
ErrorHandler |
ErrorHandler |
Generate a response ACORD message with detailed error information for an operation error. |
The following table describes the arguments common to FINS ACORD XML Converter methods.
Argument Name | Value | Comments |
---|---|---|
ClientApplicationOrganization |
<Client application organization name> |
The value for <Org> in <ClientApp> |
ClientApplicationName |
<Client application name> |
The value for <Name> in <ClientApp> |
ClientApplicationVersion |
<Client application version> |
The value for <Version> in <ClientApp> |
IsClient |
true, false |
“True” if Siebel FINS is behaving as an ACORD client. “False” if Siebel FINS is behaving as an ACORD server. |
IsSignoff |
true, false |
If “true,” the converter generates a SignoffRq aggregate for the current ACORD document. If “false,” the converter does not generate a SignoffRq aggregate. |
ServiceProviderName |
<ACORD service provider name> |
The value will be used as the value of <SPName> in <SignonRq> aggregate. |
XMLEnvIntObjectName |
<Name of the envelope integration object> |
Name of the integration object that defines ACORD envelope. |
SignonRsEcho |
Property Set storing echo values from <SignonRq> |
Those echo values are used by SignonRs header. |
initsignon |
<Integration component user property of envelope integration object> |
Determine which user property in envelope integration object will be used to construct initial SignonRq header. |
sessionsignon |
<Integration component user property of envelope integration object> |
Determine which user property in envelope integration object will be used to construct subsequent SignonRq header. |
signonRs |
<Integration component user property of envelope integration object> |
Determine which user property in envelope integration object will be used to construct SignonRs header. |
signoffRq |
<Integration component user property of envelope integration object> |
Determine which user property in envelope integration object will be used to construct SignoffRq header. |
signoffRs |
<Integration component user property of envelope integration object> |
Determine which user property in envelope integration object will be used to construct SignoffRs header. |
ErrorCode |
<Error code value> |
The error code during operation to be set in the ACORD Status header. |
ErrorMessageText |
<Error message text> |
The actual error message during operation to be set in the ACORD Status header. |
GeneralErrorMessageText |
<Error message text> |
The generic error text to be pre-appended to the actual error text. For example, “The error happens before the transaction manager.” |
The following table provides specifications for the PropSetToXML method arguments.
Name | Display Name | Data Type | Type | Optional |
---|---|---|---|---|
ClientApplicationOrganization |
Client Application Organization |
String |
Input |
Yes |
ClientApplicationName |
Client Application Name |
String |
Input |
Yes |
ClientApplicationVersion |
Client Application Version |
String |
Input |
Yes |
IsClient |
Is Client |
String |
Input |
Yes |
IsSignoff |
Is Signoff |
String |
Input |
Yes |
ServiceProviderName |
Service Provider Name |
String |
Input |
Yes |
XMLHierarchy |
XML Property Set |
Hierarchy |
Input |
No |
<Value> |
XML Document |
String |
Output |
No |
XMLEnvIntObjectName |
XMLEnvIntObjectName |
String |
Input |
Yes |
SignonRsEcho |
SignonRsEcho |
Hierarchy |
Input |
Yes |
initsignon |
initsignon |
String |
Input |
Yes |
sessionsignon |
sessionsignon |
String |
Input |
Yes |
signoffRq |
signoffRq |
String |
Input |
Yes |
signonRs |
signonRs |
String |
Input |
Yes |
signoffRs |
signoffRs |
String |
Input |
Yes |
The following table provides specifications for the PropSetToXMLPropSet method arguments.
Name | Display Name | Data Type | Type | Optional |
---|---|---|---|---|
ClientApplicationOrganization |
Client Application Organization |
String |
Input |
Yes |
ClientApplicationName |
Client Application Name |
String |
Input |
Yes |
ClientApplicationVersion |
Client Application Version |
String |
Input |
Yes |
IsClient |
Is Client |
String |
Input |
Yes |
IsSignoff |
Is Signoff |
String |
Input |
Yes |
ServiceProviderName |
Service Provider Name |
String |
Input |
Yes |
XMLHierarchy |
XML Property Set |
Hierarchy |
Input/output |
No |
XMLEnvIntObjectName |
XMLEnvIntObject Name |
String |
Input |
Yes |
SignonRsEcho |
SignonRsEcho |
Hierarchy |
Input |
Yes |
initsignon |
initsignon |
String |
Input |
Yes |
sessionsignon |
sessionsignon |
String |
Input |
Yes |
signoffRq |
signoffRq |
String |
Input |
Yes |
signonRs |
signonRs |
String |
Input |
Yes |
signoffRs |
signoffRs |
String |
Input |
Yes |
The following table provides specifications for the XMLPropSetToPropSet method argument.
Name | Display Name | Data Type | Type | Optional |
---|---|---|---|---|
XMLHierarchy |
XML Property Set |
Hierarchy |
Input/Output |
No |
The following table provides specifications for the XMLToPropSet method arguments.
Name | Display Name | Data Type | Type | Optional |
---|---|---|---|---|
<Value> |
XML Document |
String |
Input |
No |
XMLHierarchy |
XML Property Set |
Hierarchy |
Input/Output |
No |
The following table provides specifications for the ErrorHandler method arguments.
Name | Display Name | Data Type | Type | Optional |
---|---|---|---|---|
ErrorCode |
ErrorCode |
String |
Input |
No |
ErrorMessageText |
ErrorMessageText |
String |
Input |
No |
GeneralErrorMessageText |
GeneralErrorMessageText |
String |
Input |
Yes |
XML Hierarchy |
ErrXMLHierarchy |
Hierarchy |
Input/Output |
Yes |