Salesforce

File Splitter - Methods (Magic xpi 4.13)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

File Splitter – Methods

The following methods are used to configure the File Splitter component:

Unicode file names are currently not supported.

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name

Parameters

Description

Regroup is used to regroup split files into the original larger file. The files must be in a common folder.

Source Directory

Enter the full path and name of the split files being regrouped.

Split File Prefix

If a destination file prefix was not provided when the file was split, you should enter the original file name and extension of the split parts that you want to regroup.

If the prefix was provided when the file was split, you should enter the name of the split parts without the file extension.

Delete Source files

Select Yes or No from the drop-down list to indicate whether to delete the source (previously split) files after they are regrouped into a single file.

Destination Type

Enter the destination type for specifying the regrouped file. Select one of the following from the drop-down list:

  • File

  • BLOB

Destination Content

Defines where the destination content is returned.

Click to open the Variables List. Select the required location variable.

This parameter is available only when you select BLOB (above).

Destination File Name

Enter a name for the new file created by regrouping. This parameter is available only when you select File (above).

Overwrite

Select Yes or No from the drop-down list to indicate whether to overwrite existing target files. This parameter is available only when you select File (above).

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Split by Lines is used to split a large file according to the lines of text in the file. It can split a file into a predetermined number of parts, or it can split the file according to size.

Source Type

This parameter lets you select the source type for the file that you want to split. Select one of the following from the drop-down list:

  • File

  • BLOB

Source File Name

Enter the full path and name of the file being split. This parameter is available only when you select File, above.

Source Content

Defines the contents of the source. This parameter is available only when you select BLOB (above).

Destination Directory

Enter the name of the directory or folder where the split parts are created.

Number of Lines

Enter the maximum number of lines to include in each of the split files.

Destination File Prefix

Enter a prefix for the split file parts.

Overwrite

Select Yes or No from the drop-down list to indicate whether to overwrite existing target files.

Encoding

Indicate whether to encode the split files. Click here for more information on encoding.

Number of Split Files

This parameter receives the number of files that are created in the operation.

Click to open the Variables List. Select a variable where the number of split files are sent.

Return File List

When set with a BLOB variable, this parameter returns a comma-delimited list of the files created as a result of the split operation.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Split by Number is used to split a large file into a user defined number of smaller files.

Source Type

This parameter lets you select the source type for the file that you want to split. Select one of the following from the drop-down list:

  • File

  • BLOB

Source File Name

Enter the full path and name of the file being split.

Source Content

Defines the contents of the source. This parameter is available only when you select BLOB (above).

Destination Directory

Enter the name of the directory or folder where the split parts are created.

Number of Parts

Indicate how many parts that the file is split into.

Destination File Prefix

Enter a prefix for the split file parts.

Overwrite

Select Yes or No from the drop-down list to indicate whether to overwrite existing target files.

Return File List

When set with a BLOB variable, this parameter returns a comma-delimited list of the files created as a result of the split operation.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Split by Size is used to split a large file into smaller files of approximately the same size. The user defines the size of the smaller files.

Source Type

This parameter lets you select the source type for the file that you want to split. Select one of the following from the drop-down list:

  • File

  • BLOB

Source File Name

Enter the full path and name of the file being split.

Source Content

Defines the contents of the source. This parameter is available only when you select BLOB (above).

Destination Directory

Enter the name of the directory or folder where the split parts are created.

Size In Kb

Enter the maximum size (in kb) for each split part.

Destination File Prefix

Enter a prefix for the split file parts.

Overwrite

Select Yes or No from the drop-down list to indicate whether to overwrite existing target files.

Number of Split Files

This parameter receives the number of files that are created in the operation.

Click to open the Variables List. Select a variable where the number of split files are sent.

Return File List

When set with a BLOB variable, this parameter returns a comma-delimited list of the files created as a result of the split operation.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Related Topics

How to Use Direct Access Methods

Reference
Attachment 
Attachment