SMB Update Folder activity

Introduction

An SMB Update Folder activity, using its SMB connection, updates folders in an SMB server and is intended to be used as a target to consume data in an operation.

Create an SMB Update Folder activity

An instance of an SMB Update Folder activity is created from an SMB connection using its Update Folder 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 Update Folder activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure an SMB Update Folder activity

Follow these steps to configure an SMB Update Folder activity:

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify settings.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

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

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

• Select existent folder: This option will populate a list of existing folders to choose from. To use this option, the domain (specified during connection configuration) must have access to the folders.

• Inform folder name manually: For this option, you will manually enter the folder path.

Select existent folder

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

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

• Operation Type: Select an operation type from the menu, either Define with Schema, Move Folder, or Rename Folder:

  • Define with Schema: When selected, the operation type is provided in the request schema.

  • Move Folder: Moves folder to another location.

  • Rename Folder: Renames the folder.

• 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 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 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.

• 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:

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

• Operation Type: Select an operation type from the menu, either Define with Schema, Move Folder, or Rename Folder:

  • Define with Schema: When selected, the operation type is provided in the request schema.

  • Move Folder: Moves folder to another location.

  • Rename Folder: Renames the folder.

• 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.

• 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.

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

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

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

  Request Schema Node/Field	Description
  root	Node representing the root
  item	Node representing the folder to be updated
  newName	String containing the renamed folder name
  name	String containing the name of the folder being updated
  destinationFolderPath	String containing the destination folder path
  operation	String containing the operation type, either Move, Rename or Update File

  Response Schema Node/Field	Description
  root	Node representing the root
  item	Node representing the folder
  error_message	String containing the error message, if applicable
  response	String containing the response
  index	String containing the index of the dialect used

• Refresh: Click the 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 Update Folder 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 Update Folder activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.