Benefits of using custom fields
Adding custom fields as Arguments
Other customization options with custom fields
Overview
You can add custom fields during account configuration and use them with custom connectors, just like you would with email, username, domain, password, and other standard fields. You can define up to five custom fields with editable values, but their names remain fixed.
Benefits of using custom fields
Custom fields offer several practical advantages, especially when used with the Universal Web Connector:
- Enhanced customization: You can store extra information, like additional usernames or authentication tokens, making your setup more specific to your needs.
- Improved flexibility: Custom fields let you pass values in command lines, so you can easily adapt to different configurations without changing core settings.
- Streamlined testing: You can quickly adjust field values for testing. This makes your testing process more efficient and thorough.
- Seamless integration: Custom fields work well with custom connectors and Swagger, helping you manage extra data smoothly across different tools.
- Increased efficiency: Updating custom field values through Launchers and command lines reduces manual errors and saves time.
Setting custom field values
Custom field values can be set when creating a new account. To edit these values later, use the account editing form. Click the “pencil” icon in each row to open this form, which will display the fields with their current values pre-populated.
If any custom fields have been saved, the panel automatically expands to show their values. Custom fields can hold various types of values, including a single digit, random text, or an authentication token. They accept any string up to 1,024 characters in length.
To use saved custom field values with custom connectors, you need to update your Launchers. This ensures that the latest custom field values are correctly integrated and utilized.
- For more information on the Custom Connector, see the Custom Connector.
- To learn about the Launcher update and maintenance, see Launcher maintenance and updates.
Adding custom fields as Arguments
Once the Launchers are updated, you can include custom fields as arguments when starting a new custom connector process. For example, you might pass a custom field value like this:
CustomConnector.exe --custom1 "{custom1}"
Modifying command line values
You can also modify the command line to source values for username, email, domain, and other fields from custom fields instead of their dedicated fields. For example:
CustomConnector.exe --username "{username}" --password "{password}" --domain "{domain}"--resource "{resource}" --email "{email}"
Can be updated to:
CustomConnector.exe --username "{custom1}"--password "{custom2}" --domain "{custom3}" --resource "{custom4}" --email "{custom5}"
This flexibility allows you to use custom field values in various configurations and testing scenarios.
Other customization options with custom fields
In some cases, you might need to test with an additional username, password, or authentication token. Custom fields provide this additional level of customization.
Custom fields can also be added when creating accounts in Swagger (API v5 and v6). Since this is optional, the property can be set to null or omitted entirely.
Additional resources
- For the Launchers overview and best practices, see Launchers: Overview and best practices.
- For information on Connectors and connection configurations, see Connectors and connection configurations.
- To learn about the Universal Web Connector, see the Universal Web Connector.