Skip to main content

Commit Session

UiPath.Box.Activities.File.ChunkedUpload.CommitSession

The Commit Session activity uses the Box Commit Upload Session API to close an upload session (Upload Session) and create a file from the uploaded chunks.

After committing the session, the activity outputs a BoxFile object (BoxFile) that includes the properties of the copied file, including the BoxFile.Id that you can use to identify the file in subsequent activities (e.g., Move File, Lock File, etc.).

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Box Scope activity to your project.
  3. Add an activity or run an external process that outputs a BoxUploadSession value (e.g., Create Upload Session).
  4. Add the Commit Session activity inside the Box Scope activity.
  5. Enter values for the Input property.
  6. Create and enter a BoxFile variable for the Output property.

    • Your input property values are sent in the Commit Upload Session API operation request.

    • The operation returns the BoxFile value to your output property variable.

      docs image

Properties​

Common​

  • ContinueOnError - Specifies if you want the activity to continue running when an error is thrown. This field supports only Boolean values.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • Upload Session - The upload session object. This field supports only BoxUploadSession variables.
    • To get the BoxUploadSession value, add an activity or run an external process that outputs a BoxUloadSession object (e.g., Create Upload Session).

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • Box File - The BoxFile object that includes the file properties. Enter a BoxFile variable.
    • The BoxFile object includes multiple properties that you can use in other activities.