Read Metadata

Operation Name

Read Metadata

Function Overview

This operation reads the metadata of the Box content (file or folder) specified in the input data.

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

https://developer.box.com/reference/get-files-id-metadata-id-id/
https://developer.box.com/reference/get-folders-id-metadata-id-id/

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".
Metadata template name	Required	Available	Select or enter the name of the metadata template applied to the content.
Metadata field list	Required	-	Metadata fields in the metadata template specified in [Metadata template name] are displayed.	Among the metadata fields displayed in [Metadata field list], [Display name] of the metadata fields for which [Read target] is selected will be displayed in the Mapper schema.
Metadata field list/Read target	Optional	Not available	Select whether to include each metadata field of the metadata template specified in [Metadata template name] in read target fields. [Checked]: (default) Include the field in the read targets. [Not checked]: Do not include the field in the read targets.	The display names of the selected metadata fields are displayed in the Mapper schema. By clicking the check box displayed in the header, you can select or clear all items. At least one metadata field must be selected.
Metadata field list/Display name	Required	Not available	The display names of metadata fields are displayed.
Metadata field list/Type	Required	Not available	The types of metadata fields are displayed.	The type is displayed in the "<type> (<internal data type>)" format. Type: Metadata field type used in Box APIs. For more details, refer to "Supported Metadata Field Types". Internal data type: Data type used internally within DataSpider. For more details, refer to "Internal Data Types".

Property Action

Item name	Description	Remarks
Update the list of metadata template names	Retrieve metadata templates from the specified destination, and set them in [Metadata template name].	If [Destination] is changed, you can apply the change by using this property action. Enabled when [Destination] is selected.
Update the list of metadata fields	Retrieve metadata fields from the specified metadata template and display them in [Metadata field list].	If [Metadata template name] is changed, you can apply the change by using this property action. Enabled when [Destination] and [Metadata template name] are selected.

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 login in the input schema. [All]: (default) At the start of processing, retrieves the information for all Box users who exist in the specified [Destination]. [By user]: Retrieves the information for each Box user specified in the input data.	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) Allows you to specify Box content with a path. [ID]: Allows you to specify Box content with an ID.

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

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>login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description	Required/Optional	Remarks
row	-	Repeat for the number of contents from which to read metadata.
column	login	Enter the email address that the user uses to log in.	Required
	box_content_path	Enter the path to the content from which to read metadata.	Required	This item is available only when [Specification method for Box content] is [Path]. For more details on path format, refer to "Limitations". The backslash character (/) cannot be specified.
	box_content_id	Enter the ID of the content from which to read metadata.	Required	This item is available only when [Specification method for Box content] is [ID]. "0" cannot be specified.
	box_content_type	Enter the type of the content (file or folder) from which to read metadata. "file": Files "folder": Folders	Required	This item is available only when [Specification method for Box content] is [ID].

Output Schema

The number of columns and the contents differ depending on the settings for [Metadata field list] and [Specification method for Box content].

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>box_content_path</column>
    <column>box_content_id</column>
    <column>box_content_type</column>
    <column>Metadata field</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	-	Repeated for the number of processed input items.
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.
	login	login of the processed input item is output.
	box_content_path	box_content_path of the processed input item is output.	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.	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.	This item is available only when [Specification method for Box content] is [ID].
	Metadata field	The Metadata fields for which [Read target] is selected are output.	One appears for each of the metadata fields for which [Read target] is selected. If multiple values exist in a metadata field whose [Type] is multiSelect, values concatenated with a "," (comma) separator are set.
	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 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 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 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 the 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

Duplicate names cannot be used for metadata templates or for metadata fields.

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].
InvalidPropertyConfigurationException Required item <property name> is not entered.	[<Property name>] is not entered.	Enter a value in [<property name>].
InvalidPropertyConfigurationException Enter a valid metadata template name in the Metadata template name field.	[Metadata template name] is invalid.	Specify an existing metadata template name in Box for [Metadata template name].
InvalidPropertyConfigurationException The metadata field that is not defined in the metadata template is specified for the read target. Display name: <display name>	The metadata field for which [Read target] is selected is not defined in the metadata template specified for [Metadata template name].	Execute [Update the list of metadata fields] and then select [Read target] again.
InvalidPropertyConfigurationException A read target field is not selected.	No [Read target] in [Metadata field list] is selected.	Select at least one [Read target] in [Metadata field list].