Business Object Definition
The information contained in this document is the proprietary information of Blue Prism Limited and should not be disclosed to a third party without the written consent of an authorised Blue Prism representative.
(c) Blue Prism Limited
About this document...
The Business Object Definition describes the APIs available within a single business object, their parameters and their behaviours from both a business and technical perspective. The definition of each object function describes the business function of the interface, the parameters and usage of the business function and any technical notes required in the on-going support of the interface, including reference to the capabilities of the object. The Business Object Definition API is a dual-purpose document designed to serve the needs of both business users and technical system support staff who require information relating to the business functions available and their details. As such, the BOD is a working document and is subject to change during the course of development and implementation.
About Business Objects
Business Objects within the environment (i.e. objects which may be drawn onto a process to capture and replicate a part of a business process) adhere to strict guidelines in their implementation. The definition and behaviour of the object both as seen in Process Studio during design time and as implemented during test or via Control Room at runtime uses the same interface definition, known as an object's capabilities. All business objects used within Blue Prism, generic and bespoke, have a common property - Get Capabilities. The GetCapabilities function returns an XML formatted string which defines the interfaces for that object, their friendly names (as they appear in Process Studio) and any inputs and outputs that are required. The Business Object Definition object captures the name, parameters, preconditions and endpoints of each function relating to a business object and translates to the object definition seen within Process Studio.
1.0 Utility - Environment
Utilities for interacting with the environment - read screen resolution, determine OS type, etc.
The runmode of this business object is "background"
1.1 Clear Clipboard
Clears the clipboard contents.
1.2 Close Window by Process Name
Parameter Direction Data Type Description
1.3 Close Window by Window Title
Parameter Direction Data Type Description
| Process Name | In | Text | |
| WindowTitle | In | Text | The entire window title or just a pece of it but without wildcards |
1.4 Font Smoothing Enabled
Gets the font smoothing setting for the current environment.
Preconditions:
Parameter Direction Data Type Description
| Enabled | Out | Flag | True if font smoothing is enabled |
1.5 Get Clipboard
Gets the contents of the clipboard.
Parameter Direction Data Type Description
| Clipboard | Out | Text | The value from the clipboard. |
1.6 Get Machine Name
Parameter Direction Data Type Description
| Machine Name | Out | Text | The hostname of the machine running this action |
1.7 Get Screen Resolution
Gets the resolution of the screen in pixels for the current environment.
Parameter Direction Data Type Description
| Horizontal Resolution | Out | Number | The number of pixels in the horizontal screen axis |
| Vertical Resolution | Out | Number | The number of pixels in the vertical screen axis |
1.8 Get User Name
Parameter Direction Data Type Description
| User Name | Out | Text | The name of the logged in user in the current system |
1.9 Kill Process
Force kills all processes with a given name.
Preconditions:
None.
Endpoint:
All processes with the given name will be terminated.
Parameter Direction Data Type Description
| Process Name | In | Text | The name of the process to kill |
1.10 Kill Process Window
Force kills all processes with a given name.
Preconditions:
None.
Endpoint:
All processes with the given name will be terminated.
Parameter Direction Data Type Description
| Process Name | In | Text | The name of the process to kill |
1.11 Read Memory Stats
Get memory statistics for a given set of processes including the working set and the virtual memory size.
Preconditions:
None.
Parameter Direction Data Type Description
| Process Names | In | Collection | The names of the processes to get memory statistics for |
| - Process Name | In | Text | |
| - PID | In | Number | |
| Process Statistics | Out | Collection | A collection of process statistics including the working set and the virtual memory size |
| - Process Name | Out | Text | |
| - PID | Out | Number | |
| - Working Set | Out | Number | |
| - Virtual Memory | Out | Number | |
1.12 Read Process Working Set
Gets the size of the working set for the given process.
Parameter Direction Data Type Description
| Process Name | In | Text | The name of the process you want stats for |
| Working Set | Out | Number | The working set number holding memory stats for your process |
1.13 Run Process Until Ended
Run a process and wait until completion or timeout.
Parameter Direction Data Type Description
| Application | In | Text | The application or shortcut to start |
| Arguments | In | Text | Optional - any arguments needed to run the application |
| Working Folder | In | Text | Optional - the application working folder |
| Timeout | In | TimeSpan | How long to wait for the application to finish. Default is 10 seconds |
1.14 Set Clipboard
Sets the contents of the clipboard.
Parameter Direction Data Type Description
| Clipboard | In | Text | The value to set the clipboard to. |
1.15 Start Process
Starts a process directly with the given arguments.
Parameter Direction Data Type Description
| Application | In | Text | The application or short cut to start |
| Arguments | In | Text | Any arguments needed for the app |
1.16 Wait for Process
Attach to a process and wait for it to complete.
Parameter Direction Data Type Description
| Maximum wait time (seconds) | In | Number | The maximum time to wait for the process to complete |
| Process Name | In | Text | The name of the process to attach to |
| Found? | Out | Flag | True=process found, false=process not found |
1.17 Wait for Process Window
Waits for a process with a given name has displayed a window with the given title.
Parameter Direction Data Type Description
| Process Name | In | Text | The name of the process to attach to |
| Window Title | In | Text | The title of the window within the process |
| Wait | In | Number | The maximum amount of time to wait for |
| Found | Out | Flag |
