Update Folders activity

This activity updates the folders details at Box.com.

Adding the Update Folders activity in the orchestration

To add the Update Folders activity in the orchestration, perform the following steps:

  1. Create or open an orchestration. A graphical representation of the orchestration is displayed.
  2. Select the Activities tab and expand the Box.com folder.
  3. Drag the Box.com Update Folders activity into the orchestration.
  4. Select the Update Folders activity in the orchestration. The Checklist is displayed for Update Folders activity.

Creating, selecting, or editing an Box.com endpoint

To create, select, or edit a Box.com endpoint, perform the following steps:

  1. Click Pick Endpoint task from the Checklist and select one of the following actions:
    • Select an existing endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK. Go to the #configact procedure.
    • Select an existing endpoint and edit the endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK.
      3. Click Edit. The Edit Endpoint pane is displayed.
    • Create a new endpoint:
      1. Select New. The Create Endpoint pane is displayed.
      2. Create or edit a Box.com endpoint. See Creating or editing an endpoint for Box.com activity.

Configuring the activity

Additional configuration is not required for this activity.

Mapping the inputs of the activity

To map the inputs of the activity, perform the following step:

  1. Click the Map Inputs link in the Configure Activity section displayed under the orchestration.

    Mandatory fields: The activity has following mandatory fields:

    Name Type Required Description
    folderId String Yes This is used to specify the ID of the folder to be update at Box.com.
  2. The activity has following optional fields:
    Name Type Required Description
    name String No This is used to specify a new name of the folder.
    description String No This is used to specify the description of the folder.
    Parent String No The parent object having parent folder details.
    id String No This is used to specify the ID of the parent folder.
    shared_link Object No An object representing this item’s shared link and associated permissions.
    is_password_enabled Boolean No This is used to set the password for shared link. By default, the value of this flag is false.
    access String No The level of access required for this shared link. Can be open, company, collaborators, or null to get default share level.
    permissions Object No The permissions object.
    can_download Boolean No This is used to set whether the shared link should allow download.
    can_upload Boolean No This is used to set whether the shared link should allow upload.
    can_rename Boolean No This is used to set whether the shared link should allow renaming of folder.
    can_delete Boolean No This is used to set whether the shared link should allow should allow deletion of folder.
    can_share Boolean No This is used to set whether by using shared link the accessed folder could be shared again.
    can_invite_collaborator Boolean No This is used to set whether collaborators can be invited using the shared link.
    can_set_share_access Boolean No This is used to set whether share access can be added using the shared link.
    folder_upload_email String No This is used to specify the email-to-upload address for this folder.
    access String No This is used to specify the level of access for folder. Following value can be set as open or collaborators to set level of access.
    sync_state String No This is used to set whether Box Sync clients synchronize this folder.
    tags Object No The tags object to include array of string.
    element String No This is array of string used to specify tags associated with the folder.
  3. Create a map between the orchestration variable or variables and the input parameter or parameters.

Mapping the outputs of the activity

Create a map between the Box.com output parameters and the orchestration variables. The expected response is generated on a successful mapping.

Note: About deploying a Box.com orchestration

The project for Box.com connector is deployed on the Integration appliance. After the successful deployment, the orchestration containing Box.com activities is executed.




Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/Box_com_update_folders_activity.html