Skip to content

Commit 991a73b

Browse files
ArneMaes0ArneMaes0
authored
Moved full readme to documentation folder and made the catalog readme the default one
1 parent f75bcce commit 991a73b

File tree

3 files changed

+191
-191
lines changed

3 files changed

+191
-191
lines changed

‎Documentation/README.md

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
# Low-Code-App-Editor
2+
3+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SkylineCommunications_Low-Code-App-Extensions&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SkylineCommunications_Low-Code-App-Extensions)
4+
5+
The **Low Code App Editor** simplifies managing low-code applications within the DataMiner System. It allows you to import, export, edit, and delete apps while offering customization options for metadata, resources, and deployment settings. With features like tailored export configurations and cross-Agent synchronization, the tool streamlines app life cycle tasks, making it a practical solution for maintaining and deploying low-code apps efficiently.
6+
7+
![Overview](./Images/LCAEditor_1_0_0_13.gif)
8+
9+
## Installation
10+
11+
### Catalog
12+
You can install the script through the catalog.
13+
1. Go to the [catalog](https://catalog.dataminer.services/).
14+
1. Search for "Low Code App Editor".
15+
1. Click *Deploy*.
16+
1. Select the DMA you want to deploy to.
17+
1. Click *Deploy*.
18+
1. Open the Automation app on your DMA.
19+
1. Go to the **Low Code App Editor** script.
20+
1. Click the *Execute* button.
21+
22+
### Manual
23+
You can do a manual install by downloading the .dmapp package file from the releases.
24+
1. Go to [releases](https://github.com/SkylineCommunications/Low-Code-App-Extensions/releases).
25+
1. Download the .dmapp package from the latest version.
26+
1. Install the package on your DMA.
27+
1. Open the Automation app on your DMA.
28+
1. Go to the **Low Code App Editor** script.
29+
1. Click the *Execute* button.
30+
31+
## Features
32+
33+
- [Edit](#edit)
34+
- [Export](#export)
35+
- [Import](#import)
36+
- [Delete](#delete)
37+
38+
### Edit
39+
You can edit some general information about the low-code app. You can import pages/panels from other apps in the system here as well.
40+
1. Name
41+
1. Description
42+
1. Sections
43+
1. Editors
44+
1. Viewers
45+
1. Pages
46+
1. Panels
47+
48+
> [!WARNING]
49+
> When you add users to the editors/viewers list, there is no check if the users that you add actually exist.
50+
>
51+
52+
![Editor](./Images/EditorDialog_1_0_0_13.gif)
53+
54+
### Export
55+
It is possible to export apps. This option will try and gather all the needed files for the selected apps and create a .dmapp package to install it elsewhere. It will export the create package to **C:\Skyline DataMiner\Documents\DMA_COMMON_DOCUMENTS\Low Code Apps Exports**
56+
57+
Below you'll find all the options available when exporting a low code app.
58+
59+
> [!NOTE]
60+
> When exporting an app from one DMA to another, make sure the versions match (for example the GQI versions).
61+
62+
#### Export Options
63+
64+
##### 1. Include Version History
65+
66+
This will include all the previous versions made on the system. Even the ones no longer used.
67+
68+
##### 2. Overwrite Previous Version
69+
70+
This option allows you to update an existing app. If it's disabled it will not overwrite another app but instead rename the to be installed app to include a (1) at the end instead. That way you have both version of the app side by side.
71+
72+
##### 3. Sync App
73+
74+
This options will sync all the files for the app to the other agents in the DMS. Otherwise it will install the app on the agent the installer is running on.
75+
76+
##### 4. Exclude Scripts
77+
78+
This option will ignore all the found scripts in the app. This option is usefull when you want to create an install package and are planning on adding the scripts solutions in the manifest.xml file of the install package anyway.
79+
80+
##### 5. Exclude DOM
81+
82+
This will ignore the found DOM modules in the app. This option is usefull when you want to create an install package and are planning on adding the DOM modules install package anyway.
83+
84+
##### 6. Include DOM Instances
85+
86+
This will include the DOM instances as well as the definitions. This can be usefull but can also be very heavy on the system if there are a lot of instances.
87+
88+
##### 7. Exclude Images
89+
90+
This will ignore the all the found images from the exported package.
91+
92+
##### 8. Sync Images
93+
94+
This will sync the found images across the DMS.
95+
96+
##### 9. Overwrite Images
97+
98+
This option will allow the installer to overwrite an image if there is an existing one. The matching is done based on file path.
99+
100+
##### 10. Exclude Themes
101+
102+
This option will exclude the found themes from the exported package.
103+
104+
##### 11. Sync Themes
105+
106+
This options will sync the themes.json file across the DMS
107+
108+
##### 12. Overwrite Themes
109+
110+
This options will overwrite the existing themes if there are already matching themes found. The matching is based on the theme name.
111+
112+
113+
#### Overview of included items
114+
- Custom operators
115+
- Configured action scripts
116+
- Dependencies of the used scripts
117+
- DOM modules
118+
- Images
119+
- Themes
120+
121+
![Editor](./Images/ExportDialog.png)
122+
123+
### Import
124+
125+
Importing an exported .dmapp package can happen in a few different ways:
126+
127+
#### Taskbar Utility
128+
If you have access to the DataMiner agent, you can copy over the .dmapp package and double click it to install it via the Taskbar Utility.
129+
130+
![Editor](./Images/TaskbarUtility_Install.png)
131+
132+
#### Client test tool
133+
If you do not have RDP access to the DataMiner agent, but have a DataMiner user with the correct permissions. Then you can use the Client Test Tool to install packages too.
134+
135+
1. Open the Client Test Tool
136+
1. In the tool bar go to "Connection" -> "Connect"
137+
1. Enter you credentials and press "Connect"
138+
1. in the tool bar go to "Advanced" -> "Apps" -> "AppPackages..."
139+
1. Click on "Upload Package" and select the .dmapp package
140+
1. Select the uploaded package in the list and press "Install Package"
141+
1. [Optional] Remove the uploaded package by clicking "Remove Uploaded Package"
142+
143+
![Editor](./Images/AppPackages_Window.png)
144+
145+
### Delete
146+
You can delete apps as well.
147+
148+
![Editor](./Images/DeleteDialog.png)
149+
150+
## About DataMiner
151+
152+
DataMiner is a transformational platform that provides vendor-independent control and monitoring of devices and services.
153+
Out of the box and by design, it addresses key challenges such as security, complexity, multi-cloud, and much more.
154+
It has a pronounced open architecture and powerful capabilities enabling users to evolve easily and continuously.
155+
156+
The foundation of DataMiner is its powerful and versatile data acquisition and control layer.
157+
With DataMiner, there are no restrictions to what data users can access.
158+
Data sources may reside on premises, in the cloud, or in a hybrid setup.
159+
160+
A unique catalog of 7000+ connectors already exist.
161+
In addition, you can leverage DataMiner Development Packages to build your own connectors (also known as "protocols" or "drivers").
162+
163+
> [!NOTE]
164+
> See also: [About DataMiner](https://aka.dataminer.services/about-dataminer).
165+
166+
## About Skyline Communications
167+
168+
At Skyline Communications, we deal in world-class solutions that are deployed by leading companies around the globe.
169+
Check out [our proven track record](https://aka.dataminer.services/about-skyline) and see how we make our customers' lives easier by empowering them to take their operations to the next level.

‎README.md

+22-145
Original file line numberDiff line numberDiff line change
@@ -1,169 +1,46 @@
1-
# Low-Code-App-Editor
1+
# Low Code App Editor
22

33
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SkylineCommunications_Low-Code-App-Extensions&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SkylineCommunications_Low-Code-App-Extensions)
44

55
The **Low Code App Editor** simplifies managing low-code applications within the DataMiner System. It allows you to import, export, edit, and delete apps while offering customization options for metadata, resources, and deployment settings. With features like tailored export configurations and cross-Agent synchronization, the tool streamlines app life cycle tasks, making it a practical solution for maintaining and deploying low-code apps efficiently.
66

77
![Overview](./Images/LCAEditor_1_0_0_13.gif)
88

9-
## Installation
10-
11-
### Catalog
12-
You can install the script through the catalog.
13-
1. Go to the [catalog](https://catalog.dataminer.services/).
14-
1. Search for "Low Code App Editor".
15-
1. Click *Deploy*.
16-
1. Select the DMA you want to deploy to.
17-
1. Click *Deploy*.
18-
1. Open the Automation app on your DMA.
19-
1. Go to the **Low Code App Editor** script.
20-
1. Click the *Execute* button.
21-
22-
### Manual
23-
You can do a manual install by downloading the .dmapp package file from the releases.
24-
1. Go to [releases](https://github.com/SkylineCommunications/Low-Code-App-Extensions/releases).
25-
1. Download the .dmapp package from the latest version.
26-
1. Install the package on your DMA.
27-
1. Open the Automation app on your DMA.
28-
1. Go to the **Low Code App Editor** script.
29-
1. Click the *Execute* button.
30-
31-
## Features
32-
33-
- [Edit](#edit)
34-
- [Export](#export)
35-
- [Import](#import)
36-
- [Delete](#delete)
37-
38-
### Edit
39-
You can edit some general information about the low-code app. You can import pages/panels from other apps in the system here as well.
40-
1. Name
41-
1. Description
42-
1. Sections
43-
1. Editors
44-
1. Viewers
45-
1. Pages
46-
1. Panels
47-
48-
> [!WARNING]
49-
> When you add users to the editors/viewers list, there is no check if the users that you add actually exist.
50-
>
51-
52-
![Editor](./Images/EditorDialog_1_0_0_13.gif)
53-
54-
### Export
55-
It is possible to export apps. This option will try and gather all the needed files for the selected apps and create a .dmapp package to install it elsewhere. It will export the create package to **C:\Skyline DataMiner\Documents\DMA_COMMON_DOCUMENTS\Low Code Apps Exports**
56-
57-
Below you'll find all the options available when exporting a low code app.
58-
59-
> [!NOTE]
60-
> When exporting an app from one DMA to another, make sure the versions match (for example the GQI versions).
61-
62-
#### Export Options
63-
64-
##### 1. Include Version History
65-
66-
This will include all the previous versions made on the system. Even the ones no longer used.
67-
68-
##### 2. Overwrite Previous Version
69-
70-
This option allows you to update an existing app. If it's disabled it will not overwrite another app but instead rename the to be installed app to include a (1) at the end instead. That way you have both version of the app side by side.
71-
72-
##### 3. Sync App
73-
74-
This options will sync all the files for the app to the other agents in the DMS. Otherwise it will install the app on the agent the installer is running on.
75-
76-
##### 4. Exclude Scripts
77-
78-
This option will ignore all the found scripts in the app. This option is usefull when you want to create an install package and are planning on adding the scripts solutions in the manifest.xml file of the install package anyway.
79-
80-
##### 5. Exclude DOM
9+
## Getting Started
8110

82-
This will ignore the found DOM modules in the app. This option is usefull when you want to create an install package and are planning on adding the DOM modules install package anyway.
11+
#### Step 1: Deploy the Low Code App Editor package
8312

84-
##### 6. Include DOM Instances
13+
1. Click the **Deploy** button to deploy the package directly to your DataMiner System.
14+
1. Optionally, go to [admin.dataminer.services](https://admin.dataminer.services/) and verify whether the deployment was successfull.
8515

86-
This will include the DOM instances as well as the definitions. This can be usefull but can also be very heavy on the system if there are a lot of instances.
16+
#### Step 2: Launch the script
8717

88-
##### 7. Exclude Images
89-
90-
This will ignore the all the found images from the exported package.
91-
92-
##### 8. Sync Images
93-
94-
This will sync the found images across the DMS.
95-
96-
##### 9. Overwrite Images
97-
98-
This option will allow the installer to overwrite an image if there is an existing one. The matching is done based on file path.
99-
100-
##### 10. Exclude Themes
101-
102-
This option will exclude the found themes from the exported package.
103-
104-
##### 11. Sync Themes
18+
1. Open DataMiner Cube and navigate to the Automation module.
19+
1. Search for the **Low Code App Editor** script.
20+
1. Click the *Execute* button.
10521

106-
This options will sync the themes.json file across the DMS
22+
## Use Cases
10723

108-
##### 12. Overwrite Themes
24+
### Exporting Apps
10925

110-
This options will overwrite the existing themes if there are already matching themes found. The matching is based on the theme name.
26+
You can export apps using this feature, which gathers all the necessary files for the selected apps and creates a .dmapp package. This package can then be installed on another system. The exported package is saved to the following directory: C:\Skyline DataMiner\Documents\DMA_COMMON_DOCUMENTS\Low Code Apps Exports.
11127

28+
For more details on the exporting functionality, refer to the [Low Code App Editor readme](https://github.com/SkylineCommunications/Low-Code-App-Editor/blob/main/README.md).
11229

113-
#### Overview of included items
114-
- Custom operators
115-
- Configured action scripts
116-
- Dependencies of the used scripts
117-
- DOM modules
118-
- Images
119-
- Themes
30+
> [!NOTE]
31+
> To avoid compatibility issues, when exporting an app from one DMA to another, ensure that the versions match (for example GQI versions).
12032
12133
![Editor](./Images/ExportDialog.png)
12234

123-
### Import
124-
125-
Importing an exported .dmapp package can happen in a few different ways:
126-
127-
#### Taskbar Utility
128-
If you have access to the DataMiner agent, you can copy over the .dmapp package and double click it to install it via the Taskbar Utility.
35+
## Editing Apps
12936

130-
![Editor](./Images/TaskbarUtility_Install.png)
37+
You can edit various aspects of your low-code app's general information in this section. Additionally, you have the option to import pages and panels from other apps within the system to enhance functionality. The features you can manage here include the app's name, description, and sections. You can also define who can edit the app by selecting editors and specify access permissions by assigning viewers. Furthermore, you can expand the app's capabilities by integrating pages and panels from other apps.
13138

132-
#### Client test tool
133-
If you do not have RDP access to the DataMiner agent, but have a DataMiner user with the correct permissions. Then you can use the Client Test Tool to install packages too.
134-
135-
1. Open the Client Test Tool
136-
1. In the tool bar go to "Connection" -> "Connect"
137-
1. Enter you credentials and press "Connect"
138-
1. in the tool bar go to "Advanced" -> "Apps" -> "AppPackages..."
139-
1. Click on "Upload Package" and select the .dmapp package
140-
1. Select the uploaded package in the list and press "Install Package"
141-
1. [Optional] Remove the uploaded package by clicking "Remove Uploaded Package"
142-
143-
![Editor](./Images/AppPackages_Window.png)
144-
145-
### Delete
146-
You can delete apps as well.
147-
148-
![Editor](./Images/DeleteDialog.png)
149-
150-
## About DataMiner
151-
152-
DataMiner is a transformational platform that provides vendor-independent control and monitoring of devices and services.
153-
Out of the box and by design, it addresses key challenges such as security, complexity, multi-cloud, and much more.
154-
It has a pronounced open architecture and powerful capabilities enabling users to evolve easily and continuously.
155-
156-
The foundation of DataMiner is its powerful and versatile data acquisition and control layer.
157-
With DataMiner, there are no restrictions to what data users can access.
158-
Data sources may reside on premises, in the cloud, or in a hybrid setup.
159-
160-
A unique catalog of 7000+ connectors already exist.
161-
In addition, you can leverage DataMiner Development Packages to build your own connectors (also known as "protocols" or "drivers").
39+
> [!CAUTION]
40+
> When you add users to the editors/viewers list, there is no check if the users that you add actually exist.
16241
163-
> [!NOTE]
164-
> See also: [About DataMiner](https://aka.dataminer.services/about-dataminer).
42+
![Editor](./Images/EditorDialog_1_0_0_13.gif)
16543

166-
## About Skyline Communications
44+
## Support
16745

168-
At Skyline Communications, we deal in world-class solutions that are deployed by leading companies around the globe.
169-
Check out [our proven track record](https://aka.dataminer.services/about-skyline) and see how we make our customers' lives easier by empowering them to take their operations to the next level.
46+
For additional help, reach out to [arne.maes@skyline.be](mailto:arne.maes@skyline.be)

0 commit comments

Comments
 (0)