Skip to main content
Mitratech Success Center

Options Tab

No page summary available

image

Leave e-Mails on server after download

You can store a history of all previous emails in a specific file on your server.

Strip All Attachments

You have the option to remove all attachments from your imported emails, or to only import attachments up to a certain size

Overwrite existing files on server

You can choose to have old files be overwritten by new ones.

Scheduling File Imports (Smart Folders)

You may want to automatically schedule the import allowing for Smart Folders. This allows users to drop documents in a folder on a file system and have it automatically imported in to Process Director with the same folder structure used on the file system. This can automatically start a workflow for each new document added. To facilitate this you will schedule the non-interactive import command using the command line options. The import GUI has a button called “Save Parameters” which is used to save all of the current settings in the dialog into popup dialog for copying to the clipboard or save as a batch file. The command line options will specify the fields documented above. Here is the list of command line options available, and the mappings to the dialog fields:

Properties

Parameter Name

Description

Alternate Name

--directory PATH

Import files from PATH

-d

--delay NUMBER

Delay each import by NUMBER milliseconds

 

--delete

Delete files after successful import

 

--folder PATH

Import files into Process Director folder at PATH

-f

--filter FILTER

Limit import to only files of types in FILTER (comma-separated extensions)

 

--partition NAME

Import into partition NAME

-i

--maxnum NUMBER

Limit the number of files to import to NUMBER

-m

--metadata

Include metadata with import files (in corresponding XML files)

 

--no-gui

Run in non-interactive mode (required for scheduling)

-n

--overwrite

Overwrite files on import with the same name already in Process Director

 

--password PASSWORD

Connect to Process Director as user with password PASSWORD

-p

--user USERNAME

Connect to Process Director as USER

-u

--webserviceurl URL

Connect to Process Director at URL

-w

Running in non-interactive mode requires the following arguments:

-n, --webserviceurl, --partition, --user, --password, --directory

Example

To run the import utility and delete files after a successful import:

bpImport.exe -w "http://hostname/" -u "user1" -p "" -i "Test Partition" - d "C:\Windows\Temp" -n –delete

To run the import utility with Meta Data and a 50ms delay after every import:

bpImport.exe -n -w "http://hostname/" -u "user1" -p "" -i "Partition" -d "C:\Windows\Temp" --metadata --delay 50

When running the import utility non-interactive from a command line or scheduler, any errors will be written to a file named bpU.log in the Logs directory where the bpImport.exe exists.

Using the Microsoft Windows Scheduler

To schedule the Process Director task (e.g. an import task) using the Microsoft Windows Scheduled Tasks utility, open the Windows StartAll ProgramsAccessoriesSystem ToolsScheduled Tasks menu item. This will display the Windows Scheduler. Click on the “Add a Scheduled Task” item and browse for the application to run. Go to the Process Director install directory and choose the program (e.g. bpImport.exe). Then continue with the scheduler indicating that it should run every day. When prompted for user credentials, ensure you enter a user that will not have the password change occur too often, because any change to this password will prevent the scheduled task from running. You can optionally create a new user account to run this task under (ensure the account you choose has the appropriate permissions by logging in as that user and running the bpImport.exe).

Once the task has been created, open the advanced properties of the item to configure the task. Change the Run input box to include the appropriate parameters to the command.

"c:\Program Files\BP Logix\Process Director\bpImport.exe" –w "http://localhost" –u "user1" –d "m:\My Docs" --delete

The following dialog is displayed when the properties of the task are viewed. This is also where the Windows user account that this task is run as can be changed.

image

The scheduling wizard only allows the task to be scheduled once a day. To run this import command more often, click on the Schedule tab and then click on the Advanced button to reconfigure the schedule. In the advanced settings, click on the Repeat task check box, this will repeat the task at the interval you define. For example to run this command every 5 minutes all day, set the repeat task interval to every 5 minutes and set it to run for a duration of 24 hours. Consult the Microsoft help for more information on this utility.

image

Note: When running the Process Director import utilities from the Windows scheduler, any errors will be written to a file named bpU.log in same the directory where the bpImport.exe exists.

Optional Meta Data XML Files

The import utility can include Meta Data with each of the files being uploaded to Process Director. This Meta Data can set the categories and attributes for the document on the server. This occurs if the option is selected to allow associated Meta Data files on the import dialog. If this option is selected the import utility will attempt to find matching file names with “.XML” appended to the name. For example, if the import utility finds a file named mydoc.pdf, it will attempt to locate the mydoc.pdf.xml file for the Meta Data. The Meta Data XML file must be of a certain format to be recognized as valid Meta Data. The XML file must contain the following structure and tags.

<META_DATA>
<INPUT_META_DATA>
<META_NAME>external_attribute_name</META_NAME>
<META_VALUE>attribute_value</META_VALUE>
</INPUT_META_DATA>
<INPUT_META_DATA>
<META_NAME>external_attribute_name_2</META_NAME>
<META_VALUE>attribute value 2</META_VALUE>
</INPUT_META_DATA>
</META_DATA>

The <META_NAME> must match an External Name in a category attribute for the document to be assigned to that category. If a matching External Name is not found in the category tree the Meta Data is discarded after the upload completes.

For example, assume you have a category named Operations that contains a subcategory named Quality with an attribute name of ActionManager. You can assign this entire category tree (i.e. Operations.Quality) to the imported document by using a matching External Name in the ActionManager attribute. If the external name in the ActionManager attribute is set to “manager_name”, the XML for the imported document would look as follows:

<META_DATA>
<INPUT_META_DATA>
<META_NAME>manager_name</META_NAME>
<META_VALUE>John Smith</META_VALUE>
</INPUT_META_DATA>
</META_DATA>

To set values for checkboxes, the values YES and NO correspond to a checked state and an unchecked state, respectively.

Date values vary based on locale: if you’re in the USA, use mm/dd/yyyy. If you’re elsewhere, use dd/mm/yyyy.

  • Was this article helpful?