Before you can start importing data automatically, you need to create an automated import configuration that defines how your data should be processed.Documentation Index
Fetch the complete documentation index at: https://help.broadstripes.com/llms.txt
Use this file to discover all available pages before exploring further.
Creating Your Configuration
Accessing the Configuration Page
- Open the Settings dropdown in the upper right corner of the Broadstripes screen
- Scroll to and select “Automated import configurations”
- On the configuration page, click “New Configuration”
Configuration Options
When creating your configuration, you can choose from the following settings:Basic Settings
- Type: Choose between “General CSV” or “General ZIP”
- User account: Select the user that the imports will be associated with
- Active: Check to indicate the configuration is active and ready to receive data
Data Processing Rules
-
What should we do with records that don’t match?
- Add: Create new records for unmatched data
- Skip: Ignore unmatched records
-
New employment at same employer as existing employment should:
- Update: Replace existing employment information
- Append: Add new employment while keeping existing
-
When importing addresses, phones or emails:
- Append: Add new items alongside existing contact information
- Replace: Replace all existing contact information with imported data
Getting Your Authorization Token
After saving your configuration, you’ll be able to:- View the generated authorization token
- Copy it to your clipboard for use in API calls
Testing Your Import Configuration
Manual Testing Process
The best way to test your automation is to run a manual import that mirrors your automated setup:-
Upload Test Data
- Create a test CSV file with a few rows of dummy data
- Use the same headers you plan to use in your automation
- Keep the dataset small for quick testing
-
Use Default Mappings
- Don’t change any field mappings from the defaults
- This is crucial because automated imports can’t customize mappings
-
Match Configuration Settings
- Set the options in the “Configuration” panel to match your automated import configuration exactly
- This ensures the test mirrors production behavior
-
Run the Test
- Click “Preview” to see how your data will be processed
- When the preview looks correct, click “Schedule import”
- Review the completed import results
-
Validate Results
- The manual import results should mirror what will happen with automation
- Check that records are created/updated as expected
- Verify that data mapping worked correctly
What to Look For
During testing, pay attention to:- Field Mapping: Do your CSV headers map correctly to Broadstripes fields?
- Data Quality: Are values being imported into the correct fields?
- Matching Logic: Are existing records being updated or new ones created as expected?
- Employment Handling: Is employment information being processed correctly?
- Contact Information: Are addresses, phones, and emails being handled as configured?
Monitoring Your Imports
Viewing Import History
Project admins can monitor automated imports on the project’s Automated Imports page:- Import status and completion times
- Number of records processed
- Any errors or warnings that occurred
- Links to detailed import results
Import Status Indicators
- Scheduled: Import is queued for processing
- Processing: Import is currently running
- Completed: Import finished successfully
- Failed: Import encountered errors
Best Practices
- Start Small: Test with small datasets before scaling up
- Monitor Regularly: Check the automated imports page for any issues
- Keep Configurations Simple: Use clear, consistent field naming
- Document Your Setup: Keep notes about your configuration choices
- Regular Testing: Periodically test your automation to ensure it’s working correctly
Next Steps
Once your configuration is set up and tested:- Review the API specifications for technical implementation details
- Begin sending data to your automation endpoint
- Monitor imports regularly to ensure continued success