Example

End-user documentation

Example

A reference CRUD module used to demonstrate ERPat module structure, forms, lists, permissions, routes, and migrations.

Purpose and What Problem This Solves

The Example module is a safe training and reference area. It helps teams learn how a standard ERPat module behaves before they work on business-critical modules.

Who normally uses this module

What You Can Do Here

• Practice creating, editing, viewing, and deleting records in a simple CRUD screen.
• Validate that module routes, menu entries, permissions, and modal forms work after setup.
• Demonstrate appTable list behavior, filters, and action buttons.
• Train new users on ERPat patterns without touching production data.
• Serve as a baseline when comparing a custom module to the scaffolded standard.

Core Concepts and Terms

Learn these words first. Most user mistakes happen when a beginner opens a form without knowing what the record represents.

Beginner Quick Start

Use this first-run path in a training database or with a supervised account before handling live records.

1. Enable the module in Settings > Manage Modules.
2. Grant the Example permission to a training user or use an admin account.
3. Open the Example menu and create one sample record.
4. Edit, view, and delete the sample record to understand the lifecycle.
5. Compare the behavior with other modules that use similar list and modal patterns.

Standard Operating Procedures

These SOPs describe the routine operating pattern. Your company policy may add approvals, attachments, or segregation-of-duties controls.

Practice a standard record lifecycle

1. Open the Example list and click the add action.
2. Fill required fields with clear sample values.
3. Save, verify the row appears, then open the view action.
4. Edit the row, save again, and delete it when the exercise is complete.

Use Example for QA smoke testing

1. Confirm the module appears only when enabled.
2. Confirm list load, create, update, view, and delete actions work.
3. Confirm a non-permitted user cannot perform restricted actions.
4. Record unexpected modal, route, or language behavior for development review.

Teach ERPat screen conventions

1. Show the left menu, list table, toolbar action, modal form, save flow, and row actions.
2. Explain required fields, validation messages, and soft delete behavior.
3. Let learners repeat the process until the UI pattern feels familiar.
4. Move learners to a real module only after the pattern is understood.

Industry Notes and Good Practice

• Use Example as a sandbox, not as a business process.
• The patterns here are intentionally plain so beginners can learn ERPat conventions quickly.
• When a real module differs from Example, the difference usually reflects domain rules, approvals, or integrations.

Controls, Data Quality, and Review Checklist

Use this checklist during onboarding, monthly review, and process audits.

• Training data is clearly labelled and removed after exercises.
• Permissions are tested with non-admin users when learning role behavior.
• QA notes separate scaffold behavior from module-specific business behavior.
• No operational decision depends on Example records.

Related ERPat areas

FAQ and Troubleshooting

Is Example required for operations?

No. It is a reference and training module.

Why does it look simpler than other modules?

It demonstrates the standard CRUD pattern without complex business rules.

Can I delete sample records?

Yes. Example data should be disposable unless your team is using it for a test case.

Should users learn Example first?

It is helpful for beginners because the workflow is small and low risk.

ERPat Example user guide. This static HTML page is documentation-only and does not change module routing, permissions, or runtime behavior.