Skip to content

chore: Add budget migration documentation #2056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nguyenky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Add budget migration documentation #2056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions products/extensions/b2b-suite-migration/concept/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The whole migration is executed in a message queue, allowing for scalable proces
## Key Features

- **Message Queue**: Utilizes a message queue to process large volumes of data, ensuring scalability.
- **Sequential Migration**: Components (e.g., Employee, Quote, Shopping List) are migrated sequentially to respect entity relationships (e.g., employee records before quotes).
- **Entity-Level Sequencing**: Within each component, entities (e.g., business partners, employees, roles) are migrated in the correct order.
- **Sequential Migration**: Components (e.g., Employee, Budget, Quote, Shopping List) are migrated sequentially to respect entity relationships (e.g., employee records before quotes).
- **Entity-Level Sequencing**: Within each component, entities (e.g., business partners, employees, roles, budgets) are migrated in the correct order.

::: info
Proper sequencing is critical to avoid dependency issues. Verify the migration order for your dataset.
Expand Down
2 changes: 1 addition & 1 deletion products/extensions/b2b-suite-migration/concept/technical-terms-and-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section defines key technical terms and concepts used in the migration proc

## Component

A **component** is a distinct module within the B2B Commercial system, such as `B2B Commercial Employee Management`, `B2B Commercial Quote Management`, or `B2B Commercial Shopping List`. Each component encapsulates a specific set of functionalities and associated data structures.
A **component** is a distinct module within the B2B Commercial system, such as `B2B Commercial Employee Management`, `B2B Commercial Budget Management`, `B2B Commercial Quote Management`, or `B2B Commercial Shopping List`. Each component encapsulates a specific set of functionalities and associated data structures.

:::info
Components organize related entities and their migrations, ensuring modularity and maintainability.
Expand Down
1 change: 1 addition & 0 deletions products/extensions/b2b-suite-migration/development/adding-component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ This section guides developers on adding a new component to the migration proces
```

The default priorities for existing configurator are:
- `BudgetManagementMigrationConfigurator` has a priority of `10000`.
- `EmployeeManagementMigrationConfigurator` has a priority of `9000`.
- `QuoteB2BMigrationConfigurator` has a priority of `8000`.
- `ShoppingListMigrationConfigurator` has a priority of `7000`.
Expand Down
9 changes: 8 additions & 1 deletion products/extensions/b2b-suite-migration/execution/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ If you are using B2B Commercial and already have data in it, you should back up

Ensure the message queue worker is running to process migration tasks.

## Extension version
## Extension Version

Ensure your B2B Suite version is `4.9.3` or above.

## Component Requirements

### Budget Management

- Requires B2B Commercial version `7.6.0` or above.
- Note: The Organization Unit of the budget will be empty after migration and needs to be manually assigned in B2B Commercial.
10 changes: 10 additions & 0 deletions products/extensions/b2b-suite-migration/execution/running-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@
This command utilizes the message queue system to process the migration in the background. Even after the command execution completes, the migration may still be ongoing. To monitor the migration status in real-time, run the `bin/console b2b:migrate:progress` command in a separate terminal window.
:::

## Component-Specific Notes

### Budget Management

::: warning
The Organization Unit of the budget will be empty after migration. This is expected behavior and you will need to manually assign budgets to organization units in B2B Commercial after the migration is complete.

Check warning on line 67 in products/extensions/b2b-suite-migration/execution/running-migration.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/extensions/b2b-suite-migration/execution/running-migration.md#L67 

Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: `, and`
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION
Raw output 
products/extensions/b2b-suite-migration/execution/running-migration.md:67:92: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
 Suggestions: `, and`
 URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
 Category: PUNCTUATION

**Note**: Budget Management feature is available from Commercial 7.6.0 and above.
:::

### Check Migration Status

This command provides real-time insights into the migration process, displaying progress and statistics in a table format.
Expand Down