Configuration and routes

This page lists everything you can configure in getodden/crm-sales, plus the routes, commands, and events it registers. For settings shared by every Odden package, such as the user model and Core's rate limits, see Configuration.

Publishing#

php artisan vendor:publish --tag=odden-sales-config      # config/odden-sales.php
php artisan vendor:publish --tag=odden-sales-migrations  # copies migrations into database/migrations

Migrations are loaded from the package automatically, so publishing them is only needed if you want to edit them. Published copies keep their filenames, so Laravel treats them as the same migrations and doesn't run them twice.

Config reference#

tables#

Table names for every sales model. Change them before running the migrations.

default_currency#

'default_currency' => env('ODDEN_DEFAULT_CURRENCY', 'USD'),

The package does not currently read this value. New deals, quotas, and quotes take their currency from the database column default (USD) or from what you pass. Generated quotes copy the deal's currency.

mail#

'mail' => [
    'mailer' => env('ODDEN_SALES_MAILER'),
    'connection' => env('ODDEN_SALES_QUEUE_CONNECTION'),
    'queue' => env('ODDEN_SALES_MAIL_QUEUE'),

    'from' => [
        'address' => env('ODDEN_SALES_FROM_ADDRESS'),
        'name' => env('ODDEN_SALES_FROM_NAME'),
    ],

    'sequences' => [
        'send_as_owner' => (bool) env('ODDEN_SALES_SEND_AS_OWNER', false),
    ],
],

Sales sends two kinds of email: sequence email steps (Odden\Sales\Mail\SequenceStepMail) and meeting confirmations (Odden\Sales\Mail\MeetingBookedMail). Both implement ShouldQueue and are dispatched after the surrounding database transaction commits, so nothing is sent during the web request or command. Run a queue worker (php artisan queue:work, adding --queue= if you set a queue name); with the sync queue connection, mail is sent immediately instead.

meetings#

'meetings' => [
    'default_working_hours' => [
        'monday' => ['09:00-17:00'],
        'tuesday' => ['09:00-17:00'],
        'wednesday' => ['09:00-17:00'],
        'thursday' => ['09:00-17:00'],
        'friday' => ['09:00-17:00'],
    ],

    'booking_window_days' => (int) env('ODDEN_SALES_BOOKING_WINDOW_DAYS', 60),
],

routes#

'routes' => [
    'enabled' => (bool) env('ODDEN_SALES_ROUTES_ENABLED', true),

    'web' => [
        'domain' => env('ODDEN_SALES_DOMAIN'),
        'prefix' => env('ODDEN_SALES_PREFIX', ''),
        'middleware' => ['web'],
    ],
],

Empty values are dropped, so a null domain or empty prefix applies no constraint.

ODDEN_SALES_DOMAIN=proposals.example.com
ODDEN_SALES_PREFIX=

Public routes#

These routes have no authentication; access is by quote token or meeting slug.

The two POST routes use the throttle:odden-public middleware. Core defines that limiter: odden-core.rate_limits.public requests per minute per IP, default 30 (ODDEN_PUBLIC_RATE_LIMIT).

If you set routes.enabled to false and register your own routes, keep the four route names. The package's views and controllers generate URLs and redirects with them.

Views#

Views are registered under the odden-sales namespace:

There is no publish tag for views. To override one, create a file with the same path under resources/views/vendor/odden-sales/ in your app.

Artisan commands#

Neither command takes arguments or options.

Scheduling#

The package does not add anything to the scheduler. Sequences don't advance and quotes don't expire until you schedule the commands, for example in routes/console.php:

use Illuminate\Support\Facades\Schedule;

Schedule::command('sales:process-cadences')->hourly();
Schedule::command('sales:expire-quotes')->daily();

Sequence steps are due by date, so running sales:process-cadences more than once a day only matters for picking up manual steps that reps have completed. Running it again never sends the same email step twice.

Sequence emails and meeting confirmations are queued, so a queue worker must also be running for them to be delivered. See mail.

Events#

Properties and timing are described in Deals. The package registers no listeners for them.

Side effects at a glance#

The only mail Sales sends is sequence email steps and meeting confirmations, and both are queued (see mail). These are the writes that happen in the background of a call: