Import-FIMReportingSchemaDefinition
Allows users to create or extend the reporting schema in the Data Warehouse and the binding definitions in FIM.
Syntax
Import-FIMReportingSchemaDefinition [-BindingXmlFile <String>] [-ResourceManagementServiceCredential <PSCredential>] [-Uri <String>] [-CompanyName <String>] [-Copyright <String>] [-DelaySign] [-SealingKeyFile <String>] [-SealManagementPack] [-ServiceManagerCredential <PSCredential>] [-ServiceManagerServer <String>] –ManagementPackFile <String> [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WariningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-WhatIf] [-Confirm]
Detailed Description
This PowerShell cmdlet allows users to import new Data Warehouse schema into the SCSM Data Warehouse and create new reporting bindings in the FIM Service. By creating new schema in the SCSM Data Warehouse, one may add new custom objects and attributes to the reporting store. By creating new bindings in the FIM Service, one may then flow these data elements over into the new Data Warehouse schema using the FIM Reporting ETL process.
Parameters
-BindingXmlFile <String>
This required parameter is defined as the path to the FIM to SCDW object binding file. This file defines bindings between objects / attributes in FIM and classes / properties in the SCSM Data Warehouse.
Required? |
true |
Position? |
named |
Default Value |
No default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceManagementServiceCredential <PSCredential>
This is the credential needed for talking to the FIM resource management service. By default, this is set to the credentials of the current user. If the user wishes to run under a different context, they can pass a system.credential object to the commandlet.
Required? |
false |
Position? |
named |
Default Value |
<system.credential> = current user |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Uri <String>
This URL pointing to the resource management service. By default this is set to “https://localhost:5725/resourcemanagementservice“
Required? |
false |
Position? |
1 |
Default Value |
https://localhost:5725/resourcemanagementservice |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-CompanyName <String>
This parameter is optional unless –sealManagementPack is present. In the case where –sealManagementPack is present, this parameter specifies the name of the company which has sealed the MP.
Required? |
false |
Position? |
named |
Default Value |
null |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Copyright <String>
This parameter is optional unless –sealManagementPack is present. In the case where –sealManagementPack is present, this parameter specifies copyright information which will be attached to the sealed MP.
Required? |
false |
Position? |
named |
Default Value |
null |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DelaySign
This parameter is optional in all cases, and is only used if “–sealingKeyFile” is present. In the case where –delaySign is present, it specifies whether or not the signing process should be delayed until the MP can be signed by the private key holder. This is useful in testing environments where one only requires partial signing to verify a report that is being developed.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SealingKeyFile <String>
This parameter is defined as the path to the .snk file which holds the public private key pair which will be used to seal the MP file before it is imported. If this parameter is specified, the MPs will be sealed before being imported into the SCSM Data Warehouse.
Warning
While the SCSM SDK does not require that you seal your management packs before importing them, it is nonetheless highly recommended to do so. Failure to do so may result in being unable to synchronize your management packs to the Data Warehouse. To seal your management packs using the PowerShell interface, specify the -SealMP parameter and provide a sealing key file (which can be generated using the strong name (sn) tool in Windows).
Required? |
true |
Position? |
named |
Default Value |
null |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SealManagementPack
This parameter specifies whether or not the schema management pack being imported should be sealed. Sealing a management pack prevents it from being modified after it has been imported into the SCSM Data Warehouse.
Warning
While the SCSM SDK does not require that you seal your management packs before importing them, it is nonetheless highly recommended to do so. Failure to do so may result in being unable to synchronize your management packs to the Data Warehouse. To seal your management packs using the PowerShell interface, specify the -SealMP parameter and provide a sealing key file (which can be generated using the strong name (sn) tool in Windows).
Required? |
true |
Position? |
named |
Default Value |
null |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceManagerCredential <PSCredential>
This is the credential needed for talking to SCSM SDK service. By default, this is set to the credentials of the current user. If the user wishes to run under a different context, she can pass a system.credential object to the commandlet.
Required? |
false |
Position? |
named |
Default Value |
<system.credential> = current user |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceManagerServer <String>
This is the hostname of the System Center Service Manager Management Server. By default, this is set to “localhost”.
Warning
When running Import-FIMReportingSchemaDefinition, be sure that you do not specify your Data Warehouse server name for the ServiceManagerServer flag. Doing so may result in incorrectly importing management packs directly into the data warehouse, resulting in you being unable to remove these management packs once they have been deployed.
Required? |
false |
Position? |
named |
Default Value |
localhost |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementPackFile <String>
This required parameter is defined as the path to the schema management pack file on the local file system.
Required? |
true |
Position? |
named |
Default Value |
No default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Notes
Example 1
C:\PS> Add-PSSnapin FimReportingAdministration
C:\PS> Import-FIMReportingSchemaDefinition -BindingXmlFile C:\ReportingExt\binding\Microsoft.Forefront.IdentityManager.Data Warehouse.Test.Extensibility.xml -CompanyName "TwoWards"
-ServiceManagerServer ilm-vm-scsm -ManagementPackFile C:\ReportingExt\schema\Microsoft.Forefront.IdentityManager.Data Warehouse.Test.Extensibility.xml
-Verbose -SealManagementPack -SealingKeyFile C:\ReportingExt\TestFimReportingKeyPair.snk
.
Example 2
C:\PS> C:\PS> Add-PSSnapin FimReportingAdministration
C:\PS> Import-FIMReportingReport -BindingXmlFile C:\ReportingExt\binding\Microsoft.Forefront.IdentityManager.Data Warehouse.Test.Extensibility.xml –ResourceManagementServiceCredential CORP\User1 -CompanyName "TwoWards" –serviceManagerCredential CORP\User1 -ServiceManagerServer ilm-vm-scsm -ManagementPackFile C:\ReportingExt\schema\Microsoft.Forefront.IdentityManager.Data Warehouse.Test.Extensibility.xml -Verbose -SealManagementPack -SealingKeyFile C:\ReportingExt\TestFimReportingKeyPair.snk