Skip to end of metadata
Go to start of metadata


A File Share Write activity writes data to a File Share endpoint and is intended to be used as a target to consume data in an operation or to be called in a script. After configuring a File Share connection, you can configure as many File Share activities as you like for each File Share connection.

Creating a File Share Activity

From the design canvas, open the Connectivity tab of the design component palette:

Use the Show dropdown to filter on Endpoints, and then click the File Share connection block to display activities that are available to be used with a File Share connection:

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a File Share Write Activity

Follow these steps to configure a File Share Write activity:

Step 1: Enter a Name, Provide a Request Schema, and Specify Settings

TIP: Fields with a variable icon support using global variablesproject 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 use to identify the File Share Write activity. The name must be unique for each File Share Write activity and must not contain forward slashes (/) or colons (:).
  • Provide Request Schema: The request schema defines the structure of data that is used by the File Share Write activity. Whether a request schema is required depends on if the activity is used as the target of a transformation (see When to Use a Schema). For instructions on completing this section of activity configuration, refer to Schemas Defined in an Activity.

  • Filename(s): Enter the name of the file(s) that you want to write to within the path(s) specified in the File Share connection. Any of the filename keywords can be used to generate unique filenames (for example, result[date][time].[ext]). If specifying data in ZIP format, see the Compression options described below.
  • Optional Settings: Click to expand additional optional settings:

    • Auto-create Directories: Keep this checkbox selected to automatically create any directories that do not yet exist in the target path.

    • Do Not Create Empty Files: Select this checkbox to skip creating the target file if there is no target data.

    • Write Headers: Select this checkbox if you are using a flat text target and want to write headers (column/field names) to the first line.

    • End-of-line Type: Specify how to write line breaks when writing to a target. Note that end-of-line characters in the data itself are not converted. The options are as follows:

      • Default: Standard end-of-line characters for the platform the agent is running on.

      • Windows: CRLF (ASCII 13 and ASCII 10).

      • Unix: LF (ASCII 10).

    • Character Encoding: Specify character encoding to define a specific character encoding for the target file. If you leave the field blank, Jitterbit Harmony tries to detect the encoding. If you want to overwrite the default, you can choose from any of the encoding types listed in Character Encoding.

    • Compression: If you want the target data to be compressed, select Compress Target Files. These options become available:

      • Format: Use the dropdown to select the compression format. Currently, only ZIP format is supported.

      • File Names in Archive(s): Enter the name of the target file(s) to be compressed within the archive. Any of the filename keywords are available to generate unique filenames. File(s) are automatically written into the archive at the root level.

        TIP: To keep the filename(s) in the archive the same as the filename(s) defined in the target, enter [file].[ext].

      • Mode: By default, the mode Overwrite overwrites the existing archive. This is the only mode available.

      • Password: To encrypt the archive, enter the desired password.

      • Encryption mode: If a password is supplied, use the dropdown to select between the two available encryption modes: AES and Standard ZIP.

  • 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

  • Data Schema: If provided during activity configuration, the request data schema is displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. You can also define schemas directly in a transformation.

  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • 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 a File Share Write activity, you can use it within an operation or script as described below.

Completing the Operation

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

After a File Share Write activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

File Share Write activities can be used as a target with these operation patterns:

Other patterns are not valid using File Share Write activities. See the validation patterns on the Operation Validity page.

This example setup depicts one common operation setup using a File Share Write activity:

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

Using File Share Activities in Scripts

File Share Write activities that have already been configured as part of an operation can also be referenced in a script for use with certain script functions that use a targetId as a parameter. For example:

To add a configured File Share activity to a script to be referenced by one of these functions, drag the configured activity from the Endpoints tab of the script component palette to the script. Or, if you already know the function you want to use, add it from the Functions tab first; then position the cursor after the opening parenthesis of the function and press Control+Space to display a list of autocomplete suggestions. Select an activity to insert the activity reference into the script.

For more details on referencing activities in scripts, see Endpoints on the Jitterbit Script page.

On This Page

Last updated:  Jan 21, 2021

  • No labels