Task: Client File/PRO-File Delete

This task allows the user to delete an existing Client File. Either a Business or Personal Client File can be deleted. In addition, up to 40 Personal Files for a particular Business File can be deleted.

Section 1: Short Answer

Transaction Name:

ClientFile_1_2

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

This is the only transaction available to Delete a Business or Personal Client File.

Can this task be performed in a sessionless environment?

This task can be performed in a sessioned or sessionless environment.

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.

Industry-specific knowledge required to understand this task:

The User must be sure that the Business or Personal File(s) they deleted are correct.

Special limits or distinct restrictions:

If the request if to Delete a Business File, the Business File must first be retrieved. For details on the Client File retrieve process see the task document Client File/PRO-File Display.

Section 2: Detailed Description

Request

For a Client File/PRO-File Delete request, a <ClientFileMods> (5900 Data Record) is required with a <DeleteHeader> tag The <DeleteHeader> must contain the CRS and Pseudo City of the owner of the Client File to be Deleted, the Business and/or Personal File Titles of the Client File (depending on the type of record being Deleted), and the Type of Client File.

Prerequisite Tasks

The Business File must be retrieved prior to deleting the Business and/or Personal File(s). If multiple Personal Files are to be deleted, the Business File they belong to, along with all Personal File titles, must be present.

Response

The response from a Client File/PRO-File Delete request will be in a <ClientFile> (5901 Data Record) and can take one of three forms:

Positive Acknowledgment that the Delete request was completed successfully. If multiple Personal Files are to be deleted, this response will indicate that all requested Personal Files were successfully deleted.
<ErrText> with an error response.
Multiple <ErrorList>/<PositiveList> tags. This scenario only applies when multiple Personal Files are to be deleted and some were successfully deleted and some were not.

Error and Warning Responses

Possible errors include, but are not limited to:

BUSINESS FILE DISPLAY REQUIRED
NO PERSONAL FILES DELETED

Follow-on Requests

There are no follow on requests.

Section 3: Tables

Request (Input) Tags

<ClientFileMods>		Terminal Equivalents:			Apollo _VDB/BAR_____ _VDP/BAR-PAR__ _VDP/BAR-PAR\|PAR		Galileo _VDB/BAR_____ _VDP/BAR-PAR__ _VDP/BAR-PAR\|PAR
	Ordering		KLR	Min/Max		XML Tag
	A		CFDH	1 – 1		<DeleteHeader>

Response (Output) Tags

<ClientFile>		If no error occurred during the process
	Ordering		KLR	Min/Max	XML Tag
			CFPA	1 – 1	<ClientFilePositiveAck>

<ClientFile>		If Error occurred
	Ordering		KLR	Min/Max	XML Tag
			EROR	1 – 1	<ErrText>

<ClientFile>		If Multiple Personal Files are to be deleted and not all were deleted successfully
	Ordering		KLR	Min/Max	XML Tag
	A		CFEL	1 – 39	<ErrorList>
	B		CFPL	1 – 39	<PositiveList>
	The total of A and B will match the total of the number of Personal Files in the Request. There will be at least one of each type of KLR.				The data in the <ErrorList>/<PositiveList> elements are the Personal File titles. Each <ErrorList> will have the title of a Personal File that was not deleted, and each <PositiveList> will have the title of a Personal File that was successfully deleted.

Related Samples