iCore PowerShell cmdlets

iCore provides a number of cmdlets that can be used to manage certain functions in iCore Integration Suite via the PowerShell console. The cmdlets are located in separate modules, described below.

• Cmdlets in iCore.PowerShell module
• Cmdlets in iCore.Administrator.Configuration module

iCore.PowerShell module

The cmdlets in the iCore.PowerShell module can be used to access "general" functionality (for example regarding iCore licenses, systems and entities) as well as controlling and modifying a System Access Service.

note

The cmdlets become automatically available if you start the PowerShell console from iCore Administrator. However, getting access to the cmdlets if you start the console from Windows requires that you run the 32-bit version of the console and have previously imported the iCore.PowerShell module.

To list available cmdlets

Get-iCoreCommands

note

If running outside the iCore PowerShell Console, use Get-Command -Module iCore.PowerShell.

General cmdlets

Name	Module	Synopsis
Activate-iCoreLicense	iCore.PowerShell	Activates an iCore license.
Add-iCoreEntityReference	iCore.PowerShell	Adds a reference between two iCore entities.
Add-iCoreEntityToCategory	iCore.PowerShell	Adds one or more iCore entities to one or more Categories.
Add-iCoreUserToUserGroup	iCore.PowerShell	Adds an iCore User to an User group.
Attach-iCoreSystem	iCore.PowerShell	Attaches an iCore system database.
Build-iCoreAdapterFlow	iCore.PowerShell	Compiles Adapterflows. See also Notes about Build cmdlets.
Build-iCoreComponent	iCore.PowerShell	Builds iCore Components from Scripts. See also Notes about Build cmdlets.
Build-iCoreWebService	iCore.PowerShell	Compiles iCore Web service clients. See also Notes about Build cmdlets.
Build-iCoreWebApi	iCore.PowerShell	Compiles iCore Web APIs. See also Notes about Build cmdlets.
Build-iCoreWorkflow	iCore.PowerShell	Compiles iCore Workflows. See also Notes about Build cmdlets.
Detach-iCoreSystem	iCore.PowerShell	Detaches the specified iCore system from this computer.
Export-iCoreEntity	iCore.PowerShell	Exports iCore entities to an XML document.
Get-iCoreBatchImportSchema	iCore.PowerShell	Gets the XML Schema defining the legal syntax for a batch import response file.
Get-ExportableiCoreEntity	iCore.PowerShell	Gets exportable entities from an iCore system.
Get-iCoreEntity	iCore.PowerShell	Gets iCore entities of specific type.
Get-iCoreEntityType	iCore.PowerShell	Gets a list of iCore entity types based on parameters.
Get-iCorePaths	iCore.PowerShell	Gets information about the paths related to iCore. Note: This cmdlet is deprecated and will be removed in future versions of iCore Integration Suite.
Get-iCoreSystem	iCore.PowerShell	Get a list of all locally attached iCore systems.
Import-iCoreEntity	iCore.PowerShell	Imports previously exported iCore entities into an iCore system.
Install-iCoreService	iCore.PowerShell	Installs the iCore Process Server service on the local machine.
New-iCoreEntity	iCore.PowerShell	Creates a new iCore entity.
New-iCoreSubEntity	iCore.PowerShell	Adds a new subentity to a collection, and returns the newly added SubEntity.
New-iCoreSystem	iCore.PowerShell	Creates a new iCore system.
Reactivate-iCoreLicense	iCore.PowerShell	Looks up iCore serial number from license manager.
Reattach-iCoreSystem	iCore.PowerShell	Re-attaches the current computer to the specified iCore system.
Remove-iCoreEntity	iCore.PowerShell	Removes iCore entity.
Remove-iCoreEntityFromCategory	iCore.PowerShell	Removes one or more iCore entities from one or more Categories.
Remove-iCoreEntityReference	iCore.PowerShell	Removes a reference between two iCore entities.
Remove-iCoreSubEntity	iCore.PowerShell	Removes a subentity from a collection, and returns a boolean to indicate whether the subentity was removed or not.
Remove-iCoreUserFromUserGroup	iCore.PowerShell	Removes an iCore User from a User group.
Restart-iCoreApplicationPools	iCore.PowerShell	Restarts all Application pools in an iCore system.
Save-iCoreEntity	iCore.PowerShell	Saves iCore entity.
Set-iCoreAuthenticationProvider	iCore.PowerShell	Configures all the properties of the authentication provider of the specified iCore system.
Set-iCoreAzureADSystemConfiguration	iCore.PowerShell	Configures Azure AD authorization on an iCore system.
Set-iCoreAzureADUserGroup	iCore.PowerShell	Configures the iCore User group to be associated with an Azure AD group.
Set-iCoreManagementServiceEndpoint	iCore.PowerShell	Configures the endpoint of the iCore Management Service for remote administration.
Set-iCoreUserPassword	iCore.PowerShell	Change password for a specific iCore User.
Start-iCoreSystem	iCore.PowerShell	Starts all servers in a iCore system.
Stop-iCoreSystem	iCore.PowerShell	Stops all servers in a iCore system.
Test-iCoreEntityReferences	iCore.PowerShell	Performs an integrity check of the dependencies between entities in an iCore system.
Uninstall-iCoreService	iCore.PowerShell	Uninstalls a previously installed service for the iCore Process Server on the local machine.
Update-iCoreSystem	iCore.PowerShell	Upgrades an existing iCore system to the currently installed system version.

Remarks

New-iCoreSubEntity

A sub-entity is not saved until its parent entity has been saved. See Save-iCoreEntity cmdlet.

System Access Service (SAS) cmdlets

Name	Module	Synopsis
Add-iCoreSystemAccessServiceEndpoint	iCore.PowerShell	Adds a configured endpoint to the iCore System Access Service.
Clear-iCoreSystemAccessServiceEndpoints	iCore.PowerShell	Removes all configured endpoints from the iCore System Access Service.
Get-iCoreSystemAccessServiceEndpoint	iCore.PowerShell	Gets the configured iCore System Access Service endpoints.
Remove-iCoreSystemAccessServiceEndpoint	iCore.PowerShell	Removes a configured endpoint for the iCore System Access Service.
Reset-iCoreSystemAccessServiceConfiguration	iCore.PowerShell	Resets the configuration of the iCore System Access Service to its default state.
Restart-iCoreSystemAccessService	iCore.PowerShell	Restarts the iCore System Access Service.
Start-iCoreSystemAccessService	iCore.PowerShell	Starts the iCore System Access Service.
Stop-iCoreSystemAccessService	iCore.PowerShell	Stops the iCore System Access Service.

To add a new endpoint

This example describes how to use a cmdlet to add a new endpoint of type net.tcp. In the example, "myservername" is the name of the computer, and "12000" is the port to listen to.

Add-iCoreSystemAccessServiceEndpoint -Uri 'net.tcp://myservername:12000/iCore/SAS'

Notes about Build cmdlets

note

If you attempt to compile/build an iCore entity immediately after iCore has been upgraded, you may receive the following error:

"Loading this assembly would produce a different grant set from other instances."

The reason this error occurs is that the installation program queues assemblies for native image generation in the background, and this process is not necessarily complete even though the upgrade has finished.

To solve or prevent the problem:

• If you have performed a "manual" iCore upgrade: Restart the application you are using to build the entity and repeat the build operation.
• If you are performing "automatic" iCore upgrades, where compilation of entities is started automatically after the upgrade procedure, you can prevent the error by forcing native image generation after the installation but before compiling any entities. To do this, run the command "ngen.exe executeQueuedItems". The ngen.exe tool is installed with the .NET framework directory and is normally found in C:\Windows\Microsoft.NET\Framework\v4.0.30319\ngen.exe.

note

If you try to compile a Component definition (Adapterflows, Scripts, Workflows or Web APIs) which is locked by another user, the compile will fail.

Administrator.Configuration module

The iCore.Administrator.Configuration module contains cmdlets that can be used to manage and configure the Administrator tool. The module also contains cmdlets for installing the Administrator site and the SAS proxy.

note

Invoking the cmdlets on a 64-bit operating system requires a 64-bit PowerShell console.

Importing the module

To import the iCore.Administrator.Configuration module, run the Load-AdminModules.ps1 script from the correct Administrator version subdirectory, for example "C:\Program Files (x86)\iCore Administrator\{Version}\Load-AdminModules.ps1".  See also Directory structure.

To list available cmdlets

    Get-Command -Module iCore.Administrator.Configuration

To update an Administrator site installed in IIS

    Update-iCoreWebAdmin -SiteName "My iCore Site" -TemplateDirectory "C:\Program Files (x86)\iCore Administrator\{Version}\Template"  -Verbose

To update an Administrator site installed as an application (on a site)

    Update-iCoreWebAdmin -SiteName "My iCore Site" -ApplicationName "iCore Administrator" -TemplateDirectory "C:\Program Files (x86)\iCore Administrator\{Version}\Template" -Verbose

Available cmdlets

User management cmdlets

Name	Module	Synopsis
Add-iCoreAdminAzureAdGroupForRole	iCore.Administrator.Configuration	Adds an Azure AD group mapping to a role.
Add-iCoreAdminAzureAdProviderScope	iCore.Administrator.Configuration	Adds a scope to Azure AD provider.
Add-iCoreAdminRoleToolsRule	iCore.Administrator.Configuration	Adds a rule which decides which tools should be accessible for users in a specific group.
Add-iCoreWebAdminOidcProviderIdentifierClaim	iCore.Administrator.Configuration	Adds the name of a claim that is used to authorize users to log in to the Administrator site.
Add-iCoreWebAdminOidcProviderScope	iCore.Administrator.Configuration	Adds a scope with claims that is returned from the Open ID Connect provider.
Add-iCoreWebAdminRoleMember	iCore.Administrator.Configuration	Adds a user or Windows identity as a member of an role in iCore Administrator.
Get-iCoreAdminGeneralSettings	iCore.Administrator.Configuration	Displays the general settings of the Administrator.
Get-iCoreAdminOidcSettings	iCore.Administrator.Configuration	Displays OIDC settings of iCore Administrator.
Get-iCoreAdminRoleToolsRules	iCore.Administrator.Configuration	Displays the rules which decide which tools should be accessible for users in a specific group.
Get-iCoreWebAdminRole	iCore.Administrator.Configuration	Gets one or more iCore Administrator roles defined for a site.
Get-iCoreWebAdminRoleMember	iCore.Administrator.Configuration	Gets the users and Windows identities that are members of an iCore Administrator role.
Get-iCoreWebAdminUser	iCore.Administrator.Configuration	Gets one or more iCore Administrator users.
New-iCoreWebAdminRole	iCore.Administrator.Configuration	Creates a new iCore Administrator role.
New-iCoreWebAdminUser	iCore.Administrator.Configuration	Creates a new iCore Administrator user to use with Forms Authentication on the website.
Remove-iCoreAdminAzureAdGroupForRole	iCore.Administrator.Configuration	Removes an Azure AD group mapping from a role.
Remove-iCoreAdminAzureAdProvider	iCore.Administrator.Configuration	Removes Azure AD provider.
Remove-iCoreAdminAzureAdProviderScope	iCore.Administrator.Configuration	Removes a scope from Azure AD provider.
Remove-iCoreAdminRoleToolsRule	iCore.Administrator.Configuration	Removes a rule which decides which tools should be accessible for users in a specific group.
Remove-iCoreWebAdminOidcClientSecret	iCore.Administrator.Configuration	Removes the OpenIdConnect provider's client secret.
Remove-iCoreWebAdminOidcProvider	iCore.Administrator.Configuration	Removes the Open ID Connect provider information used to authorize users to log in to the Administrator site.
Remove-iCoreWebAdminOidcProviderIdentifierClaim	iCore.Administrator.Configuration	Removes the name of a claim that is used to authorize users to log in to the Administrator site.
Remove-iCoreWebAdminOidcProviderScope	iCore.Administrator.Configuration	Removes a scope with claims.
Remove-iCoreWebAdminRole	iCore.Administrator.Configuration	Creates a new iCore Administrator role. For an example, see Managing roles and users.
Remove-iCoreWebAdminRoleMember	iCore.Administrator.Configuration	Removes the role membership for a user or Windows identity.
Remove-iCoreWebAdminUser	iCore.Administrator.Configuration	Removes an existing iCore Administrator user used for Forms Authentication on the web site.
Set-iCoreAdminAzureAdProvider	iCore.Administrator.Configuration	Sets Azure AD provider used for Azure AD authorization in combination with OIDC authentication.
Set-iCoreAdminGeneralSettings	iCore.Administrator.Configuration	Sets the general settings of the Administrator.
Set-iCoreAdminOidcSettings	iCore.Administrator.Configuration	Sets OIDC settings of iCore Administrator, for example RedirectUri and DynamicRedirectUriType.
Set-iCoreWebAdminOidcClientSecret	iCore.Administrator.Configuration	Sets the OpenIdConnect provider's client secret.
Set-iCoreWebAdminOidcProvider	iCore.Administrator.Configuration	Sets the Open ID Connect provider information used to authorize users to log in to the Administrator site.
Set-iCoreWebAdminRoleStartPage	iCore.Administrator.Configuration	Sets the Administrator start page of an existing iCore role. For an example, Managing roles and users.
Set-iCoreWebAdminUserPassword	iCore.Administrator.Configuration	Changes the password of an existing iCore Administrator user using Forms Authentication on the website.

Remarks

Remove-iCoreWebAdminRole and Set-iCoreWebAdminRoleStartPage

• The "StartPageDashboardURL" string needs to start with "https://" to be considered a valid start page.
• The start page cannot have XFO headers "x-frame-option: sameorigin/deny". If you are the owner of the site and it is raising an error, contact the web administrator to implement “x-frame-option: allow-from ‘http://www.iCore.Url’”.

Open ID Connect user management cmdlets

Name	Module	Synopsis
New-iCoreWebAdminOidcUser	iCore.Administrator.Configuration	Adds an OpenIdConnectUser (i.e a user that is authorized to login to the Administrator site using the set provider).
Remove-iCoreWebAdminOidcUser	iCore.Administrator.Configuration	Removes an OpenIdConnectUser.
Get-iCoreWebAdminOidcUsers	iCore.Administrator.Configuration	Lists all OpenIdConnectUsers.
Add-iCoreWebAdminOidcUserIdentifier	iCore.Administrator.Configuration	Adds an identification claim with expected value used to give user access to the Administrator site.
Remove-iCoreWebAdminOidcUserIdentifier	iCore.Administrator.Configuration	Removes an identification claim from a user.
Get-iCoreWebAdminOidcUser	iCore.Administrator.Configuration	Gets an OpenIdConnect users on name.

Installation cmdlets

Name	Module	Synopsis
Get-iCoreWebAdminApplications	iCore.Administrator.Configuration	Gets all installed iCore Administrator application web sites/applications on this computer.
Get-WebPhysicalPath	iCore.Administrator.Configuration	Gets the physical path of a web application or a web site.
Import-InstallInfo	iCore.Administrator.Configuration	Loads an installation information object previously saved by ExportInstallInfo.
Install-iCoreWebAdmin	iCore.Administrator.Configuration	Creates a new website or web application in IIS and installs the iCore Administrator application into it.
New-SasConnectionInfo	iCore.Administrator.Configuration	Creates a new SasConnectionInfo object.
Set-iCoreWebAdminAuthentication	iCore.Administrator.Configuration	Sets the authentication type for an Administrator site.
Update-AlliCoreWebAdminApplications	iCore.Administrator.Configuration	Updates all installed iCore Administrator Application web sites/applications to the latest installed version.
Update-iCoreWebAdmin	iCore.Administrator.Configuration	Updates a web site or web application containing the iCore Web Administrator Application to the latest installed version.

SAS Proxy cmdlets

Name	Module	Synopsis
Get-iCoreSystemAccessServiceProxyApplications	iCore.Administrator.Configuration	Gets all installed iCore Invoke Web service web sites/applications on this computer.
Install-iCoreSystemAccessServiceProxy	iCore.Administrator.Configuration	Creates a new website, or a new web application, hosting the System Access Service Proxy.
Update-iCoreSystemAccessServiceProxy	iCore.Administrator.Configuration	Updates the SAS proxy.
Uninstall-iCoreSystemAccessServiceProxy	iCore.Administrator.Configuration	Uninstalls the SAS proxy.

Configuration management cmdlets

Name	Module	Synopsis
Get-iCoreWebAdminConfigPath	iCore.Administrator.Configuration	Gets the path or UNC path to the location of the configuration file of a specified configuration type. If no path is specified, it is assumed that the file is located in the site directory with the default file name.
Set-iCoreWebAdminConfigPath	iCore.Administrator.Configuration	Sets the path or UNC path to the location of the configuration file of a specified configuration type. For UNC paths, the path must point to a shared folder that is set up on the local computer.

See Also

Using cmdlets

Power Shell

iCore PowerShell Console

Administrator

Installing the Administrator
Managing roles and users