Skip to content

Commit ba602a8

Browse files
feat: Add a guide on how to create custom fields (#310)
* feat: add a guide on how to create a custom field * chore: update references to creating custom fields in other parts of guides * Update pages/discover/custom_fields.md
1 parent c63638d commit ba602a8

File tree

7 files changed

+56
-3
lines changed

7 files changed

+56
-3
lines changed

images/custom_field_menu_item.png

480 KB
Loading

images/custom_fields_example.png

596 KB
Loading
491 KB
Loading

images/import_custom_fields.png

341 KB
Loading

pages/assess/create_interview_questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Our interview questions are tightly coupled with our application fields. So, bef
3535

3636
### Create a custom field
3737

38-
You can create a custom field for an application by going to https://[your workspace].tidal.cloud/fields/applications and clicking on the 'New Application Field' button. Note: we don't limit the type of field (dropdown, text, number, currency, checkbox) that can be used in interview questions.
38+
You can create a [custom field](./custom_fields.html) for an application by going to https://[your workspace].tidal.cloud/fields/applications and clicking on the 'New Application Field' button. Note: we don't limit the type of field (dropdown, text, number, currency, checkbox) that can be used in interview questions.
3939

4040
### Get a custom field id
4141

pages/discover/custom_fields.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Creating Custom Fields
3+
layout: pages
4+
parent: Discover
5+
keywords: custom fields, field types, applications, servers, database instances, settings
6+
last_updated: February, 2026
7+
summary: "Learn how to create custom fields in Tidal Accelerator to enhance your data analysis."
8+
sidebar: main_sidebar
9+
folder: userguides
10+
permalink: custom_fields.html
11+
---
12+
13+
Tidal Accelerator enables you to capture unique business data across your portfolio by adding custom fields to any record, including servers, applications, and database instances. These custom data points allow you to track the specific metrics your organization needs to make informed migration decisions.
14+
15+
## Creating Custom Fields for your Application, Server, or Database Instances
16+
17+
To create a custom field, navigate to the **Settings** menu and select the **Fields** section.
18+
19+
{% include image.html file="custom_fields_menu_item.png" %}
20+
21+
Click the **New** button.
22+
23+
{% include image.html file="custom_fields_new_button.png" %}
24+
25+
In the form, fill in the required information for your custom field.
26+
27+
{: .note }
28+
Required information is denoted by a red asterisk (*) next to the field label. Typically, the field name, internal name, and field type are required.
29+
30+
{% include image.html file="custom_fields_example.png" %}
31+
32+
Once you have filled in the information, click **Submit** to create the custom field.
33+
34+
### Field Record Attributes
35+
36+
When configuring a field record, the following attributes define how the field functions and appears within the application:
37+
38+
* **Name**: The display label for the field as seen by users in forms and tables.
39+
* **Internal Name**: A unique, machine-readable identifier used by the API. This is typically auto-generated based on the Name but can be customized.
40+
* **Hint**: A brief instruction or tip that appears in the interface to guide users when entering data into this field.
41+
* **Definition**: A detailed description of the field's purpose, ensuring that all users understand the specific data required.
42+
* **Category**: The logical group to which the field belongs. This controls where an item is laid out on the application, server, or database instance views.
43+
The options are:
44+
- Service Management
45+
- Technology Stack
46+
- Source Code Readiness
47+
- Financial
48+
- Transition Planning
49+
- Other
50+
* **Field Type**: Determines the format of data permitted in the field, such as text, numbers, dates, or dropdown selections.
51+
* **Units**: *For numeric fields only.* Specifies the unit of measurement associated with the value.
52+
* **Aggregation**: Defines how the field values are summarized in table views, such as calculating a sum, average, or median.

pages/discover/importing_from_excel.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ You can always update a dependency after importing too.
3636

3737
You should have one sheet or file per type of record.
3838

39+
{: .tip }
3940
There are several default columns values included for each record type,
40-
however if you have additional information on your inventory that would like to include, you can create custom fields for a record (Check step 3).
41+
however if you have additional information on your inventory that would like to include, you can [create custom fields](./custom_fields.html) for a record (Check step 3).
4142
Remember to add those fields before importing the data.
43+
{% include image.html file="import_custom_fields.png" %}
4244

4345
## How to import your data
4446

@@ -59,7 +61,6 @@ Remember to add those fields before importing the data.
5961
{: .tip }
6062
The Tags option can be used to generate multiple tags and associate them with the record. You can use this to track any type of categorical data. Additionally you can search and filter for records based on tags. Multiple tags can be associated based on one column of data, they are parsed and split on any commas (,)
6163

62-
6364
### Importing Servers
6465

6566
When importing servers, the only required field is 'Host Name'. The Host Name is the name that your server is identified with throughout Accelerator.

0 commit comments

Comments
 (0)