Financial Close Setup Wizard - Admin Guide

​

Overview

​

Architecture

​

Components

​

Database Template

• Module: fa
• Wizard Type: setup
• 6 steps (2 form-based, 4 custom components)

​

Permission Requirements

​

Configuration

​

Wizard Settings

​

Checklist Templates

1. Navigate to FA → Close Management → Checklist Templates
2. Create a template with is_template = true
3. Add tasks to the template with categories:
   • reconciliation
   • reporting
   • review
   • approval

​

Draft Persistence

• Storage: Local storage with localforage
• Key: fa-setup-wizard-draft-{organizationId}
• Auto-save: Every 30 seconds
• Expiration: 30 days

​

Clearing Drafts

1. Completing the wizard
2. Starting a new wizard session and not saving

​

Event Publishing

{
  event_type: 'close_period_started',
  organization_id: string,
  user_id: string,
  close_period_id: string,
  tasks_count: number,
  assignments_count: number,
  timestamp: string (ISO 8601),
}

​

Customization (Future)

• Step order and visibility
• Required vs optional fields
• Custom validation rules
• Additional form fields
• Step skip conditions

​

Monitoring

​

Wizard Usage

-- Recent wizard completions
SELECT 
  organization_id,
  user_id,
  created_at,
  custom_fields->>'tasks_count' as tasks_count
FROM pf_audit_logs
WHERE module = 'fa' 
  AND action = 'close_period_setup'
ORDER BY created_at DESC
LIMIT 100;

​

Draft Statistics

-- Active drafts by organization
SELECT 
  organization_id,
  COUNT(*) as draft_count,
  MAX(updated_at) as last_activity
FROM pf_wizard_drafts
WHERE module = 'fa' AND wizard_type = 'setup'
GROUP BY organization_id;

​

Troubleshooting

​

Wizard Template Not Loading

1. Verify the template exists:

SELECT * FROM pf_wizard_templates 
WHERE module = 'fa' AND wizard_type = 'setup' AND is_active = true;

2. Check the migration ran successfully
3. Verify is_active = true

​

Custom Steps Not Rendering

1. Verify step registration in registerFAWizardSteps.ts
2. Check browser console for import errors
3. Verify component IDs match template configuration

​

Event Publishing Failures

​

Performance Considerations

• Task Batch Size: For templates with 50+ tasks, consider pagination in review step
• User Fetching: Uses staleTime: 5min to reduce API calls
• Draft Auto-save: 30-second interval prevents excessive storage writes

​

Security

• All database operations include organization_id filter (defense-in-depth)
• RLS policies enforce tenant isolation
• User assignments validated against organization membership
• No PHI/PII exposed in wizard data

​

Related Documentation

• Financial Close Setup Wizard User Guide
• Financial Close Management Guide
• PF-41 Configurable Module Wizards