Skip to Content

SMB Search activity

Introduction

An SMB Search activity, using its SMB connection, returns all files within a folder in an SMB server and is intended to be used as a source to provide data in an operation.

Create an SMB Search activity

An instance of an SMB Search activity is created from an SMB connection using its Search activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing SMB Search activity can be edited from these locations:

Configure an SMB Search activity

Follow these steps to configure an SMB Search activity:

Step 1: Enter a name and specify a folder

In this step, provide a name for the activity and specify a folder. Each user interface element of this step is described below.

The interface used in this step of the configuration of an SMB Search activity depends on the Choose Folder option selected:

Select existent folder

If Select Existent Folder is selected for Choose Folder, this interface is presented:

SMB Search activity configuration step 1 list

  • Name: Enter a name to identify the activity. The name must be unique for each SMB Search activity and must not contain forward slashes / or colons :.

  • Choose Folder: Specify the method for providing the folder path, one of Select Existent Folder or Inform Folder Name Manually:

    • Select Existent Folder: Select to choose from a populated list of folders. To use this option, the domain (specified during connection configuration) must have access to the folders.

    • Inform Folder Name Manually: Select to manually enter the path of the folder.

  • Select a Folder: This section displays folders available in the SMB folder specified in the connection.

    • Selected Folder: After a folder is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of folders. The search is not case-sensitive. If folders are already displayed within the table, the table results are filtered in real time with each keystroke. To reload folders from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh Root Elements: Click the refresh icon Refresh icon or the word Refresh Root Elements to reload folders from the SMB endpoint. This may be useful if folders have been added to the SMB server. This action refreshes all metadata used to build the table of folders displayed in the configuration.

  • Selecting a Folder: Within the table, click the folder name to select the folder. Only one folder can be selected.

    • Refresh: When hovering over a folder name, you can click the refresh icon Refresh icon or the word Refresh to load the sub-folders of that folder. Once any sub-folders are populated, they can be selected for use in the activity.

    Tip

    If the table does not populate with available folders, the SMB connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Return File Content: Select to return the content of the files.

  • Search in Sub-folders: Select to retrieve files in sub-folders.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Inform folder name manually

If Inform Folder Name Manually is selected for Choose Folder, this interface is presented:

SMB Search activity configuration step 1 manual

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to identify the activity. The name must be unique for each SMB Search activity and must not contain forward slashes / or colons :.

  • Choose Folder: Specify the method for providing the folder, one of Select Existent Folder or Inform Folder Name Manually:

    • Select Existent Folder: Select to choose from a populated list of folders.

    • Inform Folder Name Manually: Select to manually enter the path of the folder.

  • Path Address: Enter the path of the folder to be searched. The path must be entered in this format: example-folder-1/example-sub-folder-13.

  • Return File Content: Select to return the content of the files.

  • Search in Sub-folders: Select to retrieve files in sub-folders.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

SMB Search activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The request and response data schemas consist of these nodes and fields:

    Response Schema Node/Field Description
    root Node representing the root
    item Node representing the file
    error_message String containing the error message, if applicable
    response String containing the response
    item Node representing the file returned
    path String containing the path for the file
    name String containing the name for the file
    type String containing the file type
    content String containing the content of the file
    index String containing the index of the dialect used

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the SMB endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an SMB Search activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

SMB Search activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.