|
| 1 | +--- |
| 2 | +title: "Try it out" |
| 3 | +linkTitle: "Try it out" |
| 4 | +description: "Information about trying out {{% ctx %}} Configuration Portal for the first time." |
| 5 | +weight: 10 |
| 6 | +--- |
| 7 | + |
| 8 | +# {{% param title %}} |
| 9 | + |
| 10 | +This guide describes how to try out a new {{% ctx %}} Configuration Portal installation to make sure it is working. |
| 11 | + |
| 12 | +## Test access to Configuration Portal |
| 13 | + |
| 14 | +1. Open a web browser and navigate to `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://sever.domain.com/configurationportal`. |
| 15 | +1. Log in using your Active Directory credentials. Ensure that the account you are using is a member of one of the Active Directory groups specified during installation. |
| 16 | + |
| 17 | +## Test adding a new Configuration Container and data |
| 18 | + |
| 19 | +1. Once logged in, you should be able to add a container by doing as follows: |
| 20 | + 1. Click on the `+ Add Container` button. |
| 21 | + 1. Fill in the `Name` field with the value `TestContainer`. |
| 22 | + 1. Click `Confirm` to create the container. |
| 23 | +1. Click the container you just created. |
| 24 | +1. Using the values of the table below, add data to the created container as follows: |
| 25 | + | Name | Value | Type | |
| 26 | + |---------------|------------------------|---------| |
| 27 | + | `TestText` | `This is a test value` | Text | |
| 28 | + | `TestInteger` | `22` | Integer | |
| 29 | + | `TestBool` | `true` | Bool | |
| 30 | + | `TestObject` | `{"test":22}` | Object | |
| 31 | + |
| 32 | + 1. Click on the `+ Add Parameter/Value Pair` button. |
| 33 | + 1. Fill in the `Name` and the `Value`. |
| 34 | + 1. Select the `Type`. |
| 35 | + 1. Click `CONFIRM` to add the parameter/value pair. |
| 36 | + |
| 37 | +{{< alert type="note" title="Note" >}} |
| 38 | +The {{% ctx %}} Configuration Portal should be treated as a repository of sensitive information which will most likely contain usernames and passwords. We recommend that any sensitive data is {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} before it is added to the portal. |
| 39 | +{{< /alert >}} |
| 40 | + |
| 41 | +## Test exporting an existing Container |
| 42 | + |
| 43 | +1. You should be able to export a container by doing as follows: |
| 44 | + 1. Click on `Home` to navigate back. |
| 45 | + 1. Tick the `Export` checkbox next to the container you created in the previous section. |
| 46 | + 1. Click on the `Export Containers` button. |
| 47 | + |
| 48 | +The file should be downloaded to your computer. |
| 49 | + |
| 50 | +## Test importing an existing Container |
| 51 | + |
| 52 | +1. Modify some parameters from the `TestContainer` by doing as follows: |
| 53 | + 1. Click on the `TestContainer` to open it. |
| 54 | + 1. Click on the `Delete` button for `TestText`. |
| 55 | + 1. Confirm the deletion by clicking `OK` on the pop-up. |
| 56 | + 1. Click on the `Edit` button for `TestInteger`. |
| 57 | + 1. Change the value to `33`. |
| 58 | + 1. Click `CONFIRM` to save the changes. |
| 59 | + |
| 60 | +1. You should be able to import a container by doing as follows: |
| 61 | + 1. Click on `Home` to navigate back. |
| 62 | + 1. Click on the `Import Containers` button. |
| 63 | + 1. Select the previously exported container `zip` file. |
| 64 | + 1. Click `Open` to load the container. |
| 65 | + 1. On the confirmation page, click `IMPORT`. |
| 66 | + 1. Please confirm the import by clicking the`OK` button on the pop-up. |
| 67 | + |
| 68 | +1. Verify that the container has been imported by doing as follows: |
| 69 | + 1. Click on the `TestContainer` to open it. |
| 70 | + 1. Verify that the parameter `TestText` has been re-added and that the value of `TestInteger` retained the modified value of `33`. |
| 71 | + |
| 72 | +{{< alert type="note" title="Note" >}} |
| 73 | +Once you have successfully imported containers, it is recommended to always delete all the `zip` files. |
| 74 | +{{< /alert >}} |
| 75 | + |
| 76 | +## Test reading data from Configuration Portal |
| 77 | + |
| 78 | +1. Open a web browser and navigate to `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://server.domain.com/gateway` |
| 79 | +1. Log in using your Active Directory credentials. |
| 80 | +1. Click on the `Dev` charm, then search for `CM-Get-Config`. |
| 81 | +1. Click on the flow `CM-Get-Config`. |
| 82 | +1. Once the flow has opened, in the Settings tab, set the `ContainersNames` property to `["TestContainer"]`. |
| 83 | +1. Add a breakpoint to the `End Flow` block. |
| 84 | +1. Click on the `Run` button to execute the flow. |
| 85 | +1. When the flow hits the breakpoint, click on the `Variables` tab. |
| 86 | +1. Select the variable `ConfigItems`. |
| 87 | +1. Verify that the variable contains the data you added in the previous section, it should look like the following: |
| 88 | + |
| 89 | +``` json |
| 90 | +{ |
| 91 | + "Parameters": [ |
| 92 | + { |
| 93 | + "ParamID": "e440c1ee-29ee-4b70-9660-60f518a10339", |
| 94 | + "ParamName": "TestInteger", |
| 95 | + "ParamValue": 33 |
| 96 | + }, |
| 97 | + { |
| 98 | + "ParamID": "5f760269-41e4-4f99-8b82-96ac1ccfbb49", |
| 99 | + "ParamName": "TestBool", |
| 100 | + "ParamValue": true |
| 101 | + }, |
| 102 | + { |
| 103 | + "ParamID": "e967217d-4ca0-4a77-b357-2b3ccf1335d7", |
| 104 | + "ParamName": "TestObject", |
| 105 | + "ParamValue": { |
| 106 | + "test": 22 |
| 107 | + } |
| 108 | + }, |
| 109 | + { |
| 110 | + "ParamID": "b0cedd5c-e832-4fd2-8292-462be9b0ab71", |
| 111 | + "ParamName": "TestText", |
| 112 | + "ParamValue": "This is a test value" |
| 113 | + } |
| 114 | + ] |
| 115 | +} |
| 116 | +``` |
0 commit comments