Creating, Inserting, and Configuring the File System Adapter

The first step is to insert a so-called adapter into your process to import a sample file. Adapters allow you to integrate applications and data into any Business Process. For more information about the X4 BPMS standard adapters and their features, see X4 BPMS Standard Adapter.

For this example, you need the File System adapter. This adapter stores, reads, deletes, copies, moves, lists files and folders, or attaches files to a target file that  is located in the X4 Server's file system or on connected Windows or Samba network drives. For more information about the File System adapter, see File System.

After you have created and inserted the adapter, you can begin configuring the adapter. We also recommend that you include descriptions of your Technical Process that explain each process step. This way, the individual process steps remain transparent and can also be quickly followed up by new colleagues.

Creating the adapter

1. Right-click on the Technical Process in the Projects view and select New > Adapter….
   The File Creation Wizard dialog opens.

2. In the search field, enter the value File System and select the File System adapter.
   If necessary, you can customize the name of the adapter in the File name field.

   

3. Click Finish.
   ✅ The adapter is created in the ESB Project and opens automatically in the editor. The next step is to configure the inserted adapter further.

4. Return to the Technical Process ImportInvoices.wrf.

Inserting the adapter

1. Drag the Adapter element from the Palette view next to the Start element in the editor.

2. Double-click the Adapter element.
   The Choose Adapter File dialog opens.

3. Select the adapter previously created in the Technical Process.

4. Click OK.

5. Click on the lower right corner of the Start element, hold down the mouse button, and drag a connection to the File_System_Adapter element.

   

Configuring the adapter

1. Click the File System Adapter in the Editor.

2. Select the Read File value from the Operation drop-down list in the Properties view.
   The adapter now reads data from the file specified in the path parameter.

3. Double-click the File System Adapter in the editor.
   The adapter opens on a new tab.

4. Enter the path to the example XML file to be prepared, sampleInvoice.xml, in the field of the path parameter.

   

5. Click Save.

6. Return to the Technical Process ImportInvoices.wrf.

Adding a description

1. Drag the Textbox element from the Palette view below the File System Adapter element into the editor.

2. Double-click the Textbox element.
   The Text Editor opens.

3. Enter the desired description text, e.g.: "This step imports/reads a sample invoice file from the local hard drive. You can set the folder + filename in the adapter.”

4. Click OK.

5. If necessary, adjust the size and position of the text box.