Data can be sent to a destination application using the File provider in a CSV, Excel (xls or xlsx), or XML file.
Depending on how you want to organize the data within the CSV or Excel file, select any of the following options to create a CSV file:
- Create a CSV or Excel file per project
OR
- Create a single CSV or Excel file containing data from multiple projects
For multiple projects, you can further organize the data in the CSV file as follows:
- Organize the data by object
Each row for an object lists the values corresponding to the object in each project. Therefore, if an object is used in two projects, the CSV or Excel file will contain two rows, with each row listing the values of the object in each project.
OR
- Organize the data by project
Each row of a project lists an object with its corresponding values included in the project. Therefore, a CSV or Excel file with two projects will include the first project with a list of objects and its corresponding values in each row, followed by the second project containing a list of objects and its corresponding objects in each row.
- Organize the data by object
For detailed examples of a CSV file, see the File Provider Setup Guide.
Note: Any user can create a CSV or Excel source file, however the processing of these files in Gateway will be determined by the user's role in Primavera Gateway.
A CSV or Excel format file that is to be consumed by Primavera Gateway must be specially formatted to contain specific indicators. Indicators are containers of the data represented in the csv file. Gateway uses these indicators as markers to read and write the data contained within these indicators.
The following types of indicators are supported in a csv format file for Gateway:
Indicator | Indicator Name | Description | Required? |
|---|---|---|---|
ON | Object | The Object (ON) Indicator represents the name of the provider object in the CSV file. The first column of the spreadsheet must always contain the indicators. A parser or generator will search for a row labeled 'ON' to begin reading or generating a file. Note: A csv file must contain at least 1 object row (ON). | Yes if you use the Default Parser or Default Generator in the synchronization. No if you use any other parser or generator in the synchronization. |
FH | Field Header | The Field Header (FH) Indicator represents the fields contained in a provider object. Each ON indicator must be followed by an FH indicator. For example, a Role object containing two fields, ID and Name. | Yes |
DR | Data Row | The Data Row (DR) indicator contains the values of the fields of the provider object. | Yes |
AR | Attachment Row | The Attachment Row (AR) Indicator represents a file attachment included with the provider object. The attachment can be any file format. For example, pdf, docx, doc, png, etc. | No |
The file content is processed in Gateway using parsers and generators during a synchronization. For detailed examples of CSV or Excel files that can be processed in Gateway, see the File Provider Setup Guide.