This task allows the user to maintain (modify) an existing Client File. The functions that form the Client File Maintenance process include adding, deleting, or changing existing data. Multiple occurrences of add, delete, and change modifications can be done in one request.
Transaction Name:
ClientFile_2
Can any other transaction(s) perform this same task?
This is the only transaction available to maintain 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. In either case, the Client File to be maintained must have been retrieved first. This can be accomplished by sending two <ClientFileMods> tags, the first with the retrieval request and the second with the maintenance request.
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.
List any industry-specific knowledge required to understand this task in terms of the specific business process.
The user must know what type of data is being added or changed in order to supply the correct data type (also know as TID values). Other information such as Client File line number, Transfer Code/Move Indicator, and other data in the <ClientFileFixedLineData> tag must be supplied in a correct manner.
The user must also be aware of the valid input for each data type. An example of each will be shown along with the data type values in the documentation for the <ClientFileFixedLineData> tag.
Explain any special limits or distinct restrictions to the input data that may not be readily apparent.
Only twelve lines at a time can be maintained in a Client File Maintenance request.
In the <ClientFileFixedLineData> tag, in the MoveInd field, in the request, Transfer Line Codes of Y, N, and O, R, and B are allowed. (Transfer Code of X is unique to Structured Data Maintenance and is required when deleting a Client File Line).
TID values in the <ClientFileFixedLineData> tag, in the DataType field, that have no Apollo or Galileo Action code are not accepted for Maintenance. Exception to this are the 0031, which is a text-only field, and the 0045, which is a blank line. See the TID Values in the Industry Code Reference > Client File TID Values page.
In a sessionless environment, ClientFile_2 cannot be used to modify Client File information in another pseudo with which your pseudo has a selective access agreement. A sessioned environment must be used to modify Client File information in another pseudo to which you have access.
Request:
Unless otherwise specified, use ALL CAPS in any request data.
For a Client File/PRO-File maintenance request, a <ClientFileMods> tag is required with a <ClientFileMaintenanceMods> tag and a set of <ClientFileFixedLineData>/<ClientFileVariableLineData> tags for each line to be maintained. The exceptions to the <ClientFileFixedLineData>/<ClientFileVariableLineData> tag set are a Delete Line and a Blank Line which require a <ClientFileFixedLineData> tag only. For a Delete Line, the <ClientFileFixedLineData> tag contains the Line Number to delete (or a Line Number of 999 if all lines are to be deleted) and a Move Indicator of ‘X’. For a Blank Line, the <ClientFileFixedLineData> tag contains the Line Number of the Blank Line and a Move Indicator of 'B'. The <ClientFileMaintenanceMods> 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 maintained), and the Type of Client File. These fields are all described in detail in the request and response html documentation. The fields in the <ClientFileFixedLineData> tag and <ClientFileVariableLineData> tag are also described in detail in the request and response html documentation.
Prerequisite tasks:
Before a Client File/PRO-File maintenance request, the Client File to be maintained must be retrieved. For additional details on this process, see the documentation for Task: Client File/PRO-File Display. In this case, the ‘all level’ option for Client File display cannot be used.
Expected response:
The response from a Client File/PRO-File maintenance 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 editing error for data in the request. These errors can vary in text, but will be self-explanatory. Other possible errors include, but are not limited to:
If an error occurs at any time during the processing of the requested data, no data is processed and an error is returned.
Follow-on requests:
There are no follow-on requests.
|
<ClientFileMods> |
Terminal Equivalents: |
Apollo RC:1Y/N:TEST |
Galileo C@1Y/N.TEST |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||||
|
A |
CFUP |
1 – 1 |
<ClientFileMaintenanceMods> |
||||
|
B |
CFFD |
1-12 |
<ClientFileFixedLineData> |
||||
|
C |
CFVD |
0-12 |
<ClientFileVariableLineData> |
||||
|
B and C above repeat for each line to be maintained up to 12 lines |
|
|
If the request is to delete a line, a <ClientFileVariableLineData> tag is not necessary for that line. If the request is for a Blank line, a <ClientFileVariableLineData> tag is not necessary for that line. |
||||
|
<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> |
||