1E 9.x (on-premises)

You can test the API and observe the results for a specific computer from a browser with the following by replacing <WebServiceBaseURL >, <Domain>, and <MachineName> with the necessary details:

<WebServiceBaseURL>/platform/api/applicationmigration/getApplicationsToBeInstalled/?domainName=<Domain>&machineName=<MachineName>

where:

Browsing to the URL returns a JSON file with a list of Applications and Packages that will be installed on the specified device when the task sequence executes.

This list is used to populate two series of task sequence variables (one for Applications and the other for Packages) that can be used by the standard Configuration Manager Install Application and Install Package steps to dynamically install each application and package returned by the API.

In 1E platform v9.1, the Authentication Proxy has been deprecated. In previous platform versions, the Authentication Proxy invoked the Application Migration TS API. From 1E 9.1, the Background Channel Proxy is employed to access the TS API by using the client computer certificate.

Upgrading earlier versions of the 1E Toolkit

Configuring Background Channel Proxy

To call the TS API from 1E TS Tools, you must configure the Background Channel service web.config. You can do this by either, adding the entry manually or by using our PowerShell script.

Editing the web.config manually

In the manual web.config update, you should replace your-host in the targetURL with the value for your environment.

<ProxiedServers>  
<Targets>

..  
<add name="ApplicationMigrationTaskSequence" enabled="true" targetURL="https://your-host/platform/api/applicationmigration/getApplicationsToBeInstalled" timeoutSeconds="15" clientCertificateForTarget="" useWindowsAuthenticationForTarget="false" useServerTokenAuthenticationForTarget="true" deviceAuthentication="Certificate" forwardCertificateFromDevice="false" loggingLevel="off" />  
..

</Targets>

</ProxiedServers>

Editing the web.config using PowerShell

Run the script using PowerShell, and provide the SLAPlatform base url: .\AddReclaimerBGProxy.ps1 https://{host}/Platform

param(
    [Parameter(Mandatory = $true, HelpMessage = "Enter SLA platform base URL e.g. : tachyon.testlab.com/platform or https://tachyon.testlab.com/platform")]
    [ValidateNotNullOrEmpty()]
    [string] $SLAPlatformBaseURL,

    [Parameter(Mandatory = $false, HelpMessage = "Path to web.config of the background channel web.config")]
    #[ValidateNotNullOrEmpty()]
    [string] $FilePath = "C:\Program Files\1E\Tachyon\Background\Web.config",

    [Parameter(Mandatory = $false, HelpMessage = "Enter the key Name to be used in the Web.Config")]
    #[ValidateNotNullOrEmpty()]
    [string] $BGPKeyName = "ApplicationMigrationTaskSequence"
)

# load the XML from the web.config
$xml = New-Object XML
$xml = [xml](Get-Content $FilePath)

Write-Host "Using SLA platform base URL :"$SLAPlatformBaseURL
Write-Host "Using FilePath BG Web.config :"$FilePath
Write-Host "Using BGP Key Name:"$BGPKeyName

if (![System.IO.File]::Exists($FilePath)) {
    Write-Error "File doesnot exists with path $FilePath"
    return;
}

if ($xml.SelectNodes("//configuration/ProxiedServers").Count -eq 0) {
    Write-Host "Proxied Servers doesnot exists.";
    Write-Host "Adding Proxied Servers in Configuration";
    $proxiedServers = $xml.CreateElement("ProxiedServers")
    $proxiedServers.AppendChild($xml.CreateElement("Targets"))
    $xml.configuration.AppendChild($proxiedServers);
}
$SLAPlatformBaseURL=$SLAPlatformBaseURL.TrimEnd('/')
$nodes = $xml.SelectNodes("//configuration/ProxiedServers/Targets/add[@name='$BGPKeyName']") 
if ($nodes.count -eq 0) {
    #<add name="ApplicationMigration" enabled="true" targetURL="https://stalyon.ntl.local:443/platform/api/applicationmigration/getApplicationsToBeInstalled" timeoutSeconds="15" 
    #clientCertificateForTarget="" useWindowsAuthenticationForTarget="false" useServerTokenAuthenticationForTarget="true" 
    #deviceAuthentication="Certificate" forwardCertificateFromDevice="false" loggingLevel="off" />
    Write-Host "Adding $BGPKeyName to ProxiedServers Targets."
    $setting = $xml.CreateElement('add')
    $setting.SetAttribute('name', $BGPKeyName)  
    $setting.SetAttribute('enabled', 'true')  
    $setting.SetAttribute('targetURL', $SLAPlatformBaseURL + '/api/applicationmigration/getApplicationsToBeInstalled')   
    $setting.SetAttribute('timeoutSeconds', '15')  
    $setting.SetAttribute('clientCertificateForTarget', '')   
    $setting.SetAttribute('useWindowsAuthenticationForTarget', 'false')  
    $setting.SetAttribute('useServerTokenAuthenticationForTarget', 'true')   
    $setting.SetAttribute('deviceAuthentication', 'Certificate')  
    $setting.SetAttribute('forwardCertificateFromDevice', 'false')    
    $setting.SetAttribute('loggingLevel', 'off')    

    $xml.SelectNodes("//configuration/ProxiedServers/Targets")[0].AppendChild($setting)
}
else {
    Write-Host "Updating the  $BGPKeyName in ProxiedServers Targets. "
    $setting = $nodes[0];
    $setting.SetAttribute('enabled', 'true')  
    $setting.SetAttribute('targetURL', $SLAPlatformBaseURL + '/api/applicationmigration/getApplicationsToBeInstalled')   
    $setting.SetAttribute('timeoutSeconds', '15')  
    $setting.SetAttribute('clientCertificateForTarget', '')   
    $setting.SetAttribute('useWindowsAuthenticationForTarget', 'false')  
    $setting.SetAttribute('useServerTokenAuthenticationForTarget', 'true')   
    $setting.SetAttribute('deviceAuthentication', 'Certificate')  
    $setting.SetAttribute('forwardCertificateFromDevice', 'false')    
    $setting.SetAttribute('loggingLevel', 'off')   
}
Write-Host "Saving to file inprogress.";
$xml.Save($FilePath)

Write-Host "Successfully updated the Web.config of Background channel for Proxy."

Recreate your Application Migration Task Sequence step

To enable Modern Authentication, review your previous task sequences that used the Application Migration Task Sequence step; otherwise, they will not function correctly.

The AppMigration action is used to create the 1E Application Migration Task Sequence step, and has the following properties.

The following example illustrates how to add the Application Migration step to an existing OS Deployment task sequence. Your own task sequence may differ, but the general positioning of these steps is where Install Application steps would normally be placed (after Install Updates and before the Restore User Files).

Application Migration step

Choose Add > 1E OSD > AppMigration.

On the Properties tab, enter the following details.

Note

1E 9.1 users refer to Modern Authentication support for TS Tools 2.6 for changes to this section.

1. In Web Service Base URL, enter the location for the platform, for example http://tachyon.acme.local/

2. Under Credentials (for Web service call) enter the Domain\User Name and Password for the platform user you want to use.

3. Source Computer Domain in most cases the source computer domain will be the same domain that the OS is being deployed in. If you are migrating computers from one domain to another through the OS deployment process, you must select the Specify Domain option and enter the Fully Qualified Domain Name of the originating domain, as this will be the domain that the computer belongs to in the platform from previous inventory.

4. In Source Computer Name Variable leave the value at its default SourceComputerName.

5. In Application Variable choose the base variable that is used to define the dynamic applications. In our example, it is AppMig.

6. In Package Variable choose the base variable that is used to define the dynamic packages. In our example, it is PkgMig.

7. Click Apply.

Install Application step

Choose Add > Software > Install Application.

On the Properties tab:

1. Select the Install applications according the dynamic variable list option.

2. In Base variable name, enter the application variable. In our example, it is AppMig (see step 5 above).

3. If you want the task sequence to continue installing other applications in the event if an application install fails, select the If an application installation fails, continue installing other applications in the list option.

On the Options tab:

1. Click Add Condition and enter condition to check if Task Sequence Variable APPMIG01 exists (or the application variable you defined in the 1E Application Migration step with 01 appended).

   

2. Click Apply.

There are five task sequence variables used by Application Migration:

Role Based Application Sets can optionally be used in each of the deployment scenarios. A Role Based Application Set defines a set of applications that should be installed on a computer for a user performing a particular role, or perhaps working at a particular location.

For this to work, the task sequence must contain the variable IncludeRoleBasedAppsForExistingPC set to a value of true, as shown.

Application Migration uses the Install Application and Install Package steps in a Task Sequence to install migrated applications and packages. These Task Sequence steps are dependent on the relevant checkbox (auto install flag) being enabled for each application and package:

If a checkbox is not enabled, the software installation will fail for that application or package. An administrator can enable this checkbox for each application and package by using either of the following methods:

Refer to Managing migration rules: Auto Install for Migration Rules and Role Based Application Sets: Auto Install for Configuration Manager Applications and Packages.

Applications

The checkbox is located on the General Information tab of the Properties window for a Configuration Manager Application as shown.

Packages

The checkbox is also present on the Advanced tab of the Properties window of a Configuration Manager Package program as shown.

If you intend to use Application Migration to migrate applications from an old computer to a new computer (Replace scenario), you may need to include the Get migration settings step in your Task Sequences. The Get Migration Settings Task Sequence step retrieves information from a Computer Association in Configuration Manager so it can determine the source computer when installing applications on the new computer. It is currently distributed with Nomad and is added to the Task Sequence Editor by installing NomadBranchTools.msi. Please refer to Installing Nomad Branch Tools for more information.