Importing Data, Documents, and Attachments inEffivity
EFFIVITY
User Guide
ABSTRACT
This guide explains how to import historical records, documents, and supporting attachments into Effivity using Excel templates. It uses the Document screen as an example, but the same approach can be followed in any module or screen where import options are available.
NOTE: The options visible to each user depend on the access permissions and module configuration provided by the administrator. As a first step, please reach Effivity support for enabling Import function for your account.
Introduction
Effivity allows users and administrators to import existing business records into the system using structured Excel templates. This is useful when migrating historical records, creating multiple records in bulk, or importing supporting files along with record data.
Import historical records using Excel templates instead of manually creating each record.
Import supporting files such as Word documents, PDF files, Excel files, text files, and images.
Reduce manual entry effort and improve consistency during data migration.
Use validation emails to confirm whether the import was completed successfully.
NOTE: The Document screen is used in this guide only as an example. The same steps apply to other modules and screens where data import and file import options are enabled.
Prerequisites
You must have permission to access the required module.
You must have access to Admin > Process and the process’s Sandbox configuration if you are configuring import settings.
A Unique Key Combination must be configured before importing records.
The import template must be downloaded from the same module where the data will be imported.
Supporting file names must match the names entered in the Excel import template.
Section 1: Configuring Import Settings
Before performing an import, administrators must configure the Unique Key Combination. This setting tells Effivity which field should be used to identify each record during import. It also helps the system decide whether a record should be created or updated.
1. Open Admin > Process and choose Switch to Sandbox. Confirm the SANDBOX banner.
2. Find Documents, open its row action menu and choose Edit.
3. Expand Process Configuration in the artifacts editor.
4. Select Import Settings.
5. In the Import Settings page, configure the Unique Key Combination.
6. Select the field or field combination that uniquely identifies each imported record. The observed Documents configuration uses Document Name. The original example used Document Number; follow the configuration for your process.
7. Review the unique key and any configured scripts, then click Save. Reopen the settings to confirm they persisted. Do not change scripts unless the administrator intends to change the import behavior.

Figure 1: Documents process row menu in Sandbox with Edit selected

Figure 2: Documents Import Settings with Document Name as the unique key
IMPORTANT: Configuring the Unique Key Combination is mandatory for import. The selected field should uniquely identify each record. Duplicate values may cause import failures or unexpected record updates.
Section 2: Configuring the Import Template
The Excel import template is generated based on the fields selected in Index Views. If a field is not selected in the view configuration, it may not appear in the downloaded import template.
1. In the Documents Sandbox artifacts editor, expand Process Configuration.
2. Click Index Views.
3. Locate the view that will be used for importing records.
4. Expand the required view using the chevron beside its name.
5. In the field selection area, select all fields that should be available in the import template.
6. If documents or attachments need to be imported, ensure that the related File Upload component field is also selected.
7. Scroll down and click Save. Reopen the view to confirm the selections, choose Start Testing and inspect the configured view. Publish the process through the loaded Publish wizard, return to Main and verify the resulting view before importing records there.

Figure 3: Documents Default Index View under Sandbox Process Configuration

Figure 4: Selected fields for the Documents import template; select the Files component further down the field list when importing attachments

Figure 5: Index Views Save and Sandbox testing and publication controls
TIP: Select only the fields that are required for data import and review. Selecting the correct File Upload field is important when documents or attachments need to be imported with records.
Section 3: Downloading the Import Template
1. Navigate back to the required module screen.
2. Open the action menu beside Add New in the selected view.
3. Select Download Import Template.
4. The system downloads an Excel template.
5. Open the downloaded template and review the columns.

Figure 6: Download Import Template in the Main Documents action menu
The template should reflect the selected view. In the original Documents example, row 1 contained labels and row 2 contained field keys. Preserve these rows and use the current downloaded template without renaming its columns.

Figure 7: Retained Excel template example showing field labels and keys; use a fresh template from the current selected view
Section 4: Preparing the Import Template
1. Open the downloaded Excel template.
2. Enter record details below the template’s header rows. The retained Excel example uses four ISMS documents across Service, IT and Maintenance. It illustrates Department, Document Number, Document Type, Management System Type, Document Name, Revision Number and Files; use the columns and lookup values in your current downloaded template.
3. Fill every mandatory column in the current template and use values available in the account’s lookup lists. The sample values must match those lists.
4. Enter unique values in the configured Unique Key field. Here the key is Document Name. Follow the current template’s requirements for Document Number and other mandatory columns; do not assume a number will be generated when the relevant import script is not configured.
5. If files need to be imported, enter the exact file name in the File Upload column with its extension.
6. Save the completed Excel file before uploading it into Effivity.
IMPORTANT: The file names entered in Excel must exactly match the actual files being uploaded, including the file extension. For example, a file entered as Policy.docx in Excel should be uploaded with the same name.

Figure 8: Retained completed Excel example with four document records and exact attachment filenames
Section 5: Importing Data and Supporting Files
After the import template is prepared, it can be uploaded into the required module. If the Excel file references supporting documents or attachments, those files must also be uploaded during the same import process.
1. Navigate to the required module screen.
2. Click the hamburger menu beside the Add New button.
3. Select Import from excel.
4. In Input File, choose the completed Excel template. When the template references attachments, the dialog indicates how many supporting files are expected.
5. Open Supporting Files and choose every file named in the Excel template. The displayed workflow instructs you to upload the supporting files before uploading the Excel input.
6. Click Upload all in Supporting Files, or the upload control provided for the selected files. Wait for the successful upload status.
7. Return to Input File and click Upload for the Excel template. Confirm Successfully uploaded. File selection and Pending upload do not mean the file has been uploaded.
8. Confirm that every required supporting file is uploaded and that the Excel input is successfully uploaded. Then click Import to start processing.

Figure 9: Import from excel in the Main Documents action menu

Figure 10: Excel input showing Successfully uploaded

Figure 11: Supporting Files tab and the displayed attachment-first upload instructions
TIP: The illustrated input is successfully uploaded, but the counter is still 0 of 4 Supporting Files selected. Complete the supporting-file upload before clicking Import; Excel upload success does not confirm attachment upload or import completion.
Section 6: Import Result and Validation
After the import is submitted, Effivity validates the uploaded data and supporting files. Based on the configured Unique Key, the system creates new records or updates matching records.
Effivity checks the uploaded Excel data for required fields and valid values.
Effivity checks whether the Unique Key values are valid and not duplicated.
Effivity checks whether supporting files are uploaded correctly.
When the account sends an Import Result email, review it along with the actual imported records.

Figure 12: Import control after Excel upload; the 0 of 4 counter indicates supporting files are still required

Figure 13: Main Documents list used to locate and verify imported records after processing

Figure 14: Retained Import Result email example showing row counts and final status
NOTE: Figure 14 is a retained example of an Import Result email, not the result of the illustrated upload. Review the actual result for your import and reopen the saved records and attachments to confirm success.
Section 7: Importing Word Documents, PDF Files, and Images
Supporting documents and images can be imported with record data when the process contains a File Upload component. Enter exact filenames in the template, then upload the matching files in Supporting Files. The displayed dialog allows multiple files for a record separated by a semicolon, limits the batch to 100 supporting files, and requires every referenced file without unrelated extra files or duplicate names from different paths.
Supported Document Types
Microsoft Word files: .doc and .docx
PDF files: .pdf
Microsoft Excel files: .xls and .xlsx
Text files: .txt
Supported Image Types
JPG files: .jpg
JPEG files: .jpeg
PNG files: .png
GIF files: .gif
NOTE: Supported formats may vary based on your Effivity configuration. Contact Effivity Support if a required file type is not accepted.

Figure 15: Import dialog validation rules and Supporting Files control for document and attachment uploads
Summary
To import data, documents, and attachments in Effivity,
- First configure the Unique Key Combination.
- Configure the required fields in Index Views.
- Download the import template.
- Prepare the Excel file.
- Upload the Excel template and supporting files.
- Review the import result and any Import Result email, then verify the saved record and attachment.
This process helps teams migrate historical records and supporting documents efficiently while keeping data structured and traceable.
BEST PRACTICE: Always test the import process with a small set of records before importing a large historical data set.