User
Business Finder
Screen guide
Before you start
Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.
Open this feature
- Open /portal/business-finder on your site.
Steps
Use Apply filters
- Open /portal/business-finder on your application domain, using the workspace account for this task.
- Find the form containing Date range, From, To. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Apply filters. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Date range | Use the date/time picker. Check the date range and the timezone shown by your account or this screen. |
| From | Enter the from for this task, using the help or example shown by the form. |
| To | Enter the to for this task, using the help or example shown by the form. |
| Source | Enter the source for this task, using the help or example shown by the form. |
| Task | Enter the task for this task, using the help or example shown by the form. |
Use Start collection
- Open /portal/business-finder on your application domain, using the workspace account for this task.
- Find the form containing Task name, Business type, city, country — one per line, Maximum results per query. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Start collection. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Task name | Enter the task name for this task, using the help or example shown by the form. The form’s example is Cafés in our target cities. Replace it with your own value. Maximum 160 characters. |
| Business type, city, country — one per line | Required. Enter the business type, city, country — one per line for this task, using the help or example shown by the form. The form’s example is Coffee shops, Ho Chi Minh City, Vietnam Coffee shops, Da Nang, Vietnam Coffee shops, Hanoi, Vietnam. Replace it with your own value. |
| Maximum results per query | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. |
Use Save connections
- Open /portal/business-finder on your application domain, using the workspace account for this task.
- Find the form containing API key, Remove the saved API key, Enable for this workspace. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save connections. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| API key | Enter the value privately from your account or the service configuration. Do not use sample credentials from a guide. The form’s example is Paste a key, or leave blank to keep the saved key. Replace it with your own value. |
| Remove the saved API key | Enter the remove the saved api key for this task, using the help or example shown by the form. |
| Enable for this workspace | Enter the enable for this workspace for this task, using the help or example shown by the form. |
| Enable PHP HTTP scraper for this workspace | Enter the enable php http scraper for this workspace for this task, using the help or example shown by the form. |
Use Save changes
- Open /portal/business-finder on your application domain, using the workspace account for this task.
- Find the form containing Lead stage, Team notes, Archive this lead (can be restored). Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save changes. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Lead stage | Choose New, Qualified, Contacted, Not a fit. |
| Team notes | Enter the team notes for this task, using the help or example shown by the form. The form’s example is Add context for your team…. Replace it with your own value. Maximum 5000 characters. |
| Archive this lead (can be restored) | Enter the archive this lead (can be restored) for this task, using the help or example shown by the form. |
Fields and choices
Field descriptions appear beside each task above so that separate forms are not mixed together.
Check the result
- Stay in the same account/workspace and reopen the intended record or result screen.
- For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
- For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.
Common problems
| Problem | What to check |
|---|---|
| The screen or action is missing | Check the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint. |
| A field is rejected | Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice. |
| A list is empty | Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing. |
| A request is still pending | Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately. |
Technical reference
Role-scoped source references
Pinned commit: 1d0944d30f606782c9abf5b878224cdd3cd09b99
- modules/AppBusinessFinder/Http/Controllers/FinderController.php
- modules/AppBusinessFinder/Http/Controllers/FinderReportController.php
- modules/AppBusinessFinder/resources/views/reports.blade.php
- modules/AppBusinessFinder/resources/views/source.blade.php
- modules/AppBusinessFinder/resources/views/workspace-style.blade.php
- modules/AppBusinessFinder/resources/views/workspace.blade.php
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/business-finder |
| GET | /portal/business-finder/assets/{asset} |
| GET | /portal/business-finder/state |
| GET | /portal/business-finder/reports |
| GET | /portal/business-finder/reports/export |
| GET | /portal/business-finder/leads |
| GET | /portal/business-finder/export |
| POST | /portal/business-finder/runs |
| POST | /portal/business-finder/runs/{id}/cancel |
| PUT | /portal/business-finder/connections |
| PUT | /portal/business-finder/leads/{id} |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| title | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| mode | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| provider | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| queries | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| queries.* | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| locality | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| per_query | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| remove_key | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| self_hosted_enabled | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| php_http_enabled | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| stage | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| notes | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| archived | modules/AppBusinessFinder/Http/Controllers/FinderController.php |
| revision | modules/AppBusinessFinder/Http/Controllers/FinderController.php |