Help Centre › Building Processes
This article describes the RPA Excel functionality to read a workbook property.
For a full list of available functions, please read EXCEL functions.
Description
The Get workbook property function reads a document property from the workbook and stores it in a variable. Workbook properties are metadata fields embedded in the file, visible in File → Info in Excel.
Available properties
| Property | Description |
|---|---|
| Title | The document title |
| Author | The document author / creator |
| Subject | The document subject |
| Keywords | Tags or keywords associated with the document |
| Comments | General comments or description |
| Category | The document category |
| Company | The company name |
| Manager | The manager’s name |
Setting it up
To use the Get workbook property function, follow these instructions:
{{popups:rpas/add:action=excel-get-property}}
Once on a process map:
- Navigate to the process where you would like to add the function
- Click on the green button’s drop-down
- Click on “+ Activity”
- Select the EXCEL Get workbook property option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Property | Yes | Select | Title | The workbook property to read |
| Variable | Yes | Text | - | Name of the variable to store the property value |
Output variables
| Variable | Type | Description |
|---|---|---|
| Variable | String | The property value, or empty string if not set |
Tips
- Use this to read metadata before processing – e.g. check the author to determine the source system
- Properties may be empty if they were never set on the workbook