> For the complete documentation index, see [llms.txt](https://help.bioinsight.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.bioinsight.illumina.com/connected-analytics/web-ui-access/h-projects.md). # Projects ## Project workspace Select a project from **Platform Core Home** to open its project workspace. The project workspace provides access to the data, analyses, tools, and other resources associated with the selected project. The **navigation bar** (1) will auto-collapse on smaller screens. When collapsed, use the >> symbol to expand it. The **breadcrumb menu** (2) is used to return to the projects overview.
{% hint style="info" %} There is a combined limit of 30,000 projects and bundles per tenant. {% endhint %} ## Create new Project To create a new project, click the **Projects > + Create** button from the main level.
On the project creation screen, add information to create a project. See [Project Details](/connected-analytics/project-web-ui/p-details.md) page for information about each field. Required fields include: * **Name** * 1-255 characters * Must begin with a letter * Characters are limited to alphanumerics, hyphens, underscores, and spaces * **Project Owner** Owner (and usually contact person) of the project. The project owner has the same rights as a project administrator, but can not be removed from a project without first assigning another project owner. This can be done by the current project owner, the tenant administrator or a project administrator of the current project. Reassignment is done at **Projects > your\_project > Project Settings > Team > Edit**. * **Region** Select your project location. Options available are based on Entitlement(s) associated with your subscription. * **Analysis Priority** (Low/Medium(default)/High) This is balanced per tenant with high priority analyses started first and the system progressing to the next lower priority once all higher priority analyses are running. Balance your priorities so that lower priority projects do not remain waiting for resources indefinitely. * **Billing Mode** This determine who pays for the project costs (compute and storage) When set to **project**, the tenant of the **project owner will be charged** for compute and storage. When set to **tenant**, the tenant of the **user who started the analysis will be charged** for compute and storage. * **Data Sharing** Enable this if you want to allow the **data from this project to be linked, moved or copied** and used in other projects of your tenant. Disabling this is a convenient way to prevent your data from showing up in the list of available data to be linked, moved or copied in other projects. *Even though this prevents copying and linking files and folders, it does not protect against someone downloading the files or copying the contents of your files from the viewer.* * **Manage your own storage** is used for those projects where you want to use your own storage instead of the Illumina-provided S3 cloud storage.
Click the **Save** button to finish creating the project. The project will be visible from the Projects view. {% hint style="info" %} You may see projects with an additional Information field, this is for backwards compatibility as the field has been superseded by the Short description field. {% endhint %} ## Create with Storage Configuration Refer to the [Storage Configuration](/connected-analytics/web-ui-access/h-storage.md) documentation for details on creating a storage configuration. During project creation, select the *I want to manage my own storage* checkbox to use a Storage Configuration as the data provider for the project. With a storage configuration set, a project will have a 2-way sync with the external cloud storage provider: any data added directly to the external storage will be synchronized into the Platform Core project data, and any data added to the project will be synchronized into the external cloud storage. If there is an issue with your storage configuration, it will be indicated on the project tile.
## Managing Projects Several tools are available to assist you with keeping an overview of your projects. These filters work in both list and tile view and persist across sessions.
1. **Searching** is a case-insensitive wildcard filter. Any project which contains the characters will be shown. Use \* as wildcard in searches. Be aware that operators without search words are blocked and will result in *Unexpected error occurred when searching for projects*. You can use the brackets, AND, OR and NOT operators, provided that you do not start the search with them (*Monkey AND Banana* is allowed, *AND Aardvark* by itself is invalid syntax). The search string length is limited to 250 characters. 2. **Filter by Workgroup** : Projects in Platform Core can be accessible for different [workgroups](/connected-analytics/project-web-ui/p-team.md). This drop-down list allows you to filter projects for specific workgroups. To reset the filter so it displays projects from all your workgroups, use the x on the right which appears when a workgroup is selected. 3. **Hidden projects** : You can hide projects (**Projects > your\_project > Project settings > Details > Hide**) which you no longer use. Hiding will **delete data in base and bench and will thus be irreversible**. For the API use endpoint `/api/projects/{projectId}:hide`. * You can still see hidden projects if you select this option and delete the data they contain at **Projects > your\_project > Data** to save on storage costs. * If you are using **your own S3** bucket, your S3 storage **will be unlinked from the project**, but the data will remain in your S3 storage. **Your S3 storage can then be used for other projects**. * Hiding projects is not possible for[ externally-managed](#externally-managed-projects) projects.
4. **Favorites** : By clicking on the star next to the project name in the tile view, you set a project as favorite. You can have multiple favorites and use the Favorites checkbox to only show those favorites. This prevents having too many projects visible. 5. **Tile view** shows a grid of projects. This view is best suited if you only have a few projects or have filtered them out by creating favorites. A single click will open the project. 6. **List view** shows a list of projects. This view allows you to add additional filters on properties such as name, description, location, user role, tenant, size and analyses. Click on the project name to open it. You can also **right-click** on projects in list view to open them in a new tab or add bookmarks. {% hint style="info" %} Items which are shown in list view have an **Export** option at the bottom of the screen. You can choose to support the entire page or only the selected rows in CSV, JSON or Excel format. {% endhint %} In **tile view**, your project tiles display | **Project name** and indication if the project is **favourited** () | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Location** | | **Tenant name** and indication if the project is actively **shared** other tenants () | | **Storage size** and **number of analyses** | | Your **role** | | The **description** (if provided) |
In **list view**, the star indicates your favourites while warnings, errors and information icons are displayed next to the project name. Hover over those icons to see the details.
If you are missing Projects If you are missing projects, especially those been created by other users, the workgroup filter might still be active. Clear the filter with the x to the right. You can verify the list of projects to which you have access with the [CLI command](/connected-analytics/cli-access/cli-indexcommands.md#icav2-projects) `icav2 projects list`.
#### API To see the storage metrics of available and archived files with the API, use the parameter includeStorageMetrics=true on the API endpoint `GET /api/projects/{projectId}`. {% code overflow="wrap" expandable="true" %} ``` # the requests library will allow you to make HTTP requests import requests # json will allow us to format and interpret the output import json # Replace with your actual generated API key here. headers = { 'X-API-Key': '', } params = { "includeStorageMetrics": "true" } # Replace with your actual project identifier here. Project_Identifier = "" url = "https://stage.v2.stratus.illumina.com/ica/rest/api/projects/"+(Project_Identifier)+"" response = requests.get(url, headers=headers, params=params) My_API_Data = response.json() #Print json data in readable format with indentation and sorting. print(json.dumps(My_API_Data, indent=3, sort_keys=True)) #response print("Response status code for Pipeline: ", response.status_code) ``` {% endcode %} ## Sharing You can share links to your project and content within projects to people who have [access](/connected-analytics/project-web-ui/p-team.md) to it. Sharing is done by copying the URL from your browser. This URL contains both the filters and the sort options which you have applied. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.bioinsight.illumina.com/connected-analytics/web-ui-access/h-projects.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.