Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1194,6 +1194,7 @@ config
configComponent
configs
configurator
configurators
confirmUrl
const
const's
Expand Down
2 changes: 1 addition & 1 deletion products/extensions/b2b-suite-migration/concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ 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).
- **Sequential Migration**: Components (e.g., Employee, Budget, Quote, Shopping List) are migrated sequentially to respect entity relationships (e.g., employee records before budget).
- **Entity-Level Sequencing**: Within each component, entities (e.g., business partners, employees, roles) are migrated in the correct order.

::: info
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ This section guides developers on adding a new component to the migration proces
- `EmployeeManagementMigrationConfigurator` has a priority of `9000`.
- `QuoteB2BMigrationConfigurator` has a priority of `8000`.
- `ShoppingListMigrationConfigurator` has a priority of `7000`.
- `BudgetManagementMigrationConfigurator` has a priority of `5000`.
:::

## Create XML Mapping File
Expand Down
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.
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,43 @@

You could also specify which component to migrate. This is useful for testing or when you want to migrate specific components without affecting others. The name of the component should match the technical name defined in the [configurator](../concept/technical-terms-and-concepts.md#configurator).

```bash
bin/console b2b:migrate:commercial component_name_1 component_name_2
```
```bash
bin/console b2b:migrate:commercial component_name_1 component_name_2
```

**Example**: To migrate only the `shopping_list` and `quote_management` components:
**Example**: To migrate only the `shopping_list` and `quote_management` components:

```bash
bin/console b2b:migrate:commercial quote_management shopping_list
```
```bash
bin/console b2b:migrate:commercial quote_management shopping_list
```

**Note**: The `employee_management` component is a prerequisite for all other B2B components and is migrated first by default, regardless of the specified order. For instance, executing `bin/console b2b:migrate:commercial quote_management shopping_list` will migrate `employee_management` first, followed by `quote_management`, and then `shopping_list`. The order of components
listed in the command does not affect the migration sequence. The order of migration is determined by the priority of the configurators, which is defined in the service definition file. The configurator with the highest priority will be executed first.
**Note**: The `employee_management` component is a prerequisite for all other B2B components and is migrated first by default, regardless of the specified order. For instance, executing `bin/console b2b:migrate:commercial quote_management shopping_list` will migrate `employee_management` first, followed by `quote_management`, and then `shopping_list`. The order of components
listed in the command does not affect the migration sequence. The order of migration is determined by the priority of the configurators, which is defined in the service definition file. The configurator with the highest priority will be executed first.

#### 3. How to run the migration command with a specific batch size

To control the number of records processed in each batch, you can specify a batch size using the `--batch-size` option. This is useful for managing memory usage and performance during migration.

```bash
bin/console b2b:migrate:commercial --batch-size=100
```
```bash
bin/console b2b:migrate:commercial --batch-size=100
```

**Note**: Adjust the batch size according to your system's capabilities and the size of the data being migrated.
**Note**: Adjust the batch size according to your system's capabilities and the size of the data being migrated.

::: info
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 each budget 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