Configure a File System Adapter

Use the File System adapter to collect (import) files from a file system into a business process and extract (export) files from a business process to a file system.

You can configure the File System adapter to start a business process after files are collected from the file system or include the File System adapter in a business process flow. In addition, you can schedule the File System adapter to run at specific time intervals.

You can create multiple File System adapter configurations, one for each of several collection folders. Alternatively, you can use a single File System adapter configuration to point to different directories by specifying the directories for file collection and extraction in a business process. For more information about configuring the File System Adapter, see the File System Adapter documentation.

Configure the File System Adapter to invoke the EBClientOrderPreProcess business process.

To create a File System adapter configuration, specify field settings in Sterling B2B Integrator and in the Graphical Process Modeler (GPM).

The following table describes the fields used to configure the File System adapter in the Sterling B2B Integrator.

Note: The field names in parentheses represent the corresponding field names in the GPM. This information is provided for your reference.
Field Description
Name Required. Unique and meaningful name for the service configuration.
Description Required. Meaningful description for the service configuration, for reference.
Select a group Group to associate with the adapter. Valid values:
  • None: No group is selected.
  • Create New Group: Allows the creation of a new group.
  • Select Group: Select from a list of available groups.
Collection folder (collectionFolder) Required. The name of the folder or subfolder on the same computer where Sterling B2B Integrator is installed and where it collects (or picks up) files as part of a business process. If the path for the folder is not included as part of the name, the folder is assumed to be in the Sterling B2B Integrator working directory.
Note:
  • The deleteAfterCollect parameter in the GPM defaults to Yes. If you do not change the default value to No, files that are collected are deleted from the Collection Folder. The File System adapter does not copy the files it collects for processing. See Graphical Process Modeler Configuration for information about the deleteAfterCollect parameter.
  • The collectionFolder parameter is read-only in the GPM. However, you can override this parameter using Business Process Modeling Language (BPML).
Filename filter (filter) Optional. Collect only files that match a specified filter within the collection folder. Examples include:
  • *.txt (collects only .txt files).
  • *.dat (collects only .dat files).
  • EDI.* (collects only files named EDI with any file extension).
  • EDI.txt (collect only files named EDI with a file extension of .txt).
Note: If there are multiple files in the collection folder and you leave this field blank, one of the following occurs:
  • If the adapter is configured to start a business process, it processes all files placed in the collection folder.
  • If the adapter is within a business process, it collects only the first file in the collection folder.
Note: If you specify this option using the File System adapter configuration, you cannot override the value using the GPM filter parameter. However, you can override this parameter using BPML.
Collect files from subfolders within and including the collection folder? (useSubFolders) Required. Whether to scan for files in subfolders of the collection folder. Valid values:
  • Yes: Collects files in the specified folder and all subfolders.
  • No: Collects files in the specified folder only.
Note: This parameter is read-only in the GPM.
Use the absolute file path name for the document name? (keepPath) Required. Whether to keep the absolute path name of the files collected when assigning the document name. Valid values:
  • Yes: The absolute file path name is kept with the document in the business process. Choose this value if your business process requires the path information to precede the file name.
  • No: Only the file name is kept with the document in the business process.
Note: An absolute path is a path that points to the same location regardless of the working directory or combined paths. It is written in reference to a root directory. For example, c:\dir1\subdir1\somefile.txt (Windows) and /home/dir1/subdir1/somefile.txt (UNIX) are examples of absolute paths to the file somefile.txt.
Note: This parameter is read-only in the GPM.
Start a business process once files are collected? (bootstrap) Required. Whether to start a business process using the File System adapter after files are collected. Valid values:
  • Yes: Starts the business process specified from the business process drop-down list for every file that matches the filtering criteria. An instance of the business process is started for every file that matches the filtering criteria specified for file collection until the number of threads specified on the maxThreads parameter is reached.
  • No: No business process is started. This parameter is read-only in the GPM.
Business Process (initialWorkFlowId) Required when Start a business process is set to Yes. The business process to start after files are collected. Select EBClientOrderPreProcess from the Business Process drop-down list.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify a business process using the configuration, you cannot override this value using the GPM initialWorkFlowId option. If you select Not Applicable, a business process can be selected in the GPM. In either case, you can override this parameter using BPML.
Document storage type (docStorageType) Required. Defines how the document is stored in the system. Valid values:
  • System Default.
  • Database.
  • File System.
Note: This field only displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM DocStorageType option. However, you can override this parameter using BPML.
Obscure File Contents? (obscure) Specifies whether to obscure the file contents when collecting. Does not work with attachFile or importFile.
  • Yes: File contents are obscured.
  • No: File contents are not obscured.
Note: This field only displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM Obscure option. However, you can override this parameter using BPML.
User Parameter 1 (userParm1) A user parameter that is passed to the bootstrapped workflow and placed in process data as UserParm1.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM userParm1 option. However, you can override this parameter using BPML.
User Parameter 2 (userParm2) A user parameter that is passed to the bootstrapped workflow and placed in process data as UserParm2.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM userParm2 option. However, you can override this parameter using BPML.
User Parameter 3 (userParm3) A user parameter that is passed to the bootstrapped workflow and placed in process data as UserParm3.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM userParm3 option. However, you can override this parameter using BPML.
User Parameter 4 (userParm4) A user parameter that is passed to the bootstrapped workflow and placed in process data as UserParm4.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM userParm4 option. However, you can override this parameter using BPML.
User Parameter 5 (userParm5) A user parameter that is passed to the bootstrapped workflow and placed in process data as UserParm5.
Note: This field displays as an option only if Start a business process once files are collected is set to Yes. If you specify this parameter using the configuration, you cannot override this value using the GPM userParm5 option. However, you can override this parameter using BPML.
Run As User Applies to the scheduling of the business process. The Run As User field displays as an option only if Start a business process once files are collected is set to Yes. Type the user ID to associate with the schedule, or click the list icon and select a user ID from the list. Valid value is any authentic Sterling B2B Integrator user ID.
Note: This parameter allows someone who does not have rights to a specific business process to run it. If you select Admin as the user ID, you inherit administrative rights (for this run of the business process only), and can enable the scheduled run.
Use 24 Hour Clock Display If selected, the adapter uses the 24-hour clock instead of the default 12-hour clock.
Schedule Information about scheduling the business process after the File System adapter collects files. The Schedule field displays as an option only if Start a business process once files are collected is set to Yes. Valid values:
  • Do not use schedule.

    If you select this field, the adapter does not start a business process and does not run on a schedule.

  • Run based on timer.

    Valid values are the hour and minutes that specify when to run the adapter. If you choose to select a time interval, the valid values are the hour and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions. Indicate whether you want the adapter to run at startup.

  • Run daily.

    Valid values are the hour and minutes that specify when to run the adapter daily. If you choose to select a time interval, the valid values are the hour and minutes for the interval. Add or delete selections as necessary. Specify any date exclusions. Indicate whether you want the adapter to run at startup.

  • Run based on days of the week.

    Valid values are the day of the week, the hour, and minutes that specify when to run the adapter. If you choose to select a time interval, the valid values are the hour and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.

  • Run based on days of the month.

    Valid values are the day of the month, hour, and minutes that specify when to run the adapter. If you choose to select a time interval, the valid values are the hour and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.
Extraction folder (extractionFolder) Required. The name of the folder or subfolder on the same computer where Sterling B2B Integrator is installed and where it extracts (or writes) data from the primary document as part of a business process. If you do not include the file path for the folder as part of the name, the folder is assumed to be the Sterling B2B Integrator working directory.
Note: This parameter is read-only in the GPM.
Unobscure File Contents? (unobscure) Whether to unobscure the file contents when extracting. Does not work with exportFile. Valid values:
  • Yes: File contents are unobscured.
  • No: File contents are not unobscured.
Note: This parameter is read-only in the GPM.
Filenaming convention (assignFilename) Required. Whether to override the document file name and use the assigned file name or not. Valid values:
  • Use the original file name as the extracted file name: Keeps the names of the files.
Note: If the primary document has no document name, the adapter uses a default filename in the form of nodename_yyyyMMddHHmmssSSS.dat.
  • Assign a specific name: Gives you the option to navigate to a screen and specify a different filename for the file extracted to the file system.
Note: This parameter is read-only in the GPM.
Filename (assignedFilename) Required. File name you want to assign, including the file name extension. The Filename field displays onlyif the Filenaming convention is set to assign a specific name. This field cannot be left blank. You can use “%^” to assign a unique file name in the format nodename_yyyyMMddHHmmssSSS.
For example, specifying %^.dat as the Filename assigns the name nodename_20040203114020982.dat to the file.
Note: This field can also be assigned in the GPM. If you select a filename using the File System adapter configuration, you cannot override it using the GPM assignedFilename parameter. However, you can override it using BPML.
Enable Service for Business Processes Whether to enable the service for use by business processes. If not selected, the service is disabled. For more information about enabling a service, see Managing Services and Adapters.