Managing Environments

The Manage Environments feature in Cloud Elements is an asset management tool which facilitates the import of artifacts like Elements, Formulas, and Virtual Data Resources from the local system to the platform, as well as the export of the same, from the platform to your local system. It can also help you promote or move your artifacts from your current environment to the target environment.

Why Manage Environments?

Though we already support export and import of any artifact to/from the platform, it is limited to one asset at a time. With this feature, you can import or export multiple artifacts at the same time. This could be ‘n’ number of Elements, Formulas and Virtual Data Resources or a combination of the three.

In addition to importing and exporting your artifacts, you can also move them from one environment to another; not only from a lower level to higher level environment but also vice versa.

Note: All artifacts - Elements, Formulas and Virtual Data Resources are managed at the account level. Only one active job per account is allowed; This means that if one among the several users in an account initiate a job, the other users will have to wait until the active job is completed.
All the users in an account can view the job logs on the landing page. However, while all the users in an account will be able to view the progress of a job, only the user who initiated the job can terminate it. 

How to Manage Environments

To use this feature, click on Settings > Manage Environments on our UI. 

  1. The landing page that appears will show use the history of changes made already.
  2. Click the dropdown icon for more information on a particular operation.
  3. You can use the Import, Export or Promote functions, each of which is explained further in detail below.

Managing Environments - Landing Page 

On the landing page, users can view all logs maintained at the account level, which means all the users in an account  have a common view of all job logs. This page is where a user initiates the action to either export or import all artifacts to or from the platform. This page shows a maximum of 100 records with the latest ones on the top. Users also have the flexibility to sort the logs by Job ID, User ID, Owner, Type, Status and Created date.

The table on the landing page includes the following properties:

PropertyDescription
Refresh buttonOn clicking this button, all the jobs on the landing page get refreshed.
Job IDUnique identifier for a job.
User IDIdentifier for a user in an account.
TypeType of functionality executed for the job ID. It  could be import or export.
OwnerUser who executes the job. If a user is the owner of a job, the value will be ‘Yes’.
StatusStatus of the job that is active. The values of this property could be 'In Progress' (when a job is running/active), 'Completed' (when a job is completed) or 'Cancelled' (when a job is terminated either by a user or internal system issue).
Created DateThe date and time stamp for a job that is being executed.
Error MessageMessage that appears when a job is cancelled by the user.

Each log on the table can be expanded to view more details of a job that includes the list of artifacts that have been exported/imported. When a job is in progress, the job owner can view the job status by clicking on the the ‘View Job’ button.

Note: We maintain a maximum of 100 jobs on the landing page at an account level. At the event of a user initiating a new job after already having reached the maximum of a 100 jobs, the oldest one will be lost. 

Export

With the export option, you can export all your artifacts including Elements (private and extended), Virtual Data Resources and Formulas from your account to your local system. 

To use the export functionality, complete these steps:

  1. Click on the Export button on the top right corner of the page.
  2. The screen that appears shows all the Elements, Formulas and Virtual Data Resources that are available in your current environment.
    a. You can select/deselect items as per your need.
    b. You can also search for any specific artifact if you would like to.
  3. Select all the artifacts that you'd like to export out of the environment you're on.
  4. Click the 'Export Selected Content' button.
  5. After the export job begins, you can see the progress of the job displayed as the message banner on the top.
  6. Users can do the following things while the job is in progress:
    a. You can click on Stop Export to stop exporting the items in your file. On doing so, you can select the items you would like to export again.
    b. You can either stay on this page or migrate to a different page to perform different activities on the account.
  7. Once exported, all the artifacts get saved in a zip file in your computer. As the file gets downloaded, the system navigates the user to the landing page by updating the latest log on the top with an option to download the exported file at any time.

When an artifact is exported, your file gets downloaded in a zip format. On extracting this file you will see three folders - Elements, Formulas and Virtual Data Resources and each folder would contain the corresponding artifacts.

The name of the exported zip file follows a specific format - <environment>_<functionality><ID><Date-time>.

Environment refers to the environment in which the functionality is invoked.
Functionality refers to the function user wants to perform - import, export or promote.
ID is the unique identifier for the AWS bucket.
Date-time refers to when the job is invoked.

On expanding any of the folder, the artifacts contained are shown in sub-folders and each sub-folder contains the corresponding json objects. Shown below is an example.

Note: When importing an asset, use the same file format as discussed above. Only files with .zip format are accepted. You may have to export a file first, replace it with the JSON object you want to import and then execute the import functionality. 

Import

With this functionality, you can import artifacts into your account using a zip file. To use this functionality:

  1. Click on the 'Import' button on the top right corner.
  2. On the screen that opens, click on the 'Select File from Computer' button.
  3. Select the file from your computer that contains the artifacts you saved when you exported them from another environment.
    a. You can only upload a zip file containing all the artifacts exported from our platform.
    b. If the file selected is incorrect, you see an error message as shown below.
    Click Continue to select a different file.
  4. Once you upload the file, you should be able to see the file and all the Elements, Formulas and Virtual Data Resources that it contains on the screen that appears.
    a. You can select/deselect items as per your need.
    b. You can also search for any specific artifact:
  5. Select all the items you would like to import and click 'Import Selected Content'.
  6. You can see the progress of the artifacts being imported.
     You can also watch the progress of the job displayed from the message banner on the top.
  7. User can do the following things while the job is in progress -
    a. You can click on Stop Import to stop importing the items in your file. On doing so, you can select the items you would like to import again.
    b. You can either stay on this page or migrate to a different page to perform different activities on the account.
  8. Once the import is complete, a message appears as shown below.
  9. After import, you can view your logs on the landing page. You can also download the imported files. For an import log, you will see two options using which you can download the imports:
    a. Download 'Imported file' - Allows you to download the zip file that was imported corresponding to this log.
    b. Download 'Backed file' - In case your system gets corrupted, you can download the backup file for an import job.
Note: In a scenario where you already have an asset in your system and you try importing the same asset with some modified configurations, the existing asset will be updated with the new asset you are importing. 

Promote

With Promote, you can move artifacts from your current environment to any other environment. For example, you could move a Formula built on your staging environment to either your snapshot environment or production environment. 

To use this feature:

  1. Click on the 'Promote' button on the landing page. 
  2. On the screen that appears, you should see all the artifacts, that is, Elements, Formulas and Virtual Data Resources in your current environment.
    • From the list you can select/deselect the artifacts you'd like to promote.
    • You can also search for any specific artifact if you would like to.
  3. Select all the artifacts you want to promote.
  4. On the same page, choose the target environment that you would like to move your artifact(s) to.
  5. Click on 'Promote'.
  6. A pop-up screen appears. Enter the credentials to your target environment. This includes an Organization Secret and a User Secret
  7. Validate the keys and click 'Promote'.
  8. While the job is in progress, user can:
    • Stop the process of promoting. This will revert the job and update its status on the landing page.
    • Stay on the page or perform different activities on another page of the account. 
    • Cancel the promote job while the job is still running. While promoting, the time that is taken to move artifacts depend on the size of the artifacts. If you click on the Cancel button while the job is still running and by then some of the assets in the artifact have already been moved, then you can view the upload status (Complete or Failed) of every asset in the artifact. It is now up to you whether you want to keep the moved assets and not bother with the others or cancel all uploads and go back to how it originally was. promoted might have other dependencies
  9. Sometimes an asset being promoted may have other dependencies. For example, if you want to promote a Formula that makes use of a VDR and a private element, you would need to promote the other artifacts, that is, the VDR and the private element as well.
    • In this case, you will see a pop-up screen which shows all the dependent artifacts.
    • View and select the artifacts you want to promote. Click Promote. All dependent artifacts will get promoted to the target environment along with the artifacts you wanted to promote.