Environments

The environment is an entity that determines the scope within which records with regulated data are stored on the InCountry platform. You can also think about an environment as a bucket that stores sensitive data. Data records stored within a specific environment (so-called, bucket) are separated from records stored in other environments. The environment allows you to get access to your data stores on the InCountry platform.

To view the available environments, on the menu, select Environments. The Environments page opens, as follows:

On the Environments page, you can view the list of available environments. For each environment, the following information is available:

Attribute	Description
Name	Name of the environment that exists for your organization.
Type	Type of the environment.
ID	Unique identifier of the environment.

Within each environment, you can have multiple pairs of Storage credentials and multiple services that you can use for storing regulated data in the InCountry Vault.

You can manage environments as follows:

1. Create new environments
2. Edit the existing environments
3. Delete the no longer needed environments
4. Restore the deleted environments
5. Exporting environment configuration
6. Importing environment configuration
7. Creating and renewing a migration client

Creating new environments

To create a new environment:

1. On the Environments page, click Add environment. Alternatively, you can click + Add environment on the sidebar.
2. On the Parameters page, specify the following information:
   1. Name - enter the name of the environment to identify it among other environments.
   2. Type - select the type of environment which you want to set up (Dev, Test, Staging, Integration, U.A.T., or Production). Depending on your project stage you can select the corresponding option from the list.
3. When complete, click Next.
4. Enter the verification code you receive and click Create.

A newly created environment will appear on the list with environments.

note

You can create up to 20 environments per organization.

Editing the environment

1. On the Environments page, locate the environment you want to edit and hover over it.
2. Click the Edit icon.
3. On the Update environment page, make the required modifications to the environment.
4. When complete, click Next.
5. Enter the confirmation code you receive and click Update.

Deleting environments

If you no longer need some environment, you can delete it on the InCountry Portal.

note

Removal of the environment is not performed immediately. It is scheduled for removal in 60 days, during this period you can restore the environment with all its data. SDK credentials, services, encryption keys, and records stored within this environment will be removed automatically with the removal of the environment.

Warning

Within the 60-day period, you can restore the removed environment before it’s wiped permanently.

1. On the Environments page, locate the environment you want to delete and hover over it.
2. Click the Delete icon.
3. On the Delete environment page, enter the verification code you receive and confirm the removal of the environment.
4. Click Delete.

info

The removed environment will be marked with the DELETED label. You will not be able to access records within the removed environment, as well as use services associated with this environment.

Restoring environments

You can restore the removed environment within the 60-day period from the removal date. InCountry Portal will send notifications about the approaching the removal date.

1. On the Environments page, locate the environment you want to restore and hover over it. Removed environments are highlighted with the DELETED label.
2. Click the Restore environment icon.
3. On the Restore environment page, enter the verification code you receive and confirm the recovery of the environment.
4. Click Restore.

Exporting environment configuration

1. On the left sidebar, select the environment you wish to export or import.
2. On the top right side toolbar of the environment page, find the Export/Import environment configuration icon button and click on it.
3. On the Export/Import Environment Configuration page, choose Export Environment Configuration and click the Export button.
4. The environment configuration will be downloaded as a JSON file to your computer.

Importing environment configuration

1. To import the environment configuration, select Import Environment Configuration, provide the environment configuration JSON file, and click the Import button.
2. The provided environment configuration JSON file will be imported into the current environment.

Creating and renewing a migration client

Alternatively, instead of exporting and importing environment configuration manually, you can create a migration client to facilitate the configuration process from your script.

1. On the left sidebar, select the environment you wish to create a migration client.
2. On the top right side of the toolbar on the environment page, find the Export/Import environment configuration icon button and click on it.
3. On the Export/Import Environment Configuration page, locate the Migration Client section and click the Create button.
4. You will be provided with Migration Client credentials and instructions. Make sure to copy this information now. You will not be able to view the Client Secret again!
5. If you have lost your migration client credentials, you can renew them by clicking the Renew button.