OpenDocument Spreadsheet - Encrypt
Declaration
<AMODS ACTIVITY="encrypt" SESSION="text" CONNECTBY="create_workbook" WORKBOOK="text" WORKBOOKTEMPLATE="text" TEMPLATEPASSWORD="text (encrypted)" OVERWRITE="YES/NO" OPENPASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" OLDOFFICE="YES/NO" ENCRYPTIONTYPE="text (options)" KEYLENGTH="Number" ENCRYPTIONPASSWORD="text (encrypted)" />
Description
Encrypts and password protects an Excel workbook in order to protect its data from being read or manipulated. This activity can be executed individually or with a group of other OpenDocument Spreadsheet activities linked to an established session.
NOTE: Unlike Automate Desktop's Excel activities,
the OpenDocument Spreadsheet activities do not require Microsoft's
Excel engine to run. Supported file types include Excel (*.xls, *.xlsx,
*.xlsb, *.xlsm ), Open document spreadsheet (*.ods) and CSV (Comma
Separated Value) files (*.csv).
Practical usage
Used to automate the process of encrypting an Excel document.
Parameters
Resource
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Resource | --- | --- | --- | --- | Indicates where the source
workbook document should originate from. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Resource - File
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Get document by | Text (options) | Yes, if Resource is set to File | Open |
|
Specifies
whether to perform this activity on an existing document
or a new one. This parameter is only active if the Resource parameter is set to File. The available options
are:
|
File name | Text | Yes | (Empty) | WORKBOOK="C:\Temp\fileName.xls" | If Get document by is set to Open, specifies the path and file name of the document to open. If Get document by is set to Create, specifies the path and file name in which to save the newly created document. |
Password to open (optional) | Text | No | (Empty) | OPENPASSWORD="encrypted" | The password required to open the document if it is password protected. This parameter is only active if Get document by is set to Open, or if Get document by is set to Create and Create from template is selected. |
On completion | Text (options) | No | Save |
|
Specifies
what to do with the document upon completion of this activity.
The available options are:
|
File | Text | No | (Empty) | DESTINATION="c:\temp\dest.xls" | The path and file name of the file in which changes will be saved. Click the folder icon to open a standard Explorer dialog in order to navigate to the desired file or simply enter the path and file name in the provided text box. This parameter is only active if On completion is set to Save as. |
Overwrite if workbook already exists | Yes/No | No | No | OVERWRITE="YES" | If selected, the saved workbook will overwrite any workbook with the same name that exists in the destination. If disabled (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching file names. This parameter is only active if On completion is set to Save as, and/or if Get document by is set to Create. |
Create from template | Text | No | No | WORKBOOKTEMPLATE="C:\Temp\file.xls" | If enabled, specifies the path and file name of a template file that already has preferred formatting in which to base the new workbook on. A template can include formatting, styles, standardized text such as page headers and row and column labels. This parameter is active only if Get document by parameter is set to Create. This parameter is disabled by default. |
Overwrite if workbook already exists | Yes/No | No | No | OVERWRITEDESTINATION="YES" | If selected, the saved workbook will overwrite any workbook with the same name that exists in the destination. If disabled (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching file names. This parameter is only active if Get document by is set to Create. |
Resource - Session
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Session | Text | Yes, if Resource is set to Session | OPENDOCSession1 | SESSION="mySession" | The name of an existing session to associate this activity with. The default session name is OPENDOCSession1. This parameter is active only if Resource is set to Session. |
Security
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Password | Text | Yes | (Empty) | ENCRYPTIONPASSWORD="text" | Specifies the password to enter in order to decrypt the encrypted Excel document. |
Microsoft Excel 2007 or older | Yes/No | No | No | OLDOFFICE="YES" | If selected, specifies that the Excel document's encryption algorithm should be compatible with the type of encryptions used in Microsoft Excel 2007 or older. If disabled, encryption will be automatically set to Microsoft Strong Cryptographic Provider, the strongest provided encryption which uses a minimum key length of 128 bits. |
Encryption type | Text (options) | Yes | (Empty) |
|
The encryption
type to use. This parameter is active only if the Microsoft
Excel 2007 or older parameter is selected. The available
options are:
|
Key length | Number | Yes | (Empty) | KEYLENGTH="12" | The total number of characters that the encryption key should contain. This parameter is active only if the Microsoft Excel 2007 or older parameter is selected. |
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This is a simple batch encryption task. It loops through a directory, detects all the .xls files and encrypts/password protects each one of them.
Copy
<AMVARIABLE NAME="theFile" VALUE="" />
<AMLOOP ACTIVITY="folder" FOLDER="C:\temp\*.xls" RESULTVARIABLE="theFile"><AMODS ACTIVITY="decrypt" WORKBOOK="%theFile%" OPENPASSWORD="AM4kocrqyldOrPuJVD4GamYy/7bYjPFQ9ylaME" /></AMLOOP>
<AMODS ACTIVITY="encrypt" WORKBOOK="%theFile%" ENCRYPTIONPASSWORD="AM4hIYooNK35+qtO3vOgJxAyuC7mxQRewUTaME" />
<AMLOOP ACTIVITY="end" />