Add New Event Service Screen > File Dropping Screen

Starts a process when a file of a specified type is added to a folder.

Figure: Add New Event Service > File Dropping screen

Add New Event Service File Dropping screen

Examples

Good to Know

  • This feature is not available for AgilePoint OnDemand.
  • The Event Service AgileConnector must be added via the AgilePoint Server Configuration utility before using the Event Service.

How to Start

  1. In the Manage Center, click System System icon > Events Service.
  2. On the Events Service screen, click Add Event Service Add Event Service icon
  3. On the Add New Event Service Screen > Select Type of Event Service, select File Dropping.
  4. Click Next.
  5. On the Add New Event Service screen, complete the fields ​as necessary.
  6. Click Next.

Fields

Field Name Definition

Folder
Function:
Specifies the absolute path of a folder the event service monitors for a file upload. When the file is uploaded, the event service starts a process instance.
Accepted Values:
The absolute path of a folder on the AgilePoint Server machine.
Default Value:
None
Example:
C:\Event Service\File Drop

Refer to:

File Type
Function:
Specifies the type of file for the event service to monitor for upload in the folder.

This setting can help you put limits on which types of files start a process instance.

Accepted Values:
The type of your file.

All file types are supported.

If you enter more than one value, separate the values with semicolons (;).

Default Value:
*.*

Monitor Sub Folders
Function:
Monitors the subfolders to trigger a process when a file goes in.
Accepted Values:
  • Selected - Monitors the subfolders.
  • Deselected - Does not monitor the subfolders.
Default Value:
Deselected

Move To Folder
Function:
Specifies the absolute path of a target folder where the file moves after the event service starts a process instance.

The source folder is the folder you specified in the Folder field.

Accepted Values:
  • Selected - Moves your file to the specified folder.
  • Deselected - Does not move your file to the specified folder.
Default Value:
Deselected
Example:
C:\Event Service\Destination Folder

Refer to:

Delete File After Processed
Function:
Deletes the file from a folder you specified in the Folder field after the process instance starts.
Accepted Values:
  • Selected - Deletes the file from the folder after it is processed.
  • Deselected - Does not delete the file after it is processed.
Default Value:
Deselected

Folder Path
Function:
Specifies a variable that stores the folder path you specified in Folder field. This variable name is entered as plain text or Xpath.
Accepted Values:
  • A string that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • Folder Path - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:FolderPath - An example of an Xpath in the process schema

File Name
Function:
Specifies a variable that stores the name of the file that was uploaded in the folder configured for the file dropping event service. This variable name is entered as plain text or Xpath.
Accepted Values:
  • A string that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • File Name - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:FileName - An example of an Xpath in the process schema

File Attribute Binding - File Type
Function:
Specifies a variable that stores the extension of files that are uploaded to the monitored folder. This variable name is entered as plain text or Xpath.
Accepted Values:
  • A string that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • File Type - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:FileName - An example of an Xpath in the process schema

File Size
Function:
Specifies a variable that stores the size of the uploaded file, in MB. This variable name is entered as plain text or Xpath.
Accepted Values:
  • A string that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • File Size - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:FileSize - An example of an Xpath in the process schema

File Created Date
Function:
Specifies a variable that stores the date and time the file is uploaded in the folder. This variable name is entered as plain text or Xpath.
Accepted Values:
  • A string that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • File Created Date - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:FileCreatedDate - An example of an Xpath in the process schema

Enable File Dropping Event
Function:
Specifies if the file dropping trigger is active
Accepted Values:
  • Selected - The file dropping trigger is active.
  • Deselected - The file dropping trigger is not active.
Default Value:
Deselected