This task allows the user to create a new Client File. Either a Business or Personal Client File can be created. Only one Client File can be created at a time. The process utilizes multiple Client File tags as described in this document.
Transaction Name:
ClientFile_1_2
Can any other transaction(s) perform this same task?
This is the only procedure available to create 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 an response for this task are identical on both the Apollo and Galileo systems.
Industry-specific knowledge required to understand this task in terms of the specific business process
The user should have general knowledge of the Client File Hierarchy to be sure they create the Client File records correctly.
The user must know what type of data is being added to the Client File during the creation request in order to supply the correct data type (also known as TID values). Other information such as Client File line number, Transfer Code/Move Indicator, and other data in the <ClientFileFixedLineData> must be supplied in a correct manner.
Special limits or distinct restrictions to the input data:
Only 12 lines can be added to the Client File during Creation. Additional lines can be added with a subsequent Maintenance request. For more information see the task document for Client File/Pro-File Maintenance.
In the <ClientFileFixedLineData>, 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>, in the <DataType> field, that have no Apollo or Galileo Action code are not accepted for Creation. The exception to this is 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.
Request:
For a Client File/PRO-File Create request, a <ClientFileMods> (5900 Data Record) is required with a <ClientFileCreateHeaderMods>, and a set of <ClientFileFixedLineData>/<ClientFileVariableLineData> tags for each line to be added to the new Client File. The exception to the <ClientFileFixedLineData>/<ClientFileVariableLineData> set is a Blank Line which requires a <ClientFileFixedLineData> only.
For a Blank Line:
Prerequisite tasks:
No prerequisite tasks apply.
Expected response:
The response from a Client File/PRO-File Create request will be in a <ClientFile> (5901 Data Record) 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 very self-explanatory. Other possible errors include, but are not limited to:
If an error occurs at any time during the Create processing, no data is processed and the file is not created.
Follow-on requests:
There are no follow on requests.
|
<ClientFileMods> |
Terminal Equivalents: |
Apollo _BQB/BAR_____ Apollo _ BQP/BAR-PAR__ |
Galileo _BQB/BAR_____ Galileo _BQP/BAR-PAR__ |
|
||||
|
Ordering |
KLR |
Min/Max |
XML Tag |
||||
|
A |
CFQH |
1 – 1 |
<ClientFileCreateHeaderMods> |
||||
|
B |
CFFD |
1 – 12 |
<ClientFileFixedLineData> |
||||
|
C |
CFVD |
0 – 12 |
<ClientFileVariableLineData> |
||||
|
B and C above repeat for each line to be added to the new Client File up to 12 lines |
|
|
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> |
||