ImportFile
 
Description

Allows you to import the files whose names are listed in the ImportFieldOpApplyTo<N> field. Use ImportFieldOpParam<N> to specify the path to where the listed files are stored.


If Files Contain Identical Fields

If some of the listed files contain fields that have the same name, only the first instance of these fields is imported. Fields that are subsequently imported overwrite any previously imported field of the same name. This also applies to the files' content fields.

You can specify how you want the ImportFile operation to overwrite and delete files by using the following format when you specify the ImportFieldOpParam<N> parameter:


ImportFieldOpParam<N>=<overwrite_behavior>;<deletion_behavior>;<directory_path>


<overwrite_behavior>

Enter one of the following values to specify whether you want content fields to be overwritten:

0; Overwrite the value of the first content field with subsequently imported content fields.
1; Do not overwrite content field values with subsequently imported content fields. Content field values are appended to the existing content field value instead.
2; Do not overwrite any field values with subsequently imported fields. The newly imported field values are appended to the field value, separated with commas.
3; Do not overwrite content field values with subsequently imported content fields. Other field values are overwritten with newly imported values, unless the new field value is empty.


<deletion_behavior>

Enter one of the following values to specify whether you want the original file to be deleted after it has been imported:

0; Do not delete the file you are importing from when importing is complete.
1; Delete the file you are importing from when importing is complete.


<directory_path>

Enter the full path to the location from where the Import Module should import files.



If Filenames Contain Commas

If the names of any of the files that you want the Import Module to import contain commas, you need to use the following format to specify ImportFieldOpParam<N>:


ImportFieldOpParam<N>=<overwrite_behavior>;<deletion_behavior>;<separator>;<directory_path>


<overwrite_behavior>

Enter one of the following values to specify whether you want content fields to be overwritten:

0; Overwrite the value of the first content field with subsequently imported content fields.
1; Do not overwrite content field values with subsequently imported content fields. Content field values are appended to the existing content field value instead.
2; Do not overwrite any field values with subsequently imported fields. The newly imported field values are appended to the field value, separated with commas.
3; Do not overwrite content field values with subsequently imported content fields. Other field values are overwritten with newly imported values, unless the new field value is empty.


<deletion_behavior>

Enter one of the following values to specify whether you want the original file to be deleted after it has been imported:

2; Do not delete the file you are importing from when importing is complete.
3; Delete the file you are importing from when importing is complete.


<separator>

When the Import Module imports files from the specified <directory_path> location, it creates a list of all the files it finds in this location, separating the names of the individual files with commas. If any of the names of the files in the <directory_path> location contain commas, you need to specify an alternative separator for <separator>. The Import Module will then separate the names of the individual files with the specified <separator> rather than commas.


<directory_path>

Enter the full path to the location from where the Import Module should import files.



Example

ImportFieldOpApplyTo0=MyField
ImportFieldOp0=ImportFile
ImportFieldOpParam0=C:\Documents\Files_for_importing\

In this example, the Import Module reads the name of the files that it should import from the MyField field, and imports each one of them from C:\Documents\Files_for_importing\.


ImportFieldOpApplyTo0=MyField
ImportFieldOp0=ImportFile
ImportFieldOpParam0=2;1;C:\Documents\Files_for_importing\

In this example, the Import Module reads the name of the files that it should import from the MyField field, and imports each one of them from C:\Documents\Files_for_importing\.

Field values from prior import processes are not overwritten by subsequently imported values; the new values are appended to the existing imported field values for all fields. When the source file has been imported, it is deleted.


ImportFieldOpApplyTo0=MyField
ImportFieldOp0=ImportFile
ImportFieldOpParam0=2;3;;;C:\Documents\Files_for_importing\

In this example, the Import Module reads the name of the files that it should import from the MyField field, separates them with a semicolon, and imports each one of them from C:\Documents\Files_for_importing\.

Field values from prior import processes are not overwritten by subsequently imported values; the new values are appended to the existing imported field values for all fields. When the source file has been imported, it is deleted.