Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bc9df05

Browse files
committed
custom fields
1 parent 387be67 commit bc9df05

File tree

4 files changed

+85
-0
lines changed

4 files changed

+85
-0
lines changed

docs/programs/custom-fields.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "Custom Fields"
3+
path: "/programs/custom-fields.html"
4+
id: "programs/custom-fields"
5+
---
6+
7+
Program administrators can configure custom fields to add data to their reports. This enables your program members to add additional information to your reports to help you better track and manage your internal data by the categories that you define to be important, such as by business unit or by root cause analysis.
8+
9+
> <b>Note:</b> This feature is currently in beta and is only available for select programs. You must be an enterprise program to opt-in to the feature. If you’re an enterprise program and would like to opt-in to the feature, please contact your program manager.
10+
11+
In this article, you can learn to:
12+
* [Create a Custom Field](#create)
13+
* [Fill in a Value for a Custom Field](#fill)
14+
* [Edit a Custom Field](#edit)
15+
* [Archive a Custom Field](#archive)
16+
17+
<h3 id="create">Create a Custom Field</h3>
18+
19+
> **Note:** You must be an administrator of the program in order to add a custom field.
20+
21+
To create a custom field:
22+
1. Go to **Program > Customization > Custom Fields**.
23+
2. Click **New Custom Field**.
24+
3. Enter the **Field Title** on the **Create Custom Field** page.
25+
4. Select the **Field Type**. You can choose from:
26+
27+
Option | Details
28+
------ | --------
29+
Text | This option enables you to create an editable text field.<br><br>![creating a text type custom field](./images/custom-fields-2.png)
30+
List | This option enables you to create a drop-down list that you can select from when editing your custom field.<br><br>Enter your option items in the **Configuration List** field separated by a comma.<br><br>![creating a list type custom field](./images/custom-fields-3.png)
31+
32+
5. Click **Save**.
33+
34+
All of your reports will now have a Custom Fields section. You can edit the section to add the Custom Field label you created.
35+
36+
![Custom Fields section on the report](./images/custom-fields-4.png)
37+
38+
The custom field will also be added into your inbox filter so that you can filter your reports by the custom field you created. (The image below shows the filter 2 custom fields that were created: Squad and Root Cause Analysis)
39+
40+
![Custom fields inbox filter](./images/custom-fields-5.png)
41+
42+
<h3 id="fill">Fill in a Value for a Custom Field</h3>
43+
To fill in a value for a Custom Field to your report:
44+
1. Go the report you want to add a custom field to.
45+
2. Click **Edit** in the Custom Fields section.
46+
47+
![edit button in the custom fields section](./images/custom-fields-4.png)
48+
49+
3. Enter the information you want to add to the field for each field label.
50+
4. Click **Save and add fields**.
51+
52+
The information you input will now be tied to your field labels. To edit the information, click **Edit**.
53+
54+
![what custom fields looks like in the report](./images/custom-fields-6.png)
55+
56+
When you export your reports as a CSV file, the custom field and the information associated will also be included in the export.
57+
58+
![custom fields in the exported report](./images/custom-fields-7.png)
59+
60+
<h3 id="edit">Edit a Custom Field</h3>
61+
You can edit your custom fields to change the name of the field title.
62+
63+
![custom fields list](./images/custom-fields-9.png)
64+
65+
To edit the title of a custom field:
66+
1. Go to **Program > Customization > Custom Fields**.
67+
2. Click **Edit** for the custom field label you want to edit.
68+
3. Enter the new title.
69+
4. (*Optional*) Change the **Field Type** from *Text* to *List*. You can only change the field type from *Text* to *List*. You can’t change a *List type* to a *Text type*.
70+
5. Click **Save**.
71+
72+
<h3 id="archive">Archive Custom Fields</h3>
73+
You can archive custom fields that you no longer want to use. We don’t enable you to permanently delete custom fields to prevent data loss.
74+
75+
![unarchive custom fields](./images/custom-fields-8.png)
76+
77+
To archive a custom field:
78+
1. Go to **Program > Customization > Custom Fields**.
79+
2. Click **Archive**.
80+
81+
The archived field can no longer be added to new reports. Current and past reports with the archived field will remain on the report and won’t disappear. You can, however, edit the field within the report.
82+
83+
You can unarchive an archived custom field by clicking **Unarchive**.
61.7 KB
Loading

src/pages/programs/programs-nav.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@
125125
path: /programs/response-labels.html
126126
- title: Keyboard Shortcuts
127127
path: /programs/keyboard-shortcuts.html
128+
- title: Custom Fields
129+
path: /programs/custom-fields.html
128130
- title: Disclosure
129131
path: /programs/disclosure.html
130132
items:

0 commit comments

Comments
 (0)