Official |[Excel] Protect Workbook and Sheet

Operation name

Protect Workbook and Sheet

Function overview

Protects an Excel workbook and its sheets with a write password.

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.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
File	Required	Available	Enter the file path of the Excel workbook. The Browse button launches a file chooser that allows you to select a file.	Specify a file path of Excel workbook with ".xlsx" or ".xlsm" extension. Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Item name

Required/Optional

Use of variables

Description

Remarks

File

Required

Available

Enter the file path of the Excel workbook.

The Browse button launches a file chooser that allows you to select a file.

Specify a file path of Excel workbook with ".xlsx" or ".xlsm" extension.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Workbook protection settings

Item name	Required/Optional	Use of variables	Description	Remarks
Set password to modify	Optional	Not available	Select whether or not to protect the workbook with a write password. Selected Protect the workbook with a write password. Not selected (Default) Don't protect the workbook with a write password.
User name	Required	Available	Enter the user name who protects the workbook.	Enabled when Set password to modify is selected.
Password to modify	Required	Available	Enter the write password that is used to protect the workbook.	Enabled when Set password to modify is selected.

Item name

Required/Optional

Use of variables

Description

Remarks

Set password to modify

Optional

Not available

Select whether or not to protect the workbook with a write password.

Selected

Protect the workbook with a write password.

Not selected

(Default)

Don't protect the workbook with a write password.

User name

Required

Available

Enter the user name who protects the workbook.

Enabled when Set password to modify is selected.

Password to modify

Required

Available

Enter the write password that is used to protect the workbook.

Enabled when Set password to modify is selected.

Sheet protection settings

Item name	Required/Optional	Use of variables	Description	Remarks
Protect contents of worksheet and locked cells	Optional	Not available	Select whether or not to protect the contents of the worksheet and locked cells. Selected Protect the contents of the worksheet and locked cells. Not selected (Default) Don't protect the contents of the worksheet and locked cells.
Sheet name	Required	Available	Select or enter the sheet to be protected in the Excel file specified in File.	Enabled when Protect contents of worksheet and locked cells is selected.
Password to unprotect sheet	Optional	Available	Enter the password to unprotect the sheet.	Enabled when Protect contents of worksheet and locked cells is selected. When omitted, the sheet will be protected without a password.
Operations to allow all users of worksheet	Optional	-	For the worksheet specified in Sheet name, select operations to allow for all users.	Enabled when Protect contents of worksheet and locked cells is selected.
Operations to allow all users of worksheet/Allow	Optional	-	Select operations from the Operation list to allow in the protected sheet. Selected The operation is allowed. Not selected (Default) The operation isn't allowed.
Operation to allow all users of worksheet/Operation	-	-	Operations that you can select whether or not to allow in the protected sheet are displayed. Select locked cells Select unlocked cells Format cells Format columns Format rows Insert columns Insert rows Insert hyperlinks Delete columns Delete rows Sort Use AutoFilter Use PivotTable reports Edit objects Edit scenarios

Transaction

Item name	Required/Optional	Use of variables	Description	Remarks
Execute transaction processing	Optional	Not available	Select whether or not to execute transaction processing. Selected Transaction processing will be executed. Not selected (Default) Transaction processing won't be executed. = Remarks = For details, refer to Transactions for the connectors in the File category.

Item name

Required/Optional

Use of variables

Description

Remarks

Execute transaction processing

Optional

Not available

Select whether or not to execute transaction processing.

Selected

Transaction processing will be executed.

Not selected

(Default)

Transaction processing won't be executed.

= Remarks =

For details, refer to Transactions for the connectors in the File category.

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

None.

Output schema

None.

Transaction

Transaction is supported.

Transaction is enabled only when Execute transaction processing of Transaction is selected.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
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 Excel connector