Using Import to Create Summary Payment Application Records
You can export a CSV or Microsoft Excel template that includes the upper form and detail form fields as columns. The template includes the header fields from the upper form and the line item SOV fields from the detail form, including the detail line item fields defined in Integration.
You can modify the exported CSV or Excel template and import it to create the upper form header information and the detail line items for the new business process (BP).
Export the Summary Payment Application Template
To export the template:
- Navigate to the Summary Payment Application BP log.
- From the toolbar, select Actions, and then select Export CSV Template or Export Microsoft Excel Template.
Depending on your browser, the template downloads automatically, or you are prompted to download it manually.
Modify the Template
To modify the template:
- Open the exported CSV or Excel file in Microsoft Excel.
- Enter the BP information in the spreadsheet.
Each upper form header record must begin with
H. Each line item must begin withD. For multiple tabs, enter the appropriate tab name in the Tab Name column. - Enter data in the required fields and any nonrequired fields as needed.
Important Information
- Data for formula-based columns is ignored.
- If you provide auto-populated data, the system imports the value and does not override it, except for fields auto-populated by Base Commit, Change Commit, or SOV.
- If a data element (DE) is set to auto-populate from a Base Commit, Change Commit, or SOV, the auto-populated value takes precedence when a zero value is sent for that DE in CSV, Excel, or the REST API. Any value specified in the input request is ignored.
- Any line items with an amount of zero are not imported.
- Use this process to add new BP records only. Do not use it to modify existing BPs.
- For data to import correctly, you might need to change some cells in the CSV file to text type. For example, if you have a CBS code of 1-1, Microsoft Excel can interpret the entry as a month-day combination and reformat it to Jan-1. In this case, the data import fails because the CBS code is invalid.
Import the Template
To import the template:
- Navigate to the Summary Payment Application BP log.
- From the toolbar, select Actions, select Import, and then select From CSV Template or From Microsoft Excel Template.
- Browse to select the file to import, and then select Next.
- Add any attachments to the import.
- Select Upload when you finish.
If any import errors occur, open the CSV or Excel file, correct the errors, and import the file again. If any row contains an import error, the system imports no records.
Note:
If the Add only edited SOV Line Items option is selected in uDesigner, only the edited line items are saved when you import the template through CSV, Excel, or REST APIs.
Adding Partial Line Items
When you add partial line items through CSV or Excel import, or through REST APIs, to a Summary Payment Application BP, the system adds the other existing SOV lines along with the line items that you provide in the CSV, Excel, or REST API request.
When you create payment line items through CSV or Excel import, or through REST APIs, you can add all payment line items to the grid to prevent data discrepancies in the Schedule of Values (SOV). To prevent data discrepancies in the SOV when the payment record is approved, you can view all the SOV line items that are added to the payment grid on the Standard tab in the following situations:
- Partial line items are included in the CSV or Excel import or REST API request.
- The record is created through CSV or Excel import or through a REST API request.
- The record is created through a REST API request (Create BP Record) and partial line items are included in the input request.
- The record is updated through a REST API request (Update BP Record) and partial line items are included in the input request, provided that no other line items were added to the payment grid.
When you create payment applications in the Payment Items tab and export the record CSV or Excel template, or the line item CSV or Excel template:
- If the payment record is created through line items or partial line items by using input from the CSV or Excel template, the system adds all existing SOV lines to the payment grid along with the imported line items, if the import succeeds.
- If the payment record is created without line items or partial line items, the system does not add any line items or partial line items to the payment grid.
- If the payment record is created by adding all the payment line items by using input from the CSV or Excel template, the system adds all line items to the payment grid when the import succeeds.
Required String Data Elements
Oracle recommends that you set the data definition (DD) value as the default, or define auto-population, when the payment detail form has required string DEs, such as a short description.
If a required string DE does not include a value, the CSV or Excel import, or REST API request, fails because the system adds all the existing line items from the SOV into the payment grid. In this situation, the system generates an error email for record creation, or an error message in the imported CSV template for line item creation.
The system validates payment line items that you add through CSV or Excel import, or through a REST API request, against the SOV line items even if partial line items were added earlier.
Note:
The existing process remains the same for CSV or Excel import, or REST API requests, for line items in nonstandard tabs within Summary Payment Application SOV BPs.When you export the record or line item CSV or Excel template, the template displays this message: The system will add existing SOV lines into the payment grid when importing partial line items.