docs/hop-user-manual/modules/ROOT/pages/projects/projects-environments.adoc

////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////
[[HopEnvironments]]
:imagesdir: ../../../assets/images
:language: en_US
:page-pagination:
:openvar: ${
:closevar: }
:description: Projects and environments are essential in keeping your work tidy and organized. Learn how to create and manage projects and environments.

= Projects and Environments

== Create a project

To create a new project click the *Add a new project* button.

image:hop-gui/environment/project-add.svg[Add a new project]


This button opens the following dialog:

image:hop-gui/environment/create-project-dialog.png[Create a project,width="90%"]

.Project Properties
[id="tab-proj-props",cols="20%,45%,5%,5%,25%",options="header"]
|===
|Property|Description|Variables Supported|Mandatory|Default
|Name|The project name|Yes|No|
|Home folder|The folder where the project is located|Yes|No|
|Configuration file (relative path)|The folder where the project's configuration json is located.|Yes|Yes|
|Parent project to inherit from|The project to inherit metadata (e.g. connections) from|Yes|No|default
|Description|A description for this environment|No|No|
|Company|The company this environment belongs to|No|No|
|Department|The department this environment is created for|No|No|
|Metadata base folder|The folder where this environment's metadata will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}/metadata
|Unit test base path|The folder where this environment's unit tests will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}
|Data Sets CSV Folder|The folder where this environment's data files will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}/datasets
|Enforce execution in project home|Give an error when trying to execute a pipeline or workflow which is not located in the environment home directory or in a sub-directory|Yes|Yes|checked
|Project variables to set|A list of variable names, values and variable descriptions to use with this project|No|Yes|
|===

After creating a project the user interface will switch to it and ask if you want to create an environment.

== Create an environment

To create a new environment click the *Add a new environment* button.

image:hop-gui/environment/environment-add.svg[Environment]

This button opens the following dialogue:

image:hop-gui/environment/create-environment-dialogue.png[Create an environment,width="45%"]

.Environment Properties
[id="tab-env-props",cols="20%,45%,5%,5%,25%",options="header"]
|===
|Property|Description|Variables Supported|Mandatory|Default
|Name|The environment name|No|No|The last created project
|Purpose a|The purpose of this environment. A purpose is an indication of the environment type. You can add your own purposes in addition to the predefined ones:

* Development
* Testing
* Acceptance
* Production
* Continuous integration
* Common build
* ...|No|No|
|Project|The project to which this environment belongs|No|No|The last created project
|Configuration files|Files to use as configuration for this environment|No|No|
|===

Each environment will contain one or more environment files where you manage environment-specific variables.

The edit button opens the environment file and lets you add variable key-value pairs.

image::hop-gui/environment/environment-variables.png[Environment Variables, width="80%"]

After creating an environment the user interface will switch to it.


== Switch between projects and environments

To switch between projects the projects list can be used from the main Hop Gui toolbar.

image::hop-gui/environment/switch-project-list.png[Switch project]

After switching to a project the environments list will be updated to the environments which belong to this project.
All open files will be restored, including their zoom level and other UI settings.

image::hop-gui/environment/switch-environment-list.png[Switch environment]

== Edit and delete projects

To edit an existing project click the *Edit the selected project* button.

image:hop-gui/environment/project-edit.svg[Edit the selected project]

Clicking this button will re-open the project dialogue where changes can be made as described in <<tab-proj-props>>.

To delete a project click the *Delete the selected project* button.

image:hop-gui/environment/project-delete.svg[Delete the selected project]

== Editing and deleting environments

To edit an existing environment click the *Edit the selected environment* button.

image:hop-gui/environment/environment-edit.svg[Edit the selected environment]

Clicking this button will re-open the project dialogue where changes can be made as described in <<tab-env-props>>.

To delete an environment click the *Delete the selected environment* button.

image:hop-gui/environment/environment-delete.svg[Delete the selected environment]