This task provides a method for the user to find a specific Client File by specifying a Wild Card type of information in the request. In this case, the user will receive a list of Client Files that match the data entered, even if there is only one match found. This task should be used with caution, as the resulting amount of data can be very resource intensive.
Transaction Name:
ClientFile_2
Can any other transaction(s) perform this same task?
This is the only transaction available to list Client File/PRO-File information.
Can this task be performed in a sessionless environment?
This task can be performed in a sessioned or sessionless environment with the exception of <MoreData> processing which is not allowed in a sessionless environment. Security checks are in place to ensure the user can only list either their own Client Files or Client Files that they have authority to access.
Are the request and response identical on both the Apollo and Galileo systems?
The request and response for this task are identical on both the Apollo and Galileo systems. The data returned is defined in such a way that each user can define their display format independently.
List any industry-specific knowledge required to understand this task in terms of the specific business process.
Client File list scenarios allowed for structured data are not as numerous as those allowed through terminal entries. Client File lists allowed through this transaction include:
Explain any special limits or restrictions to the input data that may not be readily apparent.
All appropriate levels of information must be supplied. Agency information (CRS and Pseudo City) must always be supplied. When requesting a list of Personal Files, the full Business File title must be supplied.
Request:
Unless otherwise specified, use ALL CAPS in any request data.
For a Client File/PRO-File list request, a <ClientFileMods> tag is required with a <ClientFileListMods> tag. The <ClientFileListMods> tag must contain the CRS and Pseudo City of the Client File owner, the Business File Title if the request is for a list of Personal Files, and at least one alphanumeric of the Business File Title if the request is for a list of Business Files.
Prerequisite tasks:
No prerequisite tasks apply to this transaction.
Expected response:
The response from a Client File/PRO-File list request will be in a <ClientFile> tag and can take one of two forms:
Error and warning responses:
The most common error returned will be an error that no match (exact or similar) was found. Possible errors include but are not limited to:
Follow-on requests:
If a <ClientFileSingleTitleList> tag is returned and more data is available, a <MoreData> tag will also be returned. In this scenario, the <MoreData> tag would be sent back to the Host in a <ClientFileMods> tag to retrieve the additional data. This process continues until a <MoreData> tag is no longer returned, meaning that all data has now been retrieved, or until the required Client File is found. The <MoreData> tag is not available in a sessionless environment.
When List processing is invoked in Client file from a Structured Data request, the list response is built as if a Printability entry was used. This allows up to 500 Titles to be returned in the list.
|
<ClientFileMods> |
Terminal Equivalents: |
Apollo SLB |
Galileo CLB |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||||
|
|
CFL |
1 – 1 |
<ClientFileListMods> |
||||
|
<ClientFile> |
Business File Title List returned (At least 1 match found) |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
A |
CFSL |
1-500 |
<ClientFileSingleTitleList> |
||
|
B |
MORE |
0-1 |
<MoreData> |
||
|
<ClientFile> |
If Error occurred |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
|
EROR |
1-1 |
<ErrText> |
||
|
<ClientFileMods> |
Terminal Equivalents: |
Apollo SLP/BAR |
Galileo CLP/BAR |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||||
|
|
CFLT |
1 – 1 |
<ClientFileListMods> |
||||
|
<ClientFile> |
Personal File Title List returned |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
A |
CFSL |
1-500 |
<ClientFileSingleTitleList> |
||
|
B |
MORE |
0-1 |
<MoreData> |
||
|
<ClientFile> |
If Error occurred |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
|
EROR |
1-1 |
<ErrText> |
||
|
<ClientFileMods> |
Terminal Equivalents: |
Apollo P-SL*MORE |
Galileo P-CL*MORE |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||||
|
|
MORE |
1 – 1 |
<MoreData> |
||||
|
<ClientFile> |
Personal/Business File Title List returned |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
A |
CFSL |
1-500 |
<ClientFileSingleTitleList> |
||
|
B |
MORE |
0-1 |
<MoreData> |
||
|
<ClientFile> |
If Error occurred |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||
|
|
EROR |
1-1 |
<ErrText> |
||