Task: Client File/PRO-File Display

This task retrieves a Specific Client File and all the data that resides in that Client File. In addition, the act of retrieving a Client File will also ‘activate’ any associated TravelScreen preferences. For more information, see the TravelScreen_5_2 transaction.

This task is required in a sessionless environment before Client File Maintenance can be performed.

If the exact Title of the Client File is unknown, a Wild Card option can be used during the retrieval process. In this case, the user will receive a list of Client Files that match the data entered. Additional details on how the Wild Card process is used can be found in Section 2 – Detailed Description and Section 3 - Tables.

Section 1: Short Answer

Transaction Name:

ClientFile_2

Can any other transaction(s) perform this same task?

This is the only transaction available to retrieve 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 retrieve either one of their own Client Files or a Client File 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. Data is returned in a Non-Host specific format for ease of processing by the user.

List any industry-specific knowledge required to understand this task in terms of the specific business process.

Client File data can be requested by single level (Agency, Business, or Personal), or by all levels. For a display of all levels, all appropriate levels will be retrieved based on the Client File hierarchy described in the Quick Info page. For example:

• Request for Personal File (all levels specified) will return Agency, Business, and Personal Files.
• Request for Business File (all levels specified) will return Agency and Business Files.

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 retrieving a Personal File, information on the associated Business File must also be supplied. If the request is being done as a prerequisite to Client File Maintenance, the ‘all level’ option cannot be used. The request must be for the specific level to be maintained.

Section 2: Detailed Description

Request:

Unless otherwise specified, use ALL CAPS in any request data.

For a Client File/PRO-File display request, a <ClientFileMods> tag is required with a <ClientFileDisplayMods> tag. The <ClientFileDisplayMods> tag must contain the CRS and Pseudo City of the owner of the Client File, the Business and/or Personal File Titles of the Client File (depending on the type of record being requested), the Type of Client File, and a Preference indicator.

Prerequisite tasks:

No prerequisite tasks apply.

Expected response:

The response from a Client File/PRO-File display request will be in a <ClientFile> tag and can take one of three forms:

• A <ClientFileTypeDisplayHeader> tag and sets of <ClientFileFixedLineData> tags and <ClientFileVariableLineData> tags for each level of Client File requested if a single match is found.
• <ClientFileSingleTitleList> tag or <ClientFileDoubleTitleList> tag (with possibly a <MoreData> tag) if a Similar Name List is returned, or if a Wild Card request was made to begin with.
• <ErrText> tag with an error response.

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:

• VERIFY – UNABLE TO LOCATE TITLE/S     No match at all could be found
• VERIFY – FORMAT                                    Information in the request is incorrect

Follow-on requests:

If a <ClientFileSingleTitleList> tag or <ClientFileDoubleTitleList> tag is returned (for Similar Name List and Wild Card responses) and more data is available, a <MoreData> tag will also be returned. In this scenario, the <MoreData> tag will be sent back to the Host in a <ClientFileMods> tag to retrieve the additional data. This process continues until no <MoreData> tags are returned, meaning that all data has now been retrieved or until the required Client File is found. The <MoreData> tag processing is not available in a sessionless environment.

When Wild Card 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.

Section 3: Tables

1) Business File Retrieve

Request (Input) Tags

Response (Output) Tags

2) Business File Retrieve (with Wild Card)

Request (Input) Tags

Response (Output) Tags

3) Personal File Retrieve

Request (Input) Tags

Response (Output) Tags

4) Personal File Retrieve (with Wild Card)

Request (Input) Tags

Response (Output) Tags

5) Personal File Retrieve (with unknown Business File Title)

Request (Input) Tags

Response (Output) Tags

6) More Request (in conjunction with <ClientFileSingleTitleList> response)

Request (Input) Tags

Response (Output) Tags

7) More Request (in conjunction with <ClientFileDoubleTitleList> response)

Request (Input) Tags

Response (Output) Tags

Related Samples

ClientFile_2_s10

ClientFile_2_s11

ClientFile_2_s5

ClientFile_2_s1

ClientFile_2_s2