tBoxv2List Standard properties

Property type

Either Built-in or Repository.

• Built-in: No property data is stored centrally.
• Repository: Select the repository file where properties are stored. The fields that follow are completed automatically using the fetched data.

This drop-down list is not available if you select the Use an existing connection option.

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

Select the authentication type: JWT (short for JSON Web Token) or Developer token.

If you select Developer token from the drop-down list, type in the developer token in the Developer token field. For more information about developer token, see Developer Tokens.

The Authentication type drop-down list is available when Use an existing connection is not selected.

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

Built-In: You create and store the schema locally for this component only.

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion.

  If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

Guess schema

Type in the Box path. The information about the files and the folders under the Box path will be listed.

You can also specify the Box path by clicking the [...] button next to this field and navigating to the folder.

This option is available when the Get folder by ID option in the Advanced settings view is not selected.

Type in the Box ID of the folder whose file information is to be listed.

You can also specify the Box ID by clicking the [...] button next to this field and navigating to the folder.

This option is available when the Get folder by ID option in the Advanced settings view is selected.

Include subfolders

Select this option to also list the information about the objects in the subfolders of the specified Box folder.

tStatCatcher Statistics

Select this check box to collect log data at the component level.

Fetch more information

If this option is not selected, the schema generated after you click the Guess schema button contains these four columns: ID, NAME, RELATIVE_PATH, and TYPE; with this option selected, the schema generated contains these columns: ID, NAME, RELATIVE_PATH, ABSOLUTE_PATH, LAST_MODIFIED, MODIFIED_BY, and SIZE.

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl+Space to access the variable list and choose the variable to use from it.

For more information about variables, see Using contexts and variables.

Usage rule

This component can be used alone or along with other components via the Iterate link or a trigger link such as OnSubjobOk.