Add Collaboration

Operation name

Add Collaboration

Function overview

Adds the collaboration specified in the input data to Box.

= Remarks =

For details on API specifications used by this component, refer to the Box API reference at the following URL:

https://developer.box.com/reference/post-collaborations/

Data model

The data model of this component is table model type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.
Input data	Required	Not available	Select a component on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Advanced settings

Item name	Required/Optional	Use of variables	Description	Remarks
Retrieval method for user information	Required	Not available	Specify a method to retrieve information for a user specified for content_owner_login in the input schema. All (Default) At the start of processing, the information for all Box users who exist in the specified Destination is retrieved. By user The information for each Box user specified in the input data is retrieved.	When there are many managed users on Box, if you specify All, it takes time to retrieve the user information. As a result, the processing time becomes longer. In this case, if the number of users specified in the input data is small, you can reduce the processing time by selecting By user.
Specification method for Box content	Required	Not available	Select a method to specify Box content. Path (Default) Box content is specified with a path. ID Box content is specified with an ID.
Output successfully processed items to results data	Optional	Not available	Select whether to output successfully processed items to results data in addition to failed items. Selected Successfully processed items are output to results data in addition to failed items. Not selected (Default) Only failed items are output to results data. Successfully processed items aren't output.
Invite only managed users	Optional	Not available	Select whether to restrict the users who can be invited to collaborate to managed users on Box. Selected (Default) You can invite only managed users on Box as collaborators. Not selected You can also invite unmanaged users on Box as collaborators.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

Note

The number of columns and the contents differ depending on the settings for Specification method for Box content.

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>role</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
    <column>can_view_path</column>
    <column>notify</column>
  </row>
  <row>
    : 
  </row>
</table>

Element name	Label	Description	Required/Optional	Remarks
row	-	Repeats for the number of collaborations to add.
column	content_owner_login	Enter the email address that the owner uses to log in.	Required
	box_content_path	Enter the path of the collaboration target.	Required	Note This item is available only when Specification method for Box content is Path. For more details on path format, refer to Limitations of BOX category.
	box_content_id	Enter the content ID of the collaboration target.	Required	Note This item is available only when Specification method for Box content is ID.
	box_content_type	Enter the type of the collaboration target content (file or folder). file File folder Folder	Required	Note This item is available only when Specification method for Box content is ID.
	role	Enter the access level.	Required	Enter one of the following: "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", or "co-owner". If the collaboration target is a file, you can enter "editor" or "viewer".
	accessor_type	Enter the collaborator type.	Required	To enter a user, enter "user", and to enter a group, enter "group".
	accessor_login	Enter the email address of the collaborator.	Required	Enter this when the accessor_type is "user".
	accessor_group	Enter the group name of the collaborator.	Required	Enter this when the accessor_type is "group".
	can_view_path	Enter whether the collaborator will be able to view the contents of the parent folder of the collaboration target.	Optional	If omitted, "false" is set.
	notify	Enter whether to send notifications to the email address of the collaborator.	Optional	If omitted, "true" is set.

Output schema

Note

The number of columns and the contents differ depending on the settings for Specification method for Box content.

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    : 
  </row>
</table>

Element name	Label	Description	Remarks
row	-	Repeats for the number of processed input items.	Note When Output successfully processed items to results data isn't selected, rows are repeated only for the number of input items that failed in the processing.
column	result	When request execution succeeds, "succeeded" is output. When input is invalid, "skipped" is output. When request execution results in an error, "failed" is output.
	content_owner_login	content_owner_login of the processed input item is output.
	box_content_path	box_content_path of the processed input item is output.	Note This item is available only when Specification method for Box content is Path.
	box_content_id	box_content_id of the processed input item is output.	Note This item is available only when Specification method for Box content is ID.
	box_content_type	box_content_type of the processed input item is output.	Note This item is available only when Specification method for Box content is ID.
	accessor_type	accessor_type of the processed input item is output.
	accessor_login	accessor_login of the processed input item is output.
	accessor_group	accessor_group of the processed input item is output.
	status_code	If the result is "failed", an HTTP status code is output from Box.
	error_code	If the result is "failed", an error code that identifies the error contents is output.
	message	If the result is "skipped" or "failed", an error message is output.
	request_id	If the result is "failed", the ID that uniquely distinguishes the request relative to Box is output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
succeeded_count	The number of input items that were processed successfully is stored.	The default value is 0.
failed_count	The number of input items that failed in the processing is stored.	The default value is 0.
skipped_count	The number of input items that were skipped in the processing is stored.	The default value is 0.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Box connector