This manual explains the steps to correctly prepare and upload an Excel file to mass configure fields/columns for an entity in your system. Follow these instructions carefully to avoid errors.
Make sure to ask the Onibex team to provide you with the correct excel file for this process and to have followed the previous steps: Creating a prepackaged entity
1. Preparing the Excel File
When creating the Excel file, adhere to the following guidelines:
Column Definitions:
- Column A (Domain): Ensure the name in this column matches the entity name to which you want to assign fields.
- Column B (Entity): This column must also match the entity name exactly.
- Column C (Table): Specify the name of the table you wish to use.
- Column D (Field Name): Enter the technical name of the field to be used.
- Column E (Alias): Define an alias for the field. Avoid using spaces in the alias.
- Column F (Primary Key): Mark the primary keys with an “x” in this column.
- Column G (Filter): Mark fields that can be used as filters or criteria for data transfer with an “x” in this column. This configuration can also be adjusted directly in the entity later.
- Column H (Description): Provide a description for the field. Ensure this is not confused with the alias in Column E.
2. Uploading the Excel File
Once the Excel file is prepared, follow these steps to upload it:
Steps:
- Open the Upload Window:
Navigate to Entity Actions in OneConnect and select Upload from Excel.
- Select the File:
In the pop-up window, locate the Excel file on your system and specify the sheet name containing the data (e.g., "COLUMNS").
- Choose the Upload Option:
Select the option labeled “Load Entity Column Data.” Ensure you do NOT select “Load Entity Relations” (this option is used for uploading entity structures and tables, prevoiously explained in another documentation).
3. Executing the Upload
- Run the Upload Process:
After selecting the correct file and upload option, execute the upload process. Wait a few seconds for the configuration to be saved.
- Validate the Fields:
Navigate to the entity in your system for which you uploaded the fields/columns and verify that the fields have been uploaded correctly.
4. Modifying Fields (if needed)
If modifications are necessary, you can adjust the fields directly in the entity. Ensure that any changes are reviewed before proceeding. (Make sure to press ENTER after changing the alias of a field to ensure that the changes will be saved)
5. Saving the Customization
After validating or modifying the fields within the entity, click on “Save Customizing” to ensure all adjustments are saved.
Important Notes
- Key fields can't be changed
- Double-check that the Domain and Entity names in Columns A and B match the data of the entity exactly.
- Avoid spaces or special characters in the Alias (Column E); if a space is needed use an underscore "_"
- Descriptions (Column H) are used for clarity and interpretation but do not replace the Alias.
- For data consistency, if the alias of a table being updated through the Excel file already exists in another entity, the original table and its column aliases will take precedence. In such cases, any updates from the Excel file will be ignored.
For example: If "ENTITY_1" is already created and uses the table KNA1 with the alias "CUSTOMER_MASTER_DATA", this table and alias will be used as default in future entities; so, by creating "ENTITY_2" and using the same table (KNA1), this will consider the same alias as the prior entity and if an Excel is uploaded trying to change its aliases, it will be ignored. The only way to make a change uploading excel is to make sure we are updating a table with a "unique" alias.
Entity | Table | Table Alias |
ENTITY_1 | KNA1 | CUSTOMER_MASTER_DATA ORIGINAL |
ENTITY_2 | KNA1 | CUSTOMER_MASTER_DATA
|
By following these instructions, you will successfully configure the fields for your entity using the Excel upload process.