Add Collaboration

Operation Name

Add Collaboration

Function Overview

Add the collaboration specified in the input data to Box.

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

Data model of this type of component is table model type.

Properties

For details on using variables, refer to "Variables".

Basic Settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name 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 Global Resources. For details on global resource settings, refer to "Global resource properties". [Add]: Add a new global resource. [Edit list]: Allows you to edit the global resource settings in "Edit resource list".

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be applied to the specifications.

Schema

Input Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>content_owner_login</column>
    <column>box_content_path</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	-	Repeat the addition of collaborations for each row.
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	For more details on path format, refer to "Limitations".
	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, it can be entered by an "editor" or a "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	Defaults to "true" if omitted.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>content_owner_login</column>
    <column>box_content_path</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
row	-	Repeat the input process the number of times that input failed in the processing.
column	result	When a request does not execute due to a validation error, "skipped" is output, and when a request that is executed results in an error, "failed" is output.
	content_owner_login	Output content_owner_login for input that failed in the processing.
	box_content_path	Output box_content_path for input that failed in the processing.
	accessor_type	Output accessor_type for input that failed in the processing.
	accessor_login	Output accessor_login for input that failed in the processing.
	accessor_group	Output accessor_group for input that failed in the processing.
	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	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 on Mapper

The schema is loaded automatically.

For details, refer to "Edit schema".

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
succeeded_count	The number of times that input was successful in the processing is stored.	The default value is "0".
failed_count	The number of times that input failed in the processing is stored.	The default value is "0".
skipped_count	The number of times that input that was 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 occurred error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the occurred error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the occurred error is stored.	The default value is null.
error_type	When an error occurs, the type of an occurred error is stored.	The default value is null. The error type will be in the following format. Example: "java.io.FileNotFoundException" The contents to be stored may vary depending on the version of DataSpider Servista.
error_message	When an error occurs, the message of the occurred error is stored.	The default value is null. The contents to be stored may vary depending on the version of DataSpider Servista.
error_trace	When an error occurs, the trace information of the occurred error is stored.	The default value is null. The contents that will be stored may vary depending on the version and client applications of DataSpider Servista.

Specification Limits

The processing of input data is executed one line at a time. Therefore, even if an error occurs during processing, the data which have been deleted are applied.

If an error occurs during processing, some of the input data and the error details are output in the results data, and then processing continues.

Major Exceptions

Exception Name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name:[]	[Destination] is not specified.	Specify a value for [Destination].
ResourceNotFoundException Resource definition is not found. Name:[<Name of global resources>]	Resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].