Merge pull request #12 from SkylineCommunications/Catalog-Readme

Catalog readme

Author: ArneMaes0

.githubtocatalog/auto-generated-catalog.yml

@@ -0,0 +1,79 @@
+# [Required]
+# Possible values for the Catalog item that can be deployed on a DataMiner System:
+#   - automationscript: If the Catalog item is a general-purpose DataMiner Automation script.
+#   - lifecycleserviceorchestration: If the Catalog item is a DataMiner Automation script designed to manage the life cycle of a service.
+#   - profileloadscript: If the Catalog item is a DataMiner Automation script designed to load a standard DataMiner profile.
+#   - userdefinedapi: If the Catalog item is a DataMiner Automation script designed as a user-defined API.
+#   - adhocdatasource: If the Catalog item is a DataMiner Automation script designed for an ad hoc data source integration.
+#   - chatopsextension: If the Catalog item is a DataMiner Automation script designed as a ChatOps extension.
+#   - connector: If the Catalog item is a DataMiner XML connector.
+#   - slamodel: If the Catalog item is a DataMiner XML connector designed as DataMiner Service Level Agreement model.
+#   - enhancedservicemodel: If the Catalog item is a DataMiner XML connector designed as DataMiner enhanced service model.
+#   - visio: If the Catalog item is a Microsoft Visio design.
+#   - solution: If the Catalog item is a DataMiner Solution.
+#   - testingsolution: If the Catalog item is a DataMiner Solution designed for automated testing and validation.
+#   - samplesolution: If the Catalog item is a DataMiner Solution used for training and education.
+#   - standardsolution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific use case or application.
+#   - dashboard: If the Catalog item is a DataMiner dashboard.
+#   - lowcodeapp: If the Catalog item is a DataMiner low-code app.
+#   - datatransformer: If the Catalog item is a Data Transformer.
+#   - dataquery: If the Catalog item is a GQI data query.
+#   - functiondefinition: If the Catalog item is a DataMiner function definition.
+#   - scriptedconnector: If the Catalog item is a DataMiner scripted connector.
+#   - bestpracticesanalyzer: If the Catalog item is a DataMiner Best Practices Analysis file.
+type: DevTool
+# [Required]
+# The ID of the Catalog item.
+# All registered versions for the same ID are shown together in the Catalog.
+# This ID can not be changed.
+# If the ID is not filled in, the registration will fail with HTTP status code 500.
+# If the ID is filled in but does not exist yet, a new Catalog item will be registered with this ID.
+# If the ID is filled in but does exist, properties of the item will be overwritten.
+#   Must be a valid GUID.
+id: e30c5a15-9a8f-465b-83d0-d1de77aa3396
+# [Required]
+# The human-friendly name of the Catalog item.
+# Can be changed at any time.
+#   Max length: 100 characters.
+#   Cannot contain newlines.
+#   Cannot contain leading or trailing whitespace characters.
+title: Low Code App Editor
+# [Optional]
+# General information about the Catalog item.
+#   Max length: 100,000 characters
+# Currently not shown in the Catalog UI but will be supported in the near future.
+short_description: An interactive Automation script to export, and do some general edits to the low-code apps of a DataMiner System.
+# [Optional]
+# A valid URL that points to the source code.
+#   A valid URL
+#   Max length: 2048 characters
+source_code_url: https://github.com/SkylineCommunications/Low-Code-App-Editor
+# [Optional]
+# A valid URL that points to documentation.
+#   A valid URL
+#   Max length: 2048 characters
+# Currently not shown in the Catalog UI but will be supported in the near future.
+documentation_url: https://github.com/SkylineCommunications/Low-Code-App-Editor/blob/main/README.md
+# [Optional]
+# People who are responsible for this Catalog item. Might be developers, but this is not required.
+# Format: 'name <email> (url)'
+#   The name is required; max 256 characters.
+#   The email and url are optional, and should be in valid email/URL formats.
+owners:
+  - email: arne.maes@skyline.be
+    name: Arne Maes
+    url: https://github.com/ArneMaes0
+# [Optional]
+# Tags that allow you to categorize your Catalog items.
+#   Max number of tags: 5
+#   Max length: 50 characters.
+#   Cannot contain newlines.
+#   Cannot contain leading or trailing whitespace characters.
+tags:
+  - Generic
+  - Tool
+  - Automation Script
+  - Low-Code App
+  - LCA
+  - dataminer
+  - dataminer-automation-script

catalog.md

@@ -0,0 +1,46 @@
+# Low Code App Editor
+
+[![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)
+
+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.
+
+![Overview](Documentation/LCAEditor_1_0_0_13.gif)
+
+## Getting Started
+
+#### Step 1: Deploy the Low Code App Editor package
+
+1. Click the **Deploy** button to deploy the package directly to your DataMiner System.
+1. Optionally, go to [admin.dataminer.services](https://admin.dataminer.services/) and verify whether the deployment was successfull.
+
+#### Step 2: Launch the script
+
+1. Open DataMiner Cube and navigate to the Automation module.
+1. Search for the **Low Code App Editor** script.
+1. Click the *Execute* button.
+
+## Use Cases
+
+### Exporting Apps
+
+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.
+
+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).
+
+> [!NOTE]
+> To avoid compatibility issues, when exporting an app from one DMA to another, ensure that the versions match (for example GQI versions).
+
+![Editor](Documentation/ExportDialog.png)
+
+## Editing Apps
+
+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.
+
+> [!CAUTION]
+> When you add users to the editors/viewers list, there is no check if the users that you add actually exist.
+
+![Editor](Documentation/EditorDialog_1_0_0_13.gif)
+
+## Support
+
+For additional help, reach out to [arne.maes@skyline.be](mailto:arne.maes@skyline.be)

catalog.yml

@@ -0,0 +1,78 @@
+# [Required]
+# Possible values for the Catalog item that can be deployed on a DataMiner System:
+#   - Automation: If the Catalog item is a general-purpose DataMiner Automation script.
+#   - Ad Hoc Data Source: If the Catalog item is a DataMiner Automation script designed for an ad hoc data source integration.
+#   - ChatOps Extension: If the Catalog item is a DataMiner Automation script designed as a ChatOps extension.
+#   - Connector: If the Catalog item is a DataMiner XML connector.
+#   - Custom Solution: If the Catalog item is a DataMiner Solution.
+#   - Data Query: If the Catalog item is a GQI data query.
+#   - Dashboard: If the Catalog item is a DataMiner dashboard.
+#   - DevTool: If the Catalog item is a DevTool.
+#   - Product Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific product.
+#   - Scripted Connector: If the Catalog item is a DataMiner scripted connector.
+#   - Standard Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific use case or application.
+#   - System Health: If the Catalog item is intended to monitor the health of a system.
+#   - User-Defined API: If the Catalog item is a DataMiner Automation script designed as a user-defined API.
+#   - Visual Overview: If the Catalog item is a Microsoft Visio design.
+
+type: 'DevTool'
+
+# [Required] 
+# The ID of the Catalog item.
+# All registered versions for the same ID are shown together in the Catalog.
+# This ID can not be changed. 
+# If the ID is not filled in, the registration will fail with HTTP status code 500. 
+# If the ID is filled in but does not exist yet, a new Catalog item will be registered with this ID.
+# If the ID is filled in but does exist, properties of the item will be overwritten.
+#   Must be a valid GUID.
+id: 'e30c5a15-9a8f-465b-83d0-d1de77aa3396'
+
+# [Required] 
+# The human-friendly name of the Catalog item. 
+# Can be changed at any time.
+#   Max length: 100 characters.
+#   Cannot contain newlines.
+#   Cannot contain leading or trailing whitespace characters.
+title: 'Low Code App Editor'
+
+# [Optional]
+# General information about the Catalog item.
+#   Max length: 100,000 characters
+# Currently not shown in the Catalog UI but will be supported in the near future.
+short_description: 'An interactive Automation script to export, and do some general edits to the low-code apps of a DataMiner System.'
+
+# [Optional]
+# A valid URL that points to the source code.
+#   A valid URL
+#   Max length: 2048 characters
+source_code_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor'
+
+# [Optional]
+# A valid URL that points to documentation.
+#   A valid URL
+#   Max length: 2048 characters
+# Currently not shown in the Catalog UI but will be supported in the near future.
+documentation_url: 'https://github.com/SkylineCommunications/Low-Code-App-Editor/blob/main/README.md'
+
+# [Optional]
+# People who are responsible for this Catalog item. Might be developers, but this is not required.
+# Format: 'name <email> (url)'
+#   The name is required; max 256 characters.
+#   The email and url are optional, and should be in valid email/URL formats.
+owners:
+  - name: 'Arne Maes'
+    email: 'arne.maes@skyline.be'
+    url: 'https://github.com/ArneMaes0'
+
+# [Optional]
+# Tags that allow you to categorize your Catalog items.
+#   Max number of tags: 5
+#   Max length: 50 characters.
+#   Cannot contain newlines.
+#   Cannot contain leading or trailing whitespace characters.
+tags:
+  - 'Generic'
+  - 'Tool'
+  - 'Automation Script'
+  - 'Low-Code App'
+  - 'LCA'