Skip to main content

Create Workbook

UiPath.MicrosoftOffice365.Activities.Excel.CreateWorkbook

Description​

Uses the Microsoft Graph Upload item API to create a new workbook (Name) and upload it to a specified location (Parent).

After the workbook is uploaded, the activity returns a DriveItem object (Workbook) and a URL String (WorkbookURL) that you can use as input variables in subsequent activities.

Scopes​

This activity requires the following scopes:

  • Sites.ReadWrite.All

Project compatibility​

Windows - Legacy | Windows

Configuration​

Properties

Common​

  • DisplayName - The display name of the activity. This property supports String variables and string formatted values.

Input​

  • Conflict Behavior - Indicates the conflict resolution behavior in case a workbook with the same name already exists. Select one of three options: Replace, Fail, Rename. The default value is Replace.
  • Name - The name of the newly created workbook. This property supports String variables and string formatted values.
  • Parent - The DriveItem of the parent directory under which the workbook is created. Use the output property variable from the Find Files and Folders (First or Results). If you're using the Results output property from the Find Files and Folders activity, specify the item in the array that you want to use (e.g., myWorkbooks(0)).

Misc​

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

Output​

  • Workbook - The DriveItem of the newly created workbook. Required if you plan to use the output data in subsequent activities. Enter a DriveItem variable that is different than the one used in the Parent property.
  • Workbook URL - The URL of the newly created workbook. Required if you plan to use the output data in subsequent activities. This property supports String variables and string formatted values.

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 steps.
  2. Add the Microsoft Office 365 Scope activity to your project.
  3. Add an activity or run an external process that outputs a DriveItem object (e.g., Find Files and Folders, Create Workbook, Copy Item).
  4. Add the Create Workbook activity inside the Microsoft Office 365 Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter DriveItem and String variables for the Output properties.
  7. Run the activity.
    • Your input property values are sent to the UploadDriveItem API.
    • The API returns the DriveItem and String values to your output property variables.

docs image