< Back
Update-AnalysisServicesConfig
Post
NAME Update-AnalysisServicesConfig
SYNOPSIS
Updates the various config files generated alongside the asdatabase file so they can be deployed to the correct
server with the correct processing options.
SYNTAX
Update-AnalysisServicesConfig [-AsDatabasePath] <String> [-Server] <String> [-CubeDatabase] <String>
[[-ProcessingOption] <String>] [[-TransactionalDeployment] <String>] [[-PartitionDeployment] <String>]
[[-RoleDeployment] <String>] [[-ConfigurationSettingsDeployment] <String>] [[-OptimizationSettingsDeployment]
<String>] [[-WriteBackTableCreation] <String>] [<CommonParameters>]
DESCRIPTION
Updates the various config files generated alongside the asdatabase file so they can be deployed to the correct
server with the correct processing options.
This PowerShell function updates the various config files (listed below) which are needed to deploy the cube:
* [model name].asdatabase which contains the declarative definitions for all SSAS objects.
* [model name].deploymenttargets whcih Contains the name of the target SSAS instance and database.
* [model name].deploymentoptions which contains options such as whether deployment is transactional and whether
objects should be processed.
* [model name].configsettings which is for Multidimensional only and contains environment specific settings such
as data source connections and object storage locations. These settings override whats in [model name].asdatabase.
PARAMETERS
-AsDatabasePath <String>
Full path to your database XMLA or TMSL file which has a .asdatabase file extension (e.g.
C:\\Dev\\YourDB\\bin\\Debug\\YourDB.asdatabase)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Name of the target SSAS server, including instance and port if required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CubeDatabase <String>
The name of the cube database to be deployed.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProcessingOption <String>
Determines how the newely deployed cube is processed after deployment. Strongly recommend using the default
"DoNotProcess" option as the connection to your source database may not be correct and need adjustment
post-deployment.
* Valid options are: Full, Default and DoNotProcess.
* Default value: 'DoNotProcess'.
* 'Full': processes all the objects in the cube database. When Full processing is executed against an object
that has already been processed, Analysis Services drops all data in the object and then processes the object.
* 'Default': detects the process state of cube database objects, and performs the processing necessary to
deliver unprocessed or partially processed objects to a fully processed state.
* 'DoNotProcess': means no processing is performed.
Required? false
Position? 4
Default value DoNotProcess
Accept pipeline input? false
Accept wildcard characters? false
-TransactionalDeployment <String>
Determines if the cube is deployed within one transaction for both metadata changes and processing commands.
* If this option is True, Analysis Services deploys all metadata changes and all process commands within a
single transaction.
* If this option is False (default), Analysis Services deploys the metadata changes in a single transaction,
and deploys each processing command in its own transaction.
Required? false
Position? 5
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-PartitionDeployment <String>
Determines if partitions are deployed.
* Valid options are: 'DeployPartitions' and 'RetainPartitions'.
* Default value: 'DeployPartitions'.
* 'DeployPartitions': New partitions are deployed. Existing partitions are removed.
* 'RetainPartitions': Existing partitions are retained. New partitions are not deployed.
Required? false
Position? 6
Default value DeployPartitions
Accept pipeline input? false
Accept wildcard characters? false
-RoleDeployment <String>
Determines if the roles and members are deployed.
* Valid options are: 'DeployRolesAndMembers', 'DeployRolesRetainMembers' and 'RetainRoles'.
* Default value: 'DeployRolesRetainMembers'.
* 'DeployRolesRetainMembers': Existing roles and role members in the destination database are retained, and
only new roles and role members are deployed.
* 'DeployRolesAndMembers': All existing roles and members in the destination database are replaced by the
roles and members being deployed.
* 'RetainRoles': Existing roles and role members in the destination database are retained, and no new roles
are deployed.
Required? false
Position? 7
Default value DeployRolesRetainMembers
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationSettingsDeployment <String>
* Valid options are: 'Retain' and 'Deploy'.
* Default value: 'Deploy'.
Required? false
Position? 8
Default value Deploy
Accept pipeline input? false
Accept wildcard characters? false
-OptimizationSettingsDeployment <String>
* Valid options are: 'Retain' and 'Deploy'.
* Default value: 'Deploy'.
Required? false
Position? 9
Default value Deploy
Accept pipeline input? false
Accept wildcard characters? false
-WriteBackTableCreation <String>
Determines if a write back table is created
* Valid only for multidimensional cubes. Determines if the deployment should create the writeback table.
* Valid options are: 'Create', 'CreateAlways' and 'UseExisting'.
* Default value: 'UseExisting'.
Required? false
Position? 10
Default value UseExisting
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Written by (c) Dr. John Tunnicliffe, 2019 https://github.com/DrJohnT/DeployCube
This PowerShell script is released under the MIT license http://www.opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-AnalysisServicesConfig -AsDatabasePath $AsDatabasePath -Server $Server -CubeDatabase $CubeDatabase;
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Update-AnalysisServicesConfig -AsDatabasePath $AsDatabasePath -Server $Server -CubeDatabase $CubeDatabase
-ProcessingOption $ProcessingOption -TransactionalDeployment $TransactionalDeployment -PartitionDeployment
$PartitionDeployment -RoleDeployment $RoleDeployment -ConfigurationSettingsDeployment
$ConfigurationSettingsDeployment -OptimizationSettingsDeployment $OptimizationSettingsDeployment
-WriteBackTableCreation $WriteBackTableCreation;
RELATED LINKS
https://github.com/DrJohnT/DeployCube
SYNOPSIS
Updates the various config files generated alongside the asdatabase file so they can be deployed to the correct
server with the correct processing options.
SYNTAX
Update-AnalysisServicesConfig [-AsDatabasePath] <String> [-Server] <String> [-CubeDatabase] <String>
[[-ProcessingOption] <String>] [[-TransactionalDeployment] <String>] [[-PartitionDeployment] <String>]
[[-RoleDeployment] <String>] [[-ConfigurationSettingsDeployment] <String>] [[-OptimizationSettingsDeployment]
<String>] [[-WriteBackTableCreation] <String>] [<CommonParameters>]
DESCRIPTION
Updates the various config files generated alongside the asdatabase file so they can be deployed to the correct
server with the correct processing options.
This PowerShell function updates the various config files (listed below) which are needed to deploy the cube:
* [model name].asdatabase which contains the declarative definitions for all SSAS objects.
* [model name].deploymenttargets whcih Contains the name of the target SSAS instance and database.
* [model name].deploymentoptions which contains options such as whether deployment is transactional and whether
objects should be processed.
* [model name].configsettings which is for Multidimensional only and contains environment specific settings such
as data source connections and object storage locations. These settings override whats in [model name].asdatabase.
PARAMETERS
-AsDatabasePath <String>
Full path to your database XMLA or TMSL file which has a .asdatabase file extension (e.g.
C:\\Dev\\YourDB\\bin\\Debug\\YourDB.asdatabase)
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Name of the target SSAS server, including instance and port if required.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CubeDatabase <String>
The name of the cube database to be deployed.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProcessingOption <String>
Determines how the newely deployed cube is processed after deployment. Strongly recommend using the default
"DoNotProcess" option as the connection to your source database may not be correct and need adjustment
post-deployment.
* Valid options are: Full, Default and DoNotProcess.
* Default value: 'DoNotProcess'.
* 'Full': processes all the objects in the cube database. When Full processing is executed against an object
that has already been processed, Analysis Services drops all data in the object and then processes the object.
* 'Default': detects the process state of cube database objects, and performs the processing necessary to
deliver unprocessed or partially processed objects to a fully processed state.
* 'DoNotProcess': means no processing is performed.
Required? false
Position? 4
Default value DoNotProcess
Accept pipeline input? false
Accept wildcard characters? false
-TransactionalDeployment <String>
Determines if the cube is deployed within one transaction for both metadata changes and processing commands.
* If this option is True, Analysis Services deploys all metadata changes and all process commands within a
single transaction.
* If this option is False (default), Analysis Services deploys the metadata changes in a single transaction,
and deploys each processing command in its own transaction.
Required? false
Position? 5
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-PartitionDeployment <String>
Determines if partitions are deployed.
* Valid options are: 'DeployPartitions' and 'RetainPartitions'.
* Default value: 'DeployPartitions'.
* 'DeployPartitions': New partitions are deployed. Existing partitions are removed.
* 'RetainPartitions': Existing partitions are retained. New partitions are not deployed.
Required? false
Position? 6
Default value DeployPartitions
Accept pipeline input? false
Accept wildcard characters? false
-RoleDeployment <String>
Determines if the roles and members are deployed.
* Valid options are: 'DeployRolesAndMembers', 'DeployRolesRetainMembers' and 'RetainRoles'.
* Default value: 'DeployRolesRetainMembers'.
* 'DeployRolesRetainMembers': Existing roles and role members in the destination database are retained, and
only new roles and role members are deployed.
* 'DeployRolesAndMembers': All existing roles and members in the destination database are replaced by the
roles and members being deployed.
* 'RetainRoles': Existing roles and role members in the destination database are retained, and no new roles
are deployed.
Required? false
Position? 7
Default value DeployRolesRetainMembers
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationSettingsDeployment <String>
* Valid options are: 'Retain' and 'Deploy'.
* Default value: 'Deploy'.
Required? false
Position? 8
Default value Deploy
Accept pipeline input? false
Accept wildcard characters? false
-OptimizationSettingsDeployment <String>
* Valid options are: 'Retain' and 'Deploy'.
* Default value: 'Deploy'.
Required? false
Position? 9
Default value Deploy
Accept pipeline input? false
Accept wildcard characters? false
-WriteBackTableCreation <String>
Determines if a write back table is created
* Valid only for multidimensional cubes. Determines if the deployment should create the writeback table.
* Valid options are: 'Create', 'CreateAlways' and 'UseExisting'.
* Default value: 'UseExisting'.
Required? false
Position? 10
Default value UseExisting
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Written by (c) Dr. John Tunnicliffe, 2019 https://github.com/DrJohnT/DeployCube
This PowerShell script is released under the MIT license http://www.opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-AnalysisServicesConfig -AsDatabasePath $AsDatabasePath -Server $Server -CubeDatabase $CubeDatabase;
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Update-AnalysisServicesConfig -AsDatabasePath $AsDatabasePath -Server $Server -CubeDatabase $CubeDatabase
-ProcessingOption $ProcessingOption -TransactionalDeployment $TransactionalDeployment -PartitionDeployment
$PartitionDeployment -RoleDeployment $RoleDeployment -ConfigurationSettingsDeployment
$ConfigurationSettingsDeployment -OptimizationSettingsDeployment $OptimizationSettingsDeployment
-WriteBackTableCreation $WriteBackTableCreation;
RELATED LINKS
https://github.com/DrJohnT/DeployCube