Creating a component - Legacy UI
SECURITY Refer to COMPONENTS > Components in Security Level Details - Permissions
NAVIGATION Legacy UI > Components tab
Refer to Creating a component.
About
In addition to downloading a component from the ComStore, you can create components yourself and share them with other users.
A typical component contains a script, written in one of several available scripting languages, and may also contain a program to install or an executable to run. This functionality guarantees that administrators have complete control over the technology they manage.
The Datto RMM Support team covers the following:
- Troubleshoot jobs associated to scripts/components.
- Investigate if a script runs successfully outside of Datto RMM but does not run successfully in Datto RMM.
Datto RMM Support does not cover custom script/component creation. Partners are advised to contact their account manager for a Professional Services engagement if they require assistance with script/component creation.
For more information, refer to Getting support for components.
How to...
- Click the Components tab.
- In the upper-left corner, click New Component.
- Select a Category: Applications, Device Monitors, Scripts.
- Enter a Name and a Description.
- Click Save. The Component page opens. The following information is displayed:
Field | Description |
---|---|
Favorite | Only available for the categories Applications and Scripts. Click the icon to make this component available to be used in quick jobs and as alert response in monitors in the legacy UI. Refer to Make a component available for quick jobs and Run the following component. |
Copy this component | Opens a confirmation dialog. Click OK to create a copy of the component. |
General |
|
Field | Description |
Category | Displays the selection made on the previous page. |
Name | Displays the name entered on the previous page but it can be edited. |
Description | Displays the description entered on the previous page but it can be edited. |
ID | The unique identifier of the new component. |
Component Level | Specifies which users can view this component. Refer to Component Level in the legacy UI and Component Level in the New UI. NOTE The component level of custom components can be set to 1 (Basic), 2 (Low), 3 (Medium), 4 (High) and 5 (Super). |
Created | The date and time the component was created in UTC, and the name of the creator. |
Modified | The date and time the component was last modified. |
Change Image | Click to select a different image for this component. You can choose an already uploaded image from the image library, or you can choose an image on your machine (48x48 PNG/JPG/GIF file). |
Sites |
|
Field | Description |
Sites radio button | Select one of the following options: • All sites - The component can be deployed to devices belonging to any site. NOTE In order to select this option, your security level must allow you access to all sites in the account. Refer to Security Level Details - Device Visibility in the legacy UI and Device visibility in the New UI. • Selected sites -You can select the sites to which this component can be deployed. Security levels without access to one or more of these sites will not be able to view this component. Use the Search field above either the Include or Exclude column to search for your sites. As you type, the search results are narrowed to match your search string. By default, all sites are initially excluded. Refer to Map components to specific sites. |
Commands / Script |
|
Field | Description |
Install command/Script | From the drop-down list, select the scripting language you want to use. For an overview of scripting, refer to Scripting - Legacy UI. |
Expand/Collapse | Changes the size of the Install command text box. |
Text field | Enter the install command (script) into the text box. |
Timeout this script if not completed within X seconds | Allows you to set the maximum amount of time, in seconds, after which the script will time out. |
This component requires site credentials | Only available for the categories Applications and Scripts. If installing this component requires a username and password that is unique for each site, checking this setting will allow Datto RMM to use the cached credentials entered in Site Settings. To learn how to cache site credentials, refer to Credentials in the legacy UI and Component credentials in the New UI. |
Files (only available for the categories Applications and Scripts) |
|
Field | Description |
Add file... | Click Add file... to add an installer file. The file will be uploaded and shown in the list. Click the file name to download the file to your device or the Delete this file icon to remove it. Refer to Attached files. NOTE You can have more than one file in the component, but each file must not be larger than 3 GB. In addition, you should not exceed a component size of 5 GB total. |
Variables |
|
Field | Description |
Input Variables |
Input variables allow you to determine certain parameters at runtime, so you don't have to have them hard coded in the script itself. Moreover, input variables allow you to re-use a single component to carry out multiple tasks. You can add multiple variables, and they can be edited and deleted. For more information, refer to Input variables - Legacy UI. |
Output Data | Only available for the category Device Monitors. Optionally, you can configure the component with the variable name you are using to capture the output. Click the plus icon to the right of this section to open the Add Output Variable dialog box. You can add multiple variables, and they can be edited and deleted. Add the following details: • Name • Type - Select one of the following options: String, Number, Timestamp, Boolean, Blob • Description Finally, click Add. For more information, refer to Create a custom component monitor - Legacy UI. NOTE While you can define output variables in the legacy UI, they are not displayed or supported in the New UI. If a monitor component containing output variables is edited in the New UI, the output variables will be deleted from the component, which will not affect functionality. A component monitor that meets StdOut requirements will return data without requiring additional configuration via output variables. |
Post-Conditions (only available for the categories Applications and Scripts) |
|
Field | Description |
Warning Text | This function will look at the output (Standard Output Stream and/or the Standard Error Stream) from a script you have run and alert if a specific text string is either found or not found. Click Click here to add a post-condition. For more information, refer to Post-Conditions. |
- Click Save. The component will now be added to your Component Library.
Custom components and components that are copies of components downloaded from the ComStore can be edited. For components that can be edited, the name appears as a hyperlink.
- Click the Components tab.
- Click a component name that appears as a hyperlink.
- Edit the fields as required. For field descriptions, refer to Create a component.
- When you have finished editing the component, click Save.
IMPORTANT When you edit a component that is used in a Monitoring policy, make sure to re-push the policy for the component changes to be applied.