Release 10.0.9 For Common Blocks 9.5, 9.6, 9.7, and 10.0+

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Added functionality to allow for the creation of interim upgrade packages for SCPA solution migrating to the new Component Permission Helper templates.
• Fixed issue where SCPA CPH migration would create circular dependencies.
• Removed CPH Home Mashup during migration
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.5.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before the DPM Permissions can be installed:

• DPM 10.0.0 is installed and initialized
• Solution Framework 10.0.1 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-10.0.1-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-10.0.101.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-10.0.101.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Locations table
  • Configurations
    • This list also shows all configurations that were updated during the upgrade regardless of if they have been changed or not.
    • Selecting an impacted configuration will display all locations (including itself) where this configuration table is inherited in the Inherited Locations table
  • Deprecations
    • This list also shows all the entities and services that were deprecated in the upgrade AND have been inherited from/overridden
    • Selecting an impacted deprecation will display all locations where the entity is inherited or the service is overridden
• Selecting a row in the Inherited Locations table will enable the Compare Items button (This is hidden for deprecations)
• Clicking this button will display a popup that will show the cached, current, and custom (if available) versions of the service code or configuration.
• It is recommended to copy and paste these versions into a 3rd party comparison tool to determine where exactly changes have occurred in the code.

Using the Customization Analysis Report

The Customization Analysis building block will allow the developer to see a list of any Mashup Duplications, Overridden Services, and Service API calls from any custom developed building block. This repor...

10.0.3 For Common Blocks 9.5, 9.6, 9.7, and 10.0+

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Updated the Main Page of Solution Framework to handle the restricted scope functionality added in certain 10.0+ BBs
• Added Dynamic master configuration for Solution Framework mashups
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.5.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before the DPM Permissions can be installed:

• DPM 10.0.0 is installed and initialized
• Solution Framework 10.0.1 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-10.0.1-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-10.0.101.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-10.0.101.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Locations table
  • Configurations
    • This list also shows all configurations that were updated during the upgrade regardless of if they have been changed or not.
    • Selecting an impacted configuration will display all locations (including itself) where this configuration table is inherited in the Inherited Locations table
  • Deprecations
    • This list also shows all the entities and services that were deprecated in the upgrade AND have been inherited from/overridden
    • Selecting an impacted deprecation will display all locations where the entity is inherited or the service is overridden
• Selecting a row in the Inherited Locations table will enable the Compare Items button (This is hidden for deprecations)
• Clicking this button will display a popup that will show the cached, current, and custom (if available) versions of the service code or configuration.
• It is recommended to copy and paste these versions into a 3rd party comparison tool to determine where exactly changes have occurred in the code.

Using the Customization Analysis Report

The Customization Analysis building block will allow the developer to see a list of any Mashup Duplications, Overridden Services, and Service API calls from any custom developed building block. This report is useful to gain insight into any customizations that have been done to OOTB buildin...

10.0.2 For Common Blocks 9.5, 9.6, 9.7, and 10.0+

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Added a migration tool to convert SCPA Permission Helpers to Solution Framework Permission Helpers
• Add Dynamic master configuration for Solution Framework mashups
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.5.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before the DPM Permissions can be installed:

• DPM 10.0.0 is installed and initialized
• Solution Framework 10.0.1 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-10.0.1-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-10.0.101.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-10.0.101.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Locations table
  • Configurations
    • This list also shows all configurations that were updated during the upgrade regardless of if they have been changed or not.
    • Selecting an impacted configuration will display all locations (including itself) where this configuration table is inherited in the Inherited Locations table
  • Deprecations
    • This list also shows all the entities and services that were deprecated in the upgrade AND have been inherited from/overridden
    • Selecting an impacted deprecation will display all locations where the entity is inherited or the service is overridden
• Selecting a row in the Inherited Locations table will enable the Compare Items button (This is hidden for deprecations)
• Clicking this button will display a popup that will show the cached, current, and custom (if available) versions of the service code or configuration.
• It is recommended to copy and paste these versions into a 3rd party comparison tool to determine where exactly changes have occurred in the code.

Using the Customization Analysis Report

The Customization Analysis building block will allow the developer to see a list of any Mashup Duplications, Overridden Services, and Service API calls from any custom developed building block. This report is useful to gain insight into any customizations that have been done to OOTB building blocks for Upgrad...

10.0.1 For Common Blocks 10.0.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Merged SCPA IAM functionality with SF Permissions/Roles
• Various Bug Fixes regarding Security and Package Export
• Added the ability to package Permission Helper with building blocks instead of in the separate Security Block
• Added an ability to export 'Source Control Entities' zip instead of Packaged Extension zip
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	10.0.1
PTC.ComponentManagement	PTC DTS	Not Supported	10.0.1
PTC.UpgradeManagement	PTC DTS	Not Supported	10.0.1
PTC.DatabaseManagement	PTC DTS	Not Supported	10.0.1
PTC.DatabaseManagementUI	PTC DTS	Not Supported	10.0.1
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	10.0.1
PTCDTS.UserManagementUI	PTC DTS	Not Supported	10.0.1
hierarchy-graph	PTC DTS	Not Supported	10.0.1
PTC.SolutionFramework	PTC DTS	Not Supported	10.0.1
PTCDTS.Base.Permissions	PTC DTS	Not Supported	10.0.101

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-10.0.101.zip - Single extension containing all permissions and roles for DPM 10.0.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-10.0.1 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 10.0.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 10.0.0 is installed and initialized
• Solution Framework 10.0.1 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-10.0.1-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-10.0.101.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-10.0.101.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an impl...

9.7.2 for Common Blocks 9.7.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Merged SCPA IAM functionality with SF Permissions/Roles
• Various Bug Fixes regarding Security and Package Export
• Added the ability to package Permission Helper with building blocks instead of in the separate Security Block
• Added an ability to export 'Source Control Entities' zip instead of Packaged Extension zip
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.7.2
PTC.ComponentManagement	PTC DTS	Not Supported	9.7.2
PTC.UpgradeManagement	PTC DTS	Not Supported	9.7.2
PTC.DatabaseManagement	PTC DTS	Not Supported	9.7.2
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.7.2
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.7.2
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.7.2
hierarchy-graph	PTC DTS	Not Supported	9.7.2
PTC.SolutionFramework	PTC DTS	Not Supported	9.7.2
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.7.201

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.7.201.zip - Single extension containing all permissions and roles for DPM 9.7.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.7.2 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.7.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.7.0 is installed and initialized
• Solution Framework 9.7.2 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.7.2-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.7.201.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.7.201.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building...

9.7.1 For Common Building Blocks 9.7.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Updating Common Blocks in package for 9.7 release
• • Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.7.1
PTC.ComponentManagement	PTC DTS	Not Supported	9.7.1
PTC.UpgradeManagement	PTC DTS	Not Supported	9.7.1
PTC.DatabaseManagement	PTC DTS	Not Supported	9.7.1
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.7.1
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.7.1
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.7.1
hierarchy-graph	PTC DTS	Not Supported	9.7.1
PTC.SolutionFramework	PTC DTS	Not Supported	9.7.1
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.7.101

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.7.101.zip - Single extension containing all permissions and roles for DPM 9.7.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.7.1 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.7.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either the MFG Common Solution or DPM Solution needs to be installed from the PTC Support Site.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.7.0 is installed and initialized
• Solution Framework 9.7.1 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.7.1-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.7.101.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.7.101.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Locations table
  • Configurations
    • This list also shows all configurations that were updated during the upgrade regardless of if they...

9.6.3 for Common Blocks 9.6.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Merged SCPA IAM functionality with SF Permissions/Roles
• Various Bug Fixes regarding Security and Package Export
• Added the ability to package Permission Helper with building blocks instead of in the separate Security Block
• Added an ability to export 'Source Control Entities' zip instead of Packaged Extension zip
• Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.6.3
PTC.ComponentManagement	PTC DTS	Not Supported	9.6.3
PTC.UpgradeManagement	PTC DTS	Not Supported	9.6.3
PTC.DatabaseManagement	PTC DTS	Not Supported	9.6.3
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.6.3
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.6.3
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.6.3
hierarchy-graph	PTC DTS	Not Supported	9.6.0
PTC.SolutionFramework	PTC DTS	Not Supported	9.6.3
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.6.301

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.6.301.zip - Single extension containing all permissions and roles for DPM 9.6.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.6.3 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.6.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either MFG Common Solution or DPM Solution is installed.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.6.0 is installed and initialized
• Solution Framework 9.6.3 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.6.3-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.6.301.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.6.301.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted s...

9.5.5 for Common Blocks 9.5.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Merged SCPA IAM functionality with SF Permissions/Roles
• Various Bug Fixes regarding Security and Package Export
• Added the ability to package Permission Helper with building blocks instead of in the separate Security Block
• Added an ability to export 'Source Control Entities' zip instead of Packaged Extension zip
• Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.5.5
PTC.ComponentManagement	PTC DTS	Not Supported	9.5.5
PTC.UpgradeManagement	PTC DTS	Not Supported	9.5.5
PTC.DatabaseManagement	PTC DTS	Not Supported	9.5.5
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.5.5
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.5.5
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.5.5
hierarchy-graph	PTC DTS	Not Supported	9.5.0
PTC.SolutionFramework	PTC DTS	Not Supported	9.5.5
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.5.401

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.5.401.zip - Single extension containing all permissions and roles for DPM 9.5.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.5.4 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.5.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• MFG Common Solution or DPM Solution must be installed
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.5.0 is installed and initialized
• Solution Framework 9.5.5 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.5.5-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.5.401.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.5.401.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted serv...

9.6.2 for Common Blocks 9.6.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Added Sorting/Filtering to various tables in the permissions section of the building block details page
• Updated the README to better reflect what contents of the solution framework package is and isn't supported by PTC Tech Support
• Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.6.2
PTC.ComponentManagement	PTC DTS	Not Supported	9.6.2
PTC.UpgradeManagement	PTC DTS	Not Supported	9.6.2
PTC.DatabaseManagement	PTC DTS	Not Supported	9.6.2
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.6.2
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.6.2
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.6.2
hierarchy-graph	PTC DTS	Not Supported	9.6.0
PTC.SolutionFramework	PTC DTS	Not Supported	9.6.2
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.6.201

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.6.201.zip - Single extension containing all permissions and roles for DPM 9.6.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.6.2 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.6.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• Either MFG Common Solution or DPM Solution is installed.
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.6.0 is installed and initialized
• Solution Framework 9.6.2 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.6.2-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.6.201.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.6.201.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Loc...

9.5.4 for Common Blocks 9.5.0

• Note: This is a modified release. Common building blocks have been removed from this extension package. Please ensure they are installed via the MFG Common extension package or the DPM extension package found on the PTC Support site before installing this package.
• Added Sorting/Filtering to various tables in the permissions section of the building block details page
• Updated the README to better reflect what contents of the solution framework package is and isn't supported by PTC Tech Support
• Note: Outlier Permissions User Groups are still provided in the artifacts below. If you have trouble importing the Base Permissions block due to a circular dependency issue, these User Groups need to be added to the permissions block. Please see the 1.2.004 release for an example.

Disclaimer

To broaden collaboration and facilitate the adoption and expansion of customer solutions, PTC is sharing several field-developed IoT components.

These artifacts are built using ThingWorx best practices, including the Building Block structure where appropriate, and are available to PTC Customers, Partners, and Customer Success for incorporation and enhancement as needed for specific use cases.

Please note, these components are not covered by PTC Technical Support and are not subject to any Technical Support Service Level Agreements (SLAs).

However, PTC Customer Success teams and resources will, on a best-effort basis:

• Maintain and manage functionality across ThingWorx platform version releases.
• Actively address reported bugs.
• Continue to enhance functionality opportunistically and by request where possible.

ThingWorx subscription users can continue to log technical support tickets. ThingWorx Platform Technical Support will assist in isolating root causes and addressing platform-related product issues through standard ThingWorx platform maintenance.

If the issue pertains to this specific component offered via PTC GitHub, PTC Support will direct inquiries to the appropriate internal PTC teams for further assistance.

These shared components are provided "as is," without any warranty, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

Overview

The Solution Framework is a solution developed by PTC Digital Transformation Solutions Engineering team that allows for the creation, modification, configuration, and securing of Solution Building Blocks. Use this solution to:

• Create new building blocks
• Extend/Customize Out-of-the-Box building blocks
• View installed building block information, including initialization status and containing entities
• Configure various building block configurations
• Implement and customize security permissions for the various assets contained in installed building blocks

Package Contents

The 'Solution Framework' extension package contains the following building blocks/extensions:

Building Block Name	Developing Organization	Supported Status	Version
PTCDTS.Base	PTC DTS	Not Supported	9.5.4
PTC.ComponentManagement	PTC DTS	Not Supported	9.5.4
PTC.UpgradeManagement	PTC DTS	Not Supported	9.5.4
PTC.DatabaseManagement	PTC DTS	Not Supported	9.5.4
PTC.DatabaseManagementUI	PTC DTS	Not Supported	9.5.4
PTCDTS.CustomizationAnalysis	PTC DTS	Not Supported	9.5.4
PTCDTS.UserManagementUI	PTC DTS	Not Supported	9.5.4
hierarchy-graph	PTC DTS	Not Supported	9.5.0
PTC.SolutionFramework	PTC DTS	Not Supported	9.5.4
PTCDTS.Base.Permissions	PTC DTS	Not Supported	9.5.401

All 'Not Supported' building blocks/extensions are subject to the above Disclaimer.

• dpm-permissions-extension-9.5.401.zip - Single extension containing all permissions and roles for DPM 9.5.0. Requires Solution Framework to be installed to use.
• Note: This zip will override the ptcdts.base.permissions-9.5.4 extension with a new security block that contains security not only for the Common Blocks/Solution Framework, but also the security for DPM as well.

Installation Prerequisites

The following requirements must be satisfied before the Solution Framework can be installed:

• A ThingWorx 9.5.0 Server or newer must exist and the installer must have composer access
• ThingWorx must be configured to allow importing extensions
• MFG Common Solution or DPM Solution must be installed
• Solution Framework is licensed with the 'PTC_Solution_Common' entitlement. ThingWorx must be registered with a valid license that contains this entitlement to import this extension.

The following requirements must be satisfied before DPM Permissions can be installed:

• DPM 9.5.0 is installed and initialized
• Solution Framework 9.5.4 is installed and initialized.

Installation Steps

The following steps walk through how to install the Solution Framework:

• Download the extension archive
• Log into ThingWorx Composer as an Administrator that has access to import extensions
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded solutionframework-9.5.4-extension-package.zip file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• {
  "databaseUser": "<TWX_DB_USER_NAME>",
  "overrideComponentDeploymentState": false,
  "databasePassword": "<TWX_DB_USER_PASSWORD>",
  "databaseJDBCString": "<TWX_DB_JDBC_STRING>",
  "databaseThing": "Either PTC.DBConnection.SQLThingDatabase or PTC.DBConnection.PostgresDatabase"
  }

The following steps walk through how to install the DPM Permissions extension package:

• Download the dpm-permissions-extension-9.5.401.zip extension package
• Log into ThingWorx Composer as an Administrator that has access to import extensions
  • Note: if you receive an error that the dpm-permissions-extension-9.5.401.zip extension could not be imported into the system, you may need to remove the old extension first
    • Navigate to Manage -> Installed Extensions using the right side navigation menu
    • Find the PTCDTS.Base.Permissions extension and remove it
• In the left-side navigation menu, click on the Import/Export button (Diverging Arrows Icon)
• Click the Import Sub-Menu
• In the popup that displays, change Import Option to Extension
• Click the Browse button and navigate to the location the downloaded permissions extension package file
• Select the zip archive and click the open button
• Click the Import button. A confirmation should appear that the import was successful. Close the popup.
• Navigate to PTC.Base.Manager
• Click on the Services tab.
• Click the 'Execute' button next to the 'InitializeSolution' service
• Run with the following JSON Structure:
• { } - Note this is an empty JSON object. This is intentional.
• An admin needs to provide visibility permissions to PTCDTS.Base.Permissions.Default_OR for the network containing the asset hierarchy. This generally has the same name as the Enterprise. This should be done in Composer.

Usage

Open and view the PTC.SolutionFramework.Main_MU mashup to launch the Solution Framework user experience. It is also possible to get to the Solution Framework when viewing other solutions, by clicking on the 'Solution Framework' menu item on the Main Solution Master Navigation Menu.

In order to use the User Management UI mashup:

• 1. The user must be in the Application Admin Role
• 2. The user must navigate to the Administration Menu and select the User List menu option

The DPM Permissions block contains read-only and full access roles for each application inside of DPM. Leverage the Solution Framework -> Global View -> Role Management page to add users to these roles. This will provide access to DPM for non-admin users.

Users can also be added to roles via the DPM Administration -> User Management -> User List page.

Using the Upgrade Impact Report

The Upgrade Impact Report can be used by developers to determine if any of their customization/configurations is in conflict with a change in an OOTB solution between versions.

• Stand up a Development environment with current version of DPM + Customizations
  • Note: This is recommended but not necessary
• Deploy Solution Framework (which includes PTC.UpgradeManagement)
• Navigate to the Upgrade Impact Report mashup (Solution Framework → Global View → Upgrade Management → Upgrade Impact Report)
• Click the Store In Cache Button to cache the current codebase
  • Note: This can only be done if the cache is empty. If it is not empty you will need to click the Purge Cache Button
  • Note: This may take a few minutes
• Upgrade DPM following official DPM documentation
• Navigate back to the Upgrade Impact Report mashup
• Click the Compare to Cache Button to compare the current version of the solution to the cached version
  • Note: This may take a few minutes
• Once the compare has been completed a list of impacted services and configurations will appear in the Impacted Items table.
  • Services
    • This list shows all services that were updated during the upgrade AND have been overridden via an implementation building block
    • Selecting an impacted service will display all locations where the service was overridden in the Inherited Locati...