Managing user properties
Last updated
Was this helpful?
Last updated
Was this helpful?
As an application administrator at both the app store and application levels, you can learn how to add and delete user properties.
This powerful new capability allows application administrators to create and delete custom user properties, enhancing the flexibility and personalization of your data visualization experience. Whether you're managing user-specific settings, handling complex user credentials, or tailoring application behavior, User Properties Management offers a robust solution.
Key Features
Custom User Properties: Administrators can create custom attributes for users beyond the built-in properties (name, roles, groups, and privileges). These properties can be of various types:
Array: For lists or collections of values.
String: For text-based information.
Integer: For numeric values.
Boolean: For true/false settings.
Object: For structured data.
Secret Attributes: In addition to classic attributes, administrators can create secret attributes. These are not visible at the application level but can be used internally to manage sensitive information like credentials for database connections.
Variable Management Hub: This hub allows you to leverage the custom attributes to variabilize different levels of your application, ensuring a tailored experience for each user.
Using the User Properties Management Feature
Accessing the User Management Interface
Log in to your application: Navigate to the administration section of your instance.
User Management: Select 'Users' from the main menu to access the User Properties Management interface.
Creating Custom Attributes
Navigate to User Properties: Within the Users space, find the 'Properties' tab.
Add New Property: Click the 'Add New Property' button.
Configure the Property:
Privacy: Choose 'Attribute' for visible attributes or 'Secret' for hidden ones.
Name: Provide a name for the property.
Data Type: Select the appropriate type (Array, String, Integer, Boolean, Object).
Save: Click 'Create' to create the property.
Deleting Custom Attributes
Navigate to User Properties: Access the 'Properties' tab within Users space.
Select Property: Choose the attribute you wish to delete.
Delete: Click the 'Delete' button and confirm the action.
Utilizing Custom Attributes
Custom attributes can be reused in your applications to customize and variabilize user experiences. For instance, you can:
Tailor user interfaces based on user-specific settings stored in custom attributes.
Use secret attributes to securely manage database connection credentials without exposing them at the application level.
More information in the documentation below
Best Practices
Security: Utilize secret attributes for any sensitive information to ensure it remains protected.
Naming Conventions: Use clear and consistent naming for attributes to avoid confusion and ensure easy management.
Documentation: Keep a record of all custom attributes and their intended use to maintain clarity within your team.
Step 1: Update Your Instance Settings
This is the most delicate step in the process. You’ll need to modify your instance settings file using your preferred code editor to define a user_attributes_schema object.
In the example below, we are adding two custom attributes: city and country. To do this, add a user_attributes_schema section in your instance settings file, structured as follows:
You can access the instance settings file via the Settings menu in your instance.
Step 2: Prepare Your Users
Once your schema is defined, you’ll need to prepare your users accordingly. Go to the /users page to begin.
1. Download and Edit the Bulk Upload Template
Download the CSV template from the interface.
Open it using your preferred spreadsheet tool (e.g., Excel, Google Sheets).
2. Add Your Attributes
To include custom attributes like city and country, simply add new columns to the CSV.
Column headers should follow this format: attribute city, attribute country
Fill in the corresponding values for each user.
Take care ! The prefix should be attribute with a space at the end.
3. Upload Your File
Once your file is ready:
Drag and drop it onto the bulk user creation interface.
You’re all set! Your users will now include the custom attributes defined in your instance settings.
Conclusion
The User Properties Management feature is designed to offer unparalleled flexibility and security in managing user-specific settings and credentials within Toucan. By leveraging custom and secret attributes, you can enhance your data visualization applications, providing a more personalized and secure experience for your users.
For further assistance or questions, please contact our support team.
