You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/platform/feature-flags/targeting/custom-properties.md
+27-14Lines changed: 27 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,39 +99,52 @@ First, select your property to use it like any other targeting definition as out
99
99
100
100
Then, finish your Targeting Rule by filling out the comparator and the value fields.
101
101
102
-
There are no limits to the number of Properties that can be used to define a single Targeting Rule! Use as many custom properties as necessary to accurately target your users for your features.
102
+
There are no limits to the number of Properties that can be used to define a single Targeting Rule! Use as many custom properties as necessary to accurately target your users for your Features.
103
103
104
104
105
105
106
106
## SDK Usage
107
107
108
108
See the [Identify](/sdk/features#identifying-a-user-or-setting-properties) Documentation for the usage of properties within each SDK.
109
109
110
-
## Managing / Deleting Custom Properties
110
+
## Managing Custom Properties
111
111
112
-
To rename, modify, or edit the Custom Properties in a project, navigate to the Settings page and click on "Custom Properties"
112
+
To manage the Custom Properties in a project, navigate to the Settings page and click on "Custom Properties". This will display a list of Custom Properties that you've created for the project where you can filter by project or custom property type.
113
113
114
-
114
+
115
115
116
-
In this section, you will be able to see all custom properties in your organization, with the ability to filter by type and by project.
117
-
118
-
To make edits to a Custom Property, click "View Info" and you will be able to modify the name, keys, and description of a Custom Property
119
-
120
-
116
+
To make edits to a Custom Property, click into the Custom Property or "View Info". You can edit the Custom Property's attributes, setup a schema, gain insight into where it's being used, and delete the Custom Property on this page.
121
117
118
+
122
119
123
120
:::caution
124
121
125
122
If the **Property Key** is changed, any Identify calls or user objects which are using the previous key will no longer apply to this custom property.
126
123
124
+
If a Custom Property is **deleted** while in use in a Targeting Rule, the targeting rule will continue to function as normal.
125
+
This custom property will no longer be selectable for new targeting rule definitions.
126
+
127
127
:::
128
128
129
-
:::caution
129
+
### Custom Property Schemas
130
130
131
-
If a Custom Property is **Deleted** while in use in a Targeting Rule, the targeting rule will continue to function as normal.
132
-
This custom property will no longer be selectable for new targeting rule definitions.
131
+
Custom Property Schemas let you define allowable values for your Custom Properties when using them in Targeting Rules. Schemas ensure that only values that are acceptable are added to Targeting Rules, minimizing the risk of setting up a Feature or a Targeting Rule incorrectly.
133
132
134
-
:::
133
+
134
+
135
+
Custom Properties may only define Schemas as an `Enum` type (String or Number). Click on Add Value to set acceptables values for your Property. The "Label" is your readable name for the property while the "Value" is the value that you'll have to send via the SDK or API. You may allow users to add Additional Values when editing Targeting Rules, or limit them to only the values you've setup in the Schema.
136
+
137
+
Once Schemas are setup for your Custom Property, you'll be able to select it's values using a dropdown menu populated with your schema.
138
+
139
+
140
+
141
+
### Feature and Audience Usage
142
+
143
+
Feature Usage and Audience Usage displays where the Custom Property is actively being used. Adding a Custom Property in an Audience is very similar to using it within a Feature, you can find out how to create an Audience in our [Audiences](/platform/feature-flags/targeting/audiences) page.
144
+
145
+
Click on "View On Feature" or "View on Audience" to be brought to the Feature or Audience that you've selected.
146
+
147
+
135
148
136
149
## Common Use Cases for Custom Properties
137
150
@@ -141,6 +154,6 @@ You can target users in numerous ways using Custom Properties. The following lis
141
154
142
155
**Geographic Location**. DevCycle has a built-in “Country” property, but you can target other forms of location by creating Custom Properties such as `storeLocation``province``state``city``school` etc.
143
156
144
-
**Special Users**. Sometimes organizations want to release a feature to special users only, such as users with a paid membership, those with a free trial, or those who have made large contributions to the company. In this case, some property name suggestions are `accountType``pricingPlan``isSubscriber``isTrialUser``amountContributed` etc.
157
+
**Special Users**. Sometimes organizations want to release a Feature to special users only, such as users with a paid membership, those with a free trial, or those who have made large contributions to the company. In this case, some property name suggestions are `accountType``pricingPlan``isSubscriber``isTrialUser``amountContributed` etc.
145
158
146
159
**User Behaviour or Preferences.** You can experiment on users based on their behaviour or preferences. Some examples include `numberOfPageVisits``gaveConsent``preferredColor` etc.
0 commit comments