---
title: "Administration"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565569/Administration"
format: markdown
---
![Banner-Xray-Documentation-Enterprise.png](media://1364c210-e676-417a-af69-4a9c05eb1b87)


<details>
<summary>Table of Contents</summary>

> Macro (toc)
</details>

# Overview

Test Case Designer provides an administration area where administrators can manage your organization’s Test Case Designer instance and user permissions.

# Access and Navigation

> ⚠️ ### Administrator Profile
> ⚠️ 
> ⚠️ The initial assignment for at least one administrator is handled by our team. Please reach out to [the Xray Support team](https://jira.getxray.app/servicedesk/customer/portal/2) for more details.


> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> 
> > Macro (legacy-content)
> 
> 
> > ℹ️ You can navigate back to the main working space by clicking the Xray Test Case Designer logo (Figure 2 - 6) or by selecting the *Return to Xray Enterprise Designer* option from the account name dropdown.
> > ℹ️ 
> > ℹ️ The *Computations* column (Figure 2 - 7) stands for the number of [scenario](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565557) clicks that resulted in the fresh generation, not the retrieval of cached ones.

# Managing User Authentication Settings

From the *Organization Settings* (Figure 3 - 1), the *User Authentication Settings* screen (Figure 3) allows you to select the authentication method (Figure 4 - 1), by clicking *User Authentication Settings* (Figure 3 - 2).

![Figure 3 - Users](media://a04d4789-4cf1-475a-9319-3d526fd835b8)


Once you're finished, click *Update Organization* (Figure 4 - 1).

![Figure 4 - Authentication](media://48002f48-de4d-4ebc-9720-c47a6b0182ae)

# User Management

## Setting Permission Levels

There are two permission levels:

- *Edit* (Figure 3 - 4).
- *Read-only* (Figure 3 - 5).

They have separate limits from the licensing standpoint, which can be seen in the Organization Settings screen (Figure 3).

The following rules apply when dealing with the seat limit:

- New self-registered users default to the *Edit* level if the seats are available and to *Read-only* otherwise.
- When a customer administrator tries to register an edit-level user while the number of edit-level seats for the organization has been exhausted, the red tooltip will display, and clicking *Register User* will require confirmation for *Read-only* switch.
- Blocked users do not count towards seat limits.

Within license limits, you can set the permission level per user at *Edit Permissions* or for the whole organization using this checkbox column (Figure 5 - 1). 

- If the <span style="color: #008000">checked</span> the user has *Edit* permission.
- If <span style="color: #ff0000">unchecked</span> the user has *Read-only* permission.

(**Checked = Edit seat/Unchecked = Read-only seat**):

![Figure 5 - Permissions](media://c129d11d-55c2-48b8-a78c-ed90f3609cb5)


### Read-only Limitations

- Option to create a new model and export an existing one will be shown but disabled. Users will get a warning when trying to access them.
- [Parameters](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565547), [Rules](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565549), and [Scripts](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565563) will be available for review only and disabled for editing.
- Scenarios will be available for review for any pre-calculated strength but disabled for generating a new set.
- Commenting options (notes) will be available and fully functional.
- Sharing options will be disabled. From the perspective of inviting a read-only user to the project, they cannot be promoted to edit at the project level.

## Setting the Administrator Role

In the Actions column in the table, you can use the green icon (Figure 5 - 2) to designate someone else as the Admin (in which case they can perform all the actions at the Administration Panel) or revoke such privileges.

> ℹ️ This option is available **only for enabled and verified users.**

## Disabling/Enabling Users

The read icon (Figure 5 - 3) is for disabling users – either for the reason of license seat limitations, for them leaving the company, or for any other reason. You can choose to enable those users later – they will keep all their assets intact.

> ℹ️ The disabled users will be highlighted in red, the Admins in purple, and the regular users will have a white background.

## Managing Email Domains

You can edit the email domains associated with the access to your organization. 

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> 
> > Macro (legacy-content)

## Inviting a User

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> 
> > Macro (legacy-content)

# Managing Export Configurations

You can access the export configuration screen by clicking the *Customize* button (Figure 10 - 3).

![Figure 10 - Customize](media://886b8187-947a-4a38-b9bd-541c6ef436d5)


This screen (Figure 11) provides two main options/tabs:

## Export Configurations

Here (Figure 11 - 1) you can manage the export configurations.

![Figure 11 - Configuration](media://43d5fef1-21db-4e26-945b-8704b82c3560)


At this step, you just need to decide on the configuration name. You can update the default options to match your needs, but we generally recommend keeping them for reference purposes.  
You can have multiple configurations for the same target export if, e.g., teams have diverse options for relevant metadata columns.

Once you're done, click *Update* (Figure 11 - 2) to make the changes effective. You can also click *Delete* to remove the respective configuration (Figure 11 - 3).

## Export Fields

Here (Figure 12) you can manage the field configurations, their format, and potential values.

![Figure 12 - Fields](media://76fbcbc7-3d9f-4a8c-99ff-d6b413e9521f)

  
  
*Edit Export Fields for*** **(Figure 12 - 2)** **selects the Export Configuration to manage the fields.

The Script *Type* dropdown (Figure 12 - 1) allows you to select whether this configuration can apply only to Manual scripts, only to Automate, or to both.

Each field can be made mandatory or optional using the second column with the checkboxes (this will not affect the export of fields populated automatically). Finally, you can reorder fields using the indices in the first column (Figure 12 - 2).

There are three field types available (Figure 12 - 5):

- 
  - *Populated automatically* – depending on your scripting in Test Case Designer (Manual or Automate), certain core elements like Step Description or Gherkin Scenario Steps will be pulled from the source and will not be editable in the export dialog itself.
    - *Alternate Name* allows changing the displayed column name after export, which can make the mapping setup for Test management tools easier.
    - *Naming Convention* and *Example* for the Test Name can provide the template tooltip for syntax rules.
  - *Text* – a fairly standard string field that can be left blank or specified with the default value.
  - *Dropdown* – can handle the single selection with the options separated by commas (you can refer to the tooltips in the 4th column header for syntax guidance).

Once you're finished editing a field, click *Update* to make the changes effective (Figure 12 - 3).

You can add a new export field by clicking *Add* (Figure 12 - 4).

> ℹ️ **Xray API Sync**
> ℹ️ 
> ℹ️ The API Synchronization process between TCD and Xray leverages the same configurations as the manual Xray export. However, there is 1 difference - in order to use a Jira custom field in your TCD Sync configuration, you have to reference it by ID (e.g. "customfield_10050"), not the UI label. You can find the custom field ID in Jira settings or by exporting an issue that has it to e.g. XML.
> ℹ️ 
> ℹ️ The field type doesn't have to match - a field can be free text in Jira, but you may want to set it to "Drop Down" in TCD for more control.
> ℹ️ 
> ℹ️ Lastly, [Jira REST APIs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-bulk-post) have (at least) 3 types of handling for custom fields. Currently TCD Sync supports 2 ("no brackets", "square brackets"), but doesn't support the 3rd ("curly brackets"; except for Xray's Test Type). There is [an open suggestion](https://jira.getxray.app/browse/XRAYCLOUD-8461) for that 3rd Type in our backlog.
> ℹ️ 
> ℹ️ The workarounds are 1) manual export and mapping of the custom field columns; 2) API sync without that field, followed by the bulk Test issue update in Xray.


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).
</details>