Skip to content

Commit

Permalink
#184 deprecation of XbKConnectionString - md file update
Browse files Browse the repository at this point in the history
  • Loading branch information
@tkrch
tkrch committed Jul 14, 2024
1 parent b318df1 commit d69d071
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 18 deletions.
32 changes: 15 additions & 17 deletions Migration.Toolkit.CLI/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -312,24 +312,23 @@ Before you run the migration, configure options in the `Migration.Toolkit.CLI/ap

Add the options under the `Settings` section in the configuration file.

| Configuration | Description |
|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| KxConnectionString | The connection string to the source Kentico Xperience 13 database. |
| KxCmsDirPath | The absolute file system path of the **CMS** folder in the source Kentico Xperience 13 administration project. Required to migrate media library files. |
| XbKConnectionString | The connection string to the target Xperience by Kentico database. |
| XbKDirPath | The absolute file system path of the root of the target Xperience by Kentico project. Required to migrate media library and page attachment files. |
| XbKApiSettings | Configuration options set for the API when creating migrated objects in the target application.<br /><br />The `ConnectionStrings.CMSConnectionString`option is required - set the connection string to the target Xperience by Kentico database (the same value as `XbKConnectionString`). |
| MigrationProtocolPath | The absolute file system path of the location where the [migration protocol file](./MIGRATION_PROTOCOL_REFERENCE.md) is generated.<br /><br />For example: `"C:\\Logs\\Migration.Toolkit.Protocol.log"` |
| MigrateOnlyMediaFileInfo | If set to `true`, only the database representations of media files are migrated, without the files in the media folder in the project's file system. For example, enable this option if your media library files are mapped to a shared directory or Cloud storage.<br /><br />If `false`, media files are migrated based on the `KxCmsDirPath` location. |
| Configuration | Description |
|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| KxConnectionString | The connection string to the source Kentico Xperience 13 database. |
| KxCmsDirPath | The absolute file system path of the **CMS** folder in the source Kentico Xperience 13 administration project. Required to migrate media library files. |
| XbKDirPath | The absolute file system path of the root of the target Xperience by Kentico project. Required to migrate media library and page attachment files. |
| XbKApiSettings | Configuration options set for the API when creating migrated objects in the target application.<br /><br />The `ConnectionStrings.CMSConnectionString`option is required - set the connection string to the target Xperience by Kentico database (the same value as `XbKConnectionString`). |
| MigrationProtocolPath | The absolute file system path of the location where the [migration protocol file](./MIGRATION_PROTOCOL_REFERENCE.md) is generated.<br /><br />For example: `"C:\\Logs\\Migration.Toolkit.Protocol.log"` |
| MigrateOnlyMediaFileInfo | If set to `true`, only the database representations of media files are migrated, without the files in the media folder in the project's file system. For example, enable this option if your media library files are mapped to a shared directory or Cloud storage.<br /><br />If `false`, media files are migrated based on the `KxCmsDirPath` location. |
| MemberIncludeUserSystemFields | Determines which system fields from the *CMS_User* and *CMS_UserSettings* tables are migrated to *CMS_Member* in Xperience by Kentico. Fields that do not exist in *CMS_Member* are automatically created. <br /><br />The sample `appsettings.json` file included with the toolkit by default includes all user fields that can be migrated from Kentico Xperience 13. Exclude specific fields from the migration by removing them from this configuration option. |
| UseOmActivityNodeRelationAutofix | Determines how the migration handles references from Contact management activities to non-existing pages.<br /><br />Possible options:<br />`DiscardData` - faulty references are removed,<br />`AttemptFix` - references are updated to the IDs of corresponding pages created by the migration,<br />`Error` - an error is reported and the reference can be translated or otherwise handled manually |
| UseOmActivitySiteRelationAutofix | Determines how the migration handles site references from Contact management activities.<br /><br />Possible options: `DiscardData`,`AttemptFix`,`Error` |
| EntityConfigurations | Contains options that allow you to fine-tune the migration of specific object types. |
| EntityConfigurations.*&lt;object table name&gt;*.ExcludeCodeNames | Excludes objects with the specified code names from the migration. |
| UseOmActivityNodeRelationAutofix | Determines how the migration handles references from Contact management activities to non-existing pages.<br /><br />Possible options:<br />`DiscardData` - faulty references are removed,<br />`AttemptFix` - references are updated to the IDs of corresponding pages created by the migration,<br />`Error` - an error is reported and the reference can be translated or otherwise handled manually |
| UseOmActivitySiteRelationAutofix | Determines how the migration handles site references from Contact management activities.<br /><br />Possible options: `DiscardData`,`AttemptFix`,`Error` |
| EntityConfigurations | Contains options that allow you to fine-tune the migration of specific object types. |
| EntityConfigurations.*&lt;object table name&gt;*.ExcludeCodeNames | Excludes objects with the specified code names from the migration. |
| CreateReusableFieldSchemaForClasses | Specifies which page types are also converted to [reusable field schemas](#convert-page-types-to-reusable-field-schemas). |
| OptInFeatures.QuerySourceInstanceApi.Enabled | If `true`, [source instance API discovery](#source-instance-api-discovery) is enabled to allow advanced migration of Page Builder content for pages and page templates. |
| OptInFeatures.QuerySourceInstanceApi.Connections | To use [source instance API discovery](#source-instance-api-discovery), you need to add a connection JSON object containing the following values:<br />`SourceInstanceUri` - the base URI where the source instance's live site application is running.<br />`Secret` - the secret that you set in the *ToolkitApiController.cs* file on the source instance. |
| OptInFeatures.CustomMigration.FieldMigrations | Enables conversion of media selection text fields to media library files. See [Convert text fields with media links to media libraries](#convert-text-fields-with-media-links-to-media-libraries) for more information.|
| OptInFeatures.QuerySourceInstanceApi.Enabled | If `true`, [source instance API discovery](#source-instance-api-discovery) is enabled to allow advanced migration of Page Builder content for pages and page templates. |
| OptInFeatures.QuerySourceInstanceApi.Connections | To use [source instance API discovery](#source-instance-api-discovery), you need to add a connection JSON object containing the following values:<br />`SourceInstanceUri` - the base URI where the source instance's live site application is running.<br />`Secret` - the secret that you set in the *ToolkitApiController.cs* file on the source instance. |
| OptInFeatures.CustomMigration.FieldMigrations | Enables conversion of media selection text fields to media library files. See [Convert text fields with media links to media libraries](#convert-text-fields-with-media-links-to-media-libraries) for more information.|

### Example

Expand All @@ -351,7 +350,6 @@ Add the options under the `Settings` section in the configuration file.
"Settings": {
"KxConnectionString": "Data Source=myserver;Initial Catalog=Xperience13;Integrated Security=True;Persist Security Info=False;Connect Timeout=120;Encrypt=False;Current Language=English;",
"KxCmsDirPath": "C:\\inetpub\\wwwroot\\Xperience13\\CMS",
"XbKConnectionString": "Data Source=myserver;Initial Catalog=XperienceByKentico;Integrated Security=True;Persist Security Info=False;Connect Timeout=120;Encrypt=False;Current Language=English;",
"XbKDirPath": "C:\\inetpub\\wwwroot\\XP_Target",
"XbKApiSettings": {
"ConnectionStrings": {
Expand Down
1 change: 0 additions & 1 deletion Migration.Toolkit.CLI/appsettings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"Settings": {
"KxConnectionString": "[TODO]",
"KxCmsDirPath": "[TODO]",
"XbKConnectionString": "[TODO]",
"XbKDirPath": "[TODO]",
"MigrateOnlyMediaFileInfo": false,
"XbKApiSettings": {
Expand Down

0 comments on commit d69d071

Please sign in to comment.