Guides
Welcome to the ExMeX Framework Guides section. Here you'll find step-by-step instructions to help you accomplish specific tasks and operations within the ExMeX Framework.
What Are Guides?
Guides are procedural, task-oriented documentation that walk you through specific processes from start to finish. Each guide follows a clear, linear structure designed to help you successfully complete a particular task.
Guide Characteristics
Guides are:
- Task-focused: Each guide addresses one specific goal or operation
- Step-by-step: Clear, numbered instructions that lead you from start to finish
- Prescriptive: Shows you the recommended way to accomplish the task
- Linear: Follow the steps in order to achieve the desired outcome
- Result-oriented: Ends with a clear, expected result
When to Use Guides
Use guides when you need to:
- Perform a specific operation for the first time
- Follow a proven procedure to accomplish a task
- Ensure you're following the correct sequence of steps
- Understand prerequisites and expected outcomes
- Get immediate, actionable instructions
Available Guides
Our guides are organized by topic and functionality. Browse the sidebar to find guides for:
Framework Installation & Maintenance
- Installing the ExMeX Framework
- Upgrading to a new version
- Rolling back a release
- Backup and restore procedures
Module Management
- Registering modules
- Configuring module settings
- Managing load windows
- Module orchestration
Archiving Framework
- Setting up data object archiving
- Executing archiving processes
- Managing retention policies
Data Operations
- Working with metadata
- Configuring data flows
- Managing data objects
Guide Structure
Each guide typically includes:
- Purpose: What you'll accomplish
- Prerequisites: What you need before starting
- Steps: Numbered instructions with code examples
- Verification: How to confirm success
- Troubleshooting: Common issues and solutions
- Next Steps: Related tasks or guides
Example Guide Format
Here's what you can expect from a typical guide:
# How to Register a Module
## Purpose
This guide shows you how to register a new module in the ExMeX Framework.
## Prerequisites
- ExMeX Framework installed
- Database access with appropriate permissions
- Module metadata available
## Steps
### Step 1: Prepare Module Information
Gather the required information...
### Step 2: Execute Registration
Run the following command...
### Step 3: Verify Registration
Check that the module is registered...
## Verification
You should see...
## Troubleshooting
If you encounter...
## Next Steps
- Configure module settings
- Set up load windows
Guides vs. Best Practices
Understanding the difference helps you find the right documentation:
| Guides | Best Practices |
|---|---|
| How to do something | What to consider when doing it |
| Step-by-step instructions | Recommendations and guidelines |
| Single correct path | Multiple approaches and options |
| Immediate task completion | Long-term optimization |
| "Follow these steps" | "Consider these factors" |
Example:
- Guide: How to Register a Data Object for Archiving → Follow steps 1-5
- Best Practice: Archiving Configuration Strategies → Consider retention periods, performance impact, scheduling options
Getting Started
- Browse the sidebar to see all available guides
- Search using the search bar if you know what you're looking for
- Start with basics if you're new to the ExMeX Framework
- Follow sequentially when learning a new feature area
Contributing
Found an issue or have a suggestion for improving a guide? Please contact the ExMeX Framework team or submit feedback through your organization's channels. docusaurus
Additional Resources
- Best Practices: Recommendations for optimal framework usage
- Core Reference: Technical reference documentation
- Release Notes: Latest framework updates and changes
Need help? If you can't find a guide for your specific task, check the Best Practices section or consult the technical reference documentation.