Difference between revisions of "BCX Package Tasks"

From BCX Media Wiki
Jump to navigation Jump to search
 
(56 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
able to run custom commands across multiple stations on the network.  
 
able to run custom commands across multiple stations on the network.  
  
No only does this simplify software installations, it also allows you to perform bulk management tasks with just a few clicks.
+
Not only does this simplify software installations, it also allows you to perform bulk management tasks with just a few clicks.
  
 
=='''How to Deploy a Package to your Network'''==
 
=='''How to Deploy a Package to your Network'''==
Line 9: Line 9:
 
Before you start to deploy a Package please ensure you have copied the Package files to your [[BCX_Package_Tasks#Central Packages Location|Central Packages Location]].
 
Before you start to deploy a Package please ensure you have copied the Package files to your [[BCX_Package_Tasks#Central Packages Location|Central Packages Location]].
  
From the Package Tasks Tab, click the Add Package Task menu, and select your required [[BCX_Package_Tasks#Package Types|Package Type]].
+
From the Packages Tab, click the Add Package Task menu, and select your required [[BCX_Package_Tasks#Package Types|Package Type]].
  
 
Alternatively you can drag your MSI file directly onto the Package Task List pane.
 
Alternatively you can drag your MSI file directly onto the Package Task List pane.
  
  
pic
+
[[File:bcx package tasks add.png|link=]]
  
  
Line 20: Line 20:
  
  
pic
+
[[File:bcx package tasks add file.png|link=]]
  
===Setting Package Task Details===
 
  
You should now amend the name for your Package Task to something logical as required.
+
The Package properties will then open at the Details tab.
  
[[BCX Package Tasks#Setting the Task Priority|Package Priority]] can be used to control the order in which this Package Task runs in relation to other tasks.
+
 
 +
[[File:bcx package tasks details.png|link=]]
 +
 
 +
 
 +
'''Package Name''' should be amended to something logical as required.
 +
 
 +
'''Priority''' can be used to control the order in which this Package Task runs in relation to other tasks. Tasks with Priority 10, will run before those with Priority 11.
  
 
Unless you have a specific reason to change it, we would recommend you leave this at the default value of 10.
 
Unless you have a specific reason to change it, we would recommend you leave this at the default value of 10.
  
 +
An example of this, could be that you have a piece of software that must be installed, and then a separate update patch applied after the install has taken place.
  
pic
+
'''Manual Station Assignments''' are used to specify the package deployment only. Once saved, ensure the Package Task you just added is selected in the left hand pane, then right click in the Station Assignments window, and then Add to choose your required [[BCX Assignments and Exceptions|Station Assignments]].
  
 +
'''Shortcut Linked''' is used to link the package to a shortcut. This means that where ever you assign the linked shortcut, the system will go away and make sure the package task has been run on those stations automatically. This saves you having to remember to assign both package tasks and shortcuts to stations independently. The shortcut drop down allows you to select the shortcut with which you want to link the package.
  
Next you need to decide how you want to assign your Package Task to your stations.
+
'''Package File Details''' displays the details for your package installer and any arguments allowing confirmation and editing if required.
 +
 
 +
'''Run Package Command''' will process the install command on the local station (Useful for testing and troubleshooting deployments).
 +
 
 +
'''Open Containing Folder''' opens the location of the installer in Windows Explorer.
  
  
 
'''Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network'''
 
'''Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network'''
  
 +
=='''X64 Bit Package File'''==
  
[[BCX Package Tasks#Linking Package Task to Shortcut|Linking your Package Task]] to a Shortcut will mean that where ever you assign a shortcut, the system will go away and make sure the package task has been run on those stations automatically, saving you having to remember to assign both package tasks and shortcuts to stations.
 
  
[[BCX Package Tasks#Manual Station Assignments|Manual Station Assignments]] allows you to run package tasks independently of shortcuts, useful for testing or deploying internet plugins for example.
+
Before you start to deploy a Package please ensure you have copied the Package files to your [[BCX_Package_Tasks#Central Packages Location|Central Packages Location]].
  
We would recommend you leave manual station assignments selected for now.
+
Whether you are adding or editing a package, you can add a 64bit package.  
Click OK to save, and move on to the next screen for setting the manual assignments.
 
  
===Manual Station Assignments===
+
The deployment process will only apply the package if it has been specified, and the target workstation is running a 64bit Operating System.
  
Ensure the Package Task you just added is selected and then right click in the Station Assignments window and choose Add
+
When adding a 64bit package as an MSI, MSU or Prism Package, you can browse to the package using the browse button.
  
pic
 
  
[[BCX Assignments and Exceptions|Add Station Assignments]]
+
[[File:bcx package tasks x64.png|link=]]
  
=='''Central Packages Location'''==
 
  
 +
Adding 64bit packages to a custom package type, is the same process as adding the default package.
 +
 +
Type the command in manually, or use the browse button to find the executable.
 +
 +
If you do not specify a 64bit package, the default package or command will be installed or run.
  
Your central Packages Location can usually be found at '''\\yourappsservername\packages$'''
+
=='''Advanced Options'''==
  
Alternatively you can double check this by looking at the file paths of exiting similar packages types,
 
or using [[BCX Manager Settings#Package Types|Edit Package Types]] under settings to view the Default Locations.
 
  
=='''Package Types'''==
+
[[File:bcx package tasks advanced.png|link=]]
  
  
 +
'''Limit by Operating System''' enable you to target a specific OS for deployment of a package, and for Windows 10 this further includes builds.
  
*'''MSI Install''' - A standard Microsoft Installer File used to install a piece of software.
+
'''Limit by Architecture''' allows deployment to any, or either x86 or x64 architectures.
*'''MSI Uninstall''' - A command used to uninstall a deployed Microsoft Installer Package.
 
*'''MSU Update''' - An MSU is a self-contained update format known as a 'Microsoft Update Standalone Installer'.
 
*'''Prism Package Install''' - A package created to deploy software where an MSI is not available.
 
*'''Prism Package Uninstall''' - A command used to uninstall a deployed Prism Package.
 
  
[[BCX Package Tasks#Custom Package Tasks|Custom Package Types]] can be used to run scripts or special installs using a setup.exe /argument where the executable can be run silently.
+
You can select restriction by both Operating System and Architecture if required.
  
[[BCX Manager Settings#Package Types|Edit Package Types]] can be used to add/amend the default package types.
+
For example, to restrict a package to 64bit versions of Windows 10 build 1903, you would select the radio button for x64 Only, and tick the boxes for Windows 10, and filter equal to 1903.
  
=='''Custom Package Tasks'''==
+
'''Package Tasks Exit Codes''' will display any non-standard exit codes relating to the task. There is a lookup function which will attempt to return the reason for the code.
  
Custom packages are used to deploy software that can not be packaged using Prism, or an MSI is not available.
+
If the package succeeds in installing, but still throws a non standard exit code, you can add it as an expected code on the task, and it won't be reported in the future.
  
Examples of software that can be deployed in this manor are Silverlight and Microsoft Office.
+
=='''Notes'''==
  
Before you start to deploy a Package please ensure you have copied the Package files to your [[BCX_Package_Tasks#Central Packages Location|Central Packages Location]].
+
This is a free form text area for your comments on the Package Task
  
From the Package Tasks Tab, click the Add Package Task menu, and select Custom.
+
[[File:bcx package tasks notes.png|link=]]
  
 +
=='''Package Tasks'''==
  
 +
This is a visual representation of the status of the actual deployment of the Package Task.
  
pic
+
Stations become aware of their relevant package tasks when their BCXClient syncs with the BCX Server.
  
  
 +
[[File:bcx package tasks package tasks.png|link=]]
  
Enter the command in the Package Command box that you wish to run on workstation. You can use the browse button to make this easier.
 
  
Add your arguments on to the end of the command and double check them below to check that it is formatted correctly.
+
'''Refresh''' performs a refresh of the window contents.
  
You can also click Run Package Command to test.
+
'''Create Tasks''' allows you to populate the window immediately after creating the task, without waiting for stations to sync.
  
pic
+
'''Export as CSV''' provides the option of creating a copy of the displayed information.
  
 +
'''RE Run Task''' will mark a completed entry as not completed and prompt to sync station to run the task again.
  
Next you need to [[BCX Assignments and Exceptions|assign]] your Package Task to your stations.
+
'''Mark Completed''' changes from not completed, this is useful if you need to Re Run a task that has previously completed.
  
 +
'''Sync Station''' forces the selected station(s) to sync with the BCX Server in order to process any Package Tasks.
  
'''Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network'''
+
'''View Options''' gives you the ability to show/hide application exit codes, and also show/hide tasks that are disabled or limited by OS.
  
=='''Setting the Task Priority'''==
+
=='''Custom Package Tasks'''==
  
 +
Custom packages are used to deploy software that can not be packaged using Prism, or an MSI is not available. (Typically those with setup.exe installers)
  
Package Priority can be used to control the order in which this Package Task runs in relation to other tasks.
+
Before you start to deploy a Package please ensure you have copied the Package files to your [[BCX_Package_Tasks#Central Packages Location|Central Packages Location]].
  
Unless you have a specific reason to change it, we would recommend you leave this at the default value of 10.
+
From the Package Tasks Tab, click the Add Package Task menu, and select Custom.
  
An example of this, could be that you have a piece of software that must be installed, and then a separate update patch applied after the install has taken place.
 
  
To edit the priority of a task, double click the Package Task, to open the task details, and change the priority number using the drop down.
+
[[File:bcx package tasks add custom.png|link=]]
  
To create long term flexibility we would recommend only deviating a few up or down from the default for your tasks of 10.
 
  
Tasks with Priority 10, will run before those with Priority 11.
+
The process is very similar to an msi package, but you provide the command and arguments manually
  
pic
+
Enter the command in the Package Command box that you wish to run on workstation. You can use the browse button to make this easier.
  
 +
Add your arguments on to the end of the command and double check them below the input window to confirm that it is formatted correctly.
  
 +
Custom Tasks are very versatile in that you can run commands as well as installing packages as shown below:
  
Click OK to Save
 
  
=='''Linking Package Task to Shortcut'''==
+
[[File:bcx package tasks custom command.png|link=]]
  
  
 +
Once you are happy with your command, you need to [[BCX Assignments and Exceptions|assign]] your Package Task to your stations.
  
Linking a Package to a Shortcut
 
  
Linking a package to a shortcut will mean that where ever you assign a shortcut, the system will go away and make sure the package task has been run on those stations automatically. This saves you having to remember to assign both package tasks and shortcuts to stations independently.
+
'''Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network'''
  
To link an existing task to a shortcut, double click the Package Task, to open the task details, and select Shortcut Linked.
+
=='''Central Packages Location'''==
  
You can now use the shortcut drop down to select the shortcut you want to link the package task too.
 
  
pic
+
Your central Packages Location can usually be found at '''\\yourappsservername\packages$'''
  
 +
Alternatively you can double check this by looking at the file paths of exiting similar packages types,
 +
or using [[BCX Manager Settings#Package Types|'''Edit Package Types''']] under settings to view the Default Locations.
  
Click OK to Save
+
=='''Package Types'''==
  
=='''X64 Bit Package Tasks'''==
 
  
 +
*'''[[BCX Package Tasks#Custom Package Tasks|Custom]]''' - can be used to run scripts or special installs using a setup.exe /argument where the executable can be run silently.
 +
*'''MSI Install''' - A standard Microsoft Installer File used to install a piece of software.
 +
*'''MSI Uninstall''' - A command used to uninstall a deployed Microsoft Installer Package.
 +
*'''MSU Update''' - An MSU is a self-contained update format known as a 'Microsoft Update Standalone Installer'.
 +
*'''Powershell Script''' - Run a Powershell script.
 +
*'''Prism Package Install''' - A package created to deploy software where an MSI is not available.
 +
*'''Prism Package Uninstall''' - A command used to uninstall a deployed Prism Package.
  
Deploy 64bit Package
+
[[BCX Manager Settings#Package Types|Edit Package Types]] in the Settings menu can be used to add new, or amend the default package types.
  
Before you start to deploy a Package please ensure you have copied the Package files to your (LINK to) Central Packages Location.
 
  
Whether you are adding or editing a package, you can add a 64bit package.
+
=='''Pending Package Tasks'''==
When adding a 64bit package the deployment process will only apply the package if it has been specified, and the target workstation is running a 64bit Operating System.
 
When adding a 64bit package as an MSI, MSU or Prism Package, you can browse to the package using the browse button.
 
  
pic
+
Selecting Pending Package Tasks from the Ribbon will display a table of the tasks not reported as completed.
  
  
Adding 64bit packages to a custom package type, is the same process as adding the default package.
+
[[File:bcx package tasks pending package tasks.png|link=]]
Type the command in manually, or use the browse button to find the executable.
 
If you do not specify a 64bit package, the default package or command will be installed or ran.
 
  
  
Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network
+
There are seperate tabs for: Tasks.
  
=='''Limiting to Operating System'''==
 
  
 +
[[File:bcx package tasks summary views all.png|link=]]
  
Limit Package by OS
 
Whether you are adding or editing a package, you can add an operating system limitation.
 
The options for this are found under the 'Advanced' tab.
 
  
pic
+
And: Station Summary.
  
You can select restriction by Operating System Architecture type or by Operating System version or a combination of both.
 
For example, to restrict a package to 64bit versions of Windows 7 and 8.1, you would select the radio button for x64 Only, and tick the boxes for Windows 7 and Windows 8.1
 
  
Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network
+
[[File:bcx package tasks summary views station.png|link=]]
  
=='''Summary Views'''==
+
=='''Unexpected Exit Codes'''==
  
  
Summary Views
+
To view a list of packages that are generating an unexpected exit code, select Unexpected Exit Codes from the Ribbon
  
From v3.0.1.4 there is a new function available from the Package Task Tab Ribbon:
 
  
Package Summary Views
+
[[File:bcx package tasks select unexpected exit codes.png|link=]]
  
pic
 
  
There are two options available, detailed below.
+
Here we see a report of any tasks that have run, but generated an unexpected exit code, with a right click option to assist in dealing with them.
  
View Pending Package Tasks
 
  
This will display a table of the tasks not reported as completed, with tabs for all packages or for packages by station.
+
[[File:bcx package tasks unexpected exit codes.png|link=]]
  
pic
+
=='''Updating a Package File'''==
  
View Unexpected Exit Codes
+
Updating a file for a package task is easy. Any package task that is an MSI or Prism package can be updated.
  
Here we see a report of any tasks that have run, but generated an unexpected exit code, with right click options as shown to assist in dealing with them.
 
  
See (LINK to) Package Task Exit Codes for more information.
+
Right click the package task you wish to modify, and select the 'Update Package Setup File' option. This will let you browse and select a new file to use in the task.
  
pic
 
  
=='''Unexpected Exit Codes'''==
+
[[File:bcx package tasks update file.png|link=]]
  
  
Exit Codes
+
You can then rerun the package task to update existing machines, or it will be used in all subsequent assignments.
  
Added in v3.0.1.4 there is now a function to help deal with exit codes.
 
  
If a package task ends with a non standard exit code, it is now detected and reported.
+
Custom types will have to be edited manually from within the task.
You can view this in the package task, on the Advanced tab as shown below.
 
  
From here you can use the Lookup button which will return a reason for the code (if available).
+
=='''Uninstalling deployed Package Tasks'''==
  
pic
+
To uninstall a package you need to tell BCX that you want this to happen. Removing the package task doesn't do this for you.
  
If the package succeeds in installing, but still throws a non standard exit code, you can add it as an expected code on the task, and it won't be reported in the future.
 
  
pic
+
For MSI installs and Prism packages right click and choose the option to convert to an uninstall task.
  
=='''Updating a Package File'''==
 
  
 +
[[File:bcx package tasks uninstall file.png|link=]]
  
Updating a Package File
 
Updating a file for a package task it easy. Any package task that is an MSI or Prism package can be updated.
 
Right click the package task you wish to modify, and select the 'Update Package Setup File' option.
 
This will let you browse and select a new file to use in the task.
 
  
pic
+
This will then ask you if you want to convert and rerun on all of the stations its assigned to.
 +
Once the package task has completed on all stations, you can then remove the task.
  
You can then rerun the package task to update existing machines, or it will be used in all subsequent assignments.
 
  
=='''Removing a Package Task'''==
+
Custom types will have to be done with a custom command line or script.
  
  
Removing packages
+
=='''Removing a Package Task'''==
Removing package tasks is a simple process.
 
Select the package you wish to remove. Once highlighted, click Remove Task in the ribbon at the top of the screen.
 
  
pic
+
Removing package tasks is a simple process. Select the package you wish to remove. right click, and choose the Remove Task option.
  
Removing a task will prevent it being redeployed to workstations in the future. It will not remove the package from the workstations it is currently assigned to.
+
MSI and Prism Package Tasks also include an option to delete the installation file.
To do this, please see (LINK to) Uninstalling deployed package tasks
 
On MSI or Prism package tasks, you can ask use the option below the delete the package task file from your packages folder too.
 
  
=='''Uninstalling deployed Package Tasks'''==
 
  
 +
[[File:bcx package tasks remove task.png|link=]]
  
Uninstalling a Package Task
 
To uninstall a package you need to tell BCX that you want this to happen. Removing the package task doesn't do this for you.
 
Click the option to convert the task to an uninstall task. You can do this on MSI installs and Prism packages.
 
Custom types will have to be done with a custom command line or script.
 
  
pic
+
Removing a task will prevent it being redeployed to workstations in the future. However, it will not remove the package from the workstations it is currently assigned to.
  
This will then ask you if you want to convert and rerun on all of the stations its assigned to.
+
To do this, please see [[BCX_Package_Tasks#Uninstalling deployed Package Tasks|Uninstalling deployed Package Tasks]].
Once the package task has completed on all stations, you can then remove the task.
 
  
 
=='''Importing and Exporting Package Tasks'''==
 
=='''Importing and Exporting Package Tasks'''==
 +
 +
From the Ribbon, choose Package Data, then Import or Export.
  
  
Packages Import and Export
+
[[File:bcx package tasks import export.png|link=]]
  
From v3.0.1.6 It is possible to import and export your package tasks.
 
  
 
This is especially useful if you are an academy with multiple BCX instances wanting to standardise packages across your schools.
 
This is especially useful if you are an academy with multiple BCX instances wanting to standardise packages across your schools.
  
pic
 
  
=='''Using the Create Software Package Wizard (Prism)'''==
 
  
Using the Create Software Package Wizard
+
=='''Creating a Package Task with Prism Deploy'''==
The software package wizard created a package using Prism that you can then distribute on your network.
 
Prism requires a relatively clean workstation, that has never had the software you intend to deploy, installed on it previously.
 
  
 +
The Prism Deploy software uses snaphot technology to create a package for deployment.
  
Click on the 'Create Software Package Wizard' button to start the wizard.
+
It creates a baseline for the workstation then after your required software is installed, compares the workstation to the baseline to create a package of the changes for deployment.
  
pic
+
Prism requires a relatively clean workstation, that has never had the software you intend to deploy installed on it previously.
  
 +
Download any software you will need to run before continuing.
  
Using the Create Software Package Wizard
+
On opening, Prism deploy presents you with the Prism deploy Package Expert wizard.
  
pic
 
  
The first page of the package wizard asks you to confirm a few details before continuing. Such as not restarting the computer during the package creation or changing the hardware.
+
[[File:bcx prism deploy wizard.png|link=]]
Work through these as a check list to double check, and press next when ready.
 
  
Using the Create Software Package Wizard
 
  
pic
+
Click next to begin and take the baseline image of the workstation.
  
Here you will be asked to prepare for the package creation. Download any software you will need to run before continuing.
 
Give the package a name here also, something meaningful so you can identify it easily within BCX Manager.
 
Clicking next will take a baseline image of the workstation you are working on, in order to detect changes after you are finished.
 
 
This can take a 5-10 minutes to complete depending on how much data is on the local disk.
 
This can take a 5-10 minutes to complete depending on how much data is on the local disk.
  
  
Using the Create Software Package Wizard
+
[[File:bcx prism deploy baseline.png|link=]]
  
pic
 
  
 +
Once the baseline has been taken, you will be asked to install your software.
  
Now you should see a little dialog like this near the taskbar. Allow this to finish and the wizard will return.
+
Install and configure your software exactly how you would like the end-user to use it.
  
pic
+
When you are happy that it is ready click next to continue.
  
  
Install your software at this point. Configure it exactly how you would like the end-user to use it including ticking 'Do not display' on dialog boxes.
+
[[File:bcx prism deploy install.png|link=]]
When you are happy that it is ready click next after working through the tick boxes.
 
This will then cause the wizard to hide again while another dialog as before appears, this time to take an after snapshot and compile the changes in to a package.
 
  
Using the Create Software Package Wizard
 
  
pic
+
A Windows File Explorer save window will open to allow you to Name and select a save location for the package.
  
When the capture has finished you will see this screen. You have the option to edit the package contents at this point.
+
This is usually your BCX Packages Directory \\servername\Packages$\Prism\filename.pwc
  
pic
 
  
You can browse the package like you would in a Windows Explorer window. Deleting any files or changes you dont want, or adding them as appropriate.
+
[[File:bcx prism deploy save.png|link=]]
  
Using the Create Software Package Wizard
 
You will have the option to import any shortcuts that were found during the build process at this point.
 
Simply tick the shortcuts you wish to import, and click the import shortcut button.
 
  
pic
+
When you click save, the package is created, it may take several minutes for the process to complete.
  
The next page will give you options to test you package on another workstation before deploying to other areas of the network.
 
Select the station you want to test with, and click 'Push Package to Test Station'
 
This will create a package task with the package assigned to the station selected.
 
Log in to the test station as multiple users for example, teachers, students and manager accounts. Check that it behaves as you would expect before.
 
Tick to confirm you have completed testing.
 
  
You will now be left with a package task that you can modify to deploy to the desired stations and the previously imported shortcuts to change too.
+
[[File:bcx prism deploy create.png|link=]]
 +
 
 +
 
 +
You will then be presented with an editing view of the changes that are included in the package.
 +
 
 +
You can browse the package like you would in a Windows Explorer window. Deleting any files or changes you don't want, or adding them as appropriate.
 +
 
 +
 
 +
[[File:bcx prism deploy edit.png|link=]]
 +
 
 +
 
 +
When happy with your package, close the editing window, and it is ready to deploy from BCXManager as a Prism Package Task.
  
 
=='''Troubleshooting Deployment of Package Tasks'''==
 
=='''Troubleshooting Deployment of Package Tasks'''==
  
Troubleshooting Deployment of Package Tasks
 
 
You can troubleshoot package task problems from within BCX Manager.
 
You can troubleshoot package task problems from within BCX Manager.
 +
 
Under Station Information, find the station that is having trouble installing a particular package. Right click it and click 'View Package Tasks for Station(s)'
 
Under Station Information, find the station that is having trouble installing a particular package. Right click it and click 'View Package Tasks for Station(s)'
  
pic
+
 
 +
[[File:bcx package tasks view tasks.png|link=]]
 +
 
  
 
This will show a list of completed and outstanding packages that are yet to be installed.
 
This will show a list of completed and outstanding packages that are yet to be installed.
 +
 
If a package is missing from this list you can force a Station Sync using the Station Sync button. This tells the computer to update with the server to check for new packages.
 
If a package is missing from this list you can force a Station Sync using the Station Sync button. This tells the computer to update with the server to check for new packages.
  
pic
+
 
 +
[[File:bcx package tasks list tasks.png|link=]]
 +
 
  
 
The last tab in the window is for Package Logs. Clicking this will make BCX manager retrieve a log from the station that contains in depth details about deployment.
 
The last tab in the window is for Package Logs. Clicking this will make BCX manager retrieve a log from the station that contains in depth details about deployment.
This will include exit codes and any errors that come up. One of the most common errors is when outstanding windows updates are due to be installed, and the installer fails to continue.
+
 
Restarting the workstation will fix this.
+
This will include exit codes and any errors that come up. One of the most common errors is when outstanding windows updates are due to be installed, and the installer fails to continue. Restarting the workstation will fix this.
 +
 
 +
 
 +
 
 +
Return to [[BCX_Network_Management_Tools|'''Contents page''']]

Latest revision as of 10:39, 5 September 2022

Package Tasks are used to deploy software MSIs, Prism packages and custom installers, as well as being able to run custom commands across multiple stations on the network.

Not only does this simplify software installations, it also allows you to perform bulk management tasks with just a few clicks.

How to Deploy a Package to your Network

Before you start to deploy a Package please ensure you have copied the Package files to your Central Packages Location.

From the Packages Tab, click the Add Package Task menu, and select your required Package Type.

Alternatively you can drag your MSI file directly onto the Package Task List pane.


bcx package tasks add.png


Now select the Package file you would like to deploy on your network and click Open


bcx package tasks add file.png


The Package properties will then open at the Details tab.


bcx package tasks details.png


Package Name should be amended to something logical as required.

Priority can be used to control the order in which this Package Task runs in relation to other tasks. Tasks with Priority 10, will run before those with Priority 11.

Unless you have a specific reason to change it, we would recommend you leave this at the default value of 10.

An example of this, could be that you have a piece of software that must be installed, and then a separate update patch applied after the install has taken place.

Manual Station Assignments are used to specify the package deployment only. Once saved, ensure the Package Task you just added is selected in the left hand pane, then right click in the Station Assignments window, and then Add to choose your required Station Assignments.

Shortcut Linked is used to link the package to a shortcut. This means that where ever you assign the linked shortcut, the system will go away and make sure the package task has been run on those stations automatically. This saves you having to remember to assign both package tasks and shortcuts to stations independently. The shortcut drop down allows you to select the shortcut with which you want to link the package.

Package File Details displays the details for your package installer and any arguments allowing confirmation and editing if required.

Run Package Command will process the install command on the local station (Useful for testing and troubleshooting deployments).

Open Containing Folder opens the location of the installer in Windows Explorer.


Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network

X64 Bit Package File

Before you start to deploy a Package please ensure you have copied the Package files to your Central Packages Location.

Whether you are adding or editing a package, you can add a 64bit package.

The deployment process will only apply the package if it has been specified, and the target workstation is running a 64bit Operating System.

When adding a 64bit package as an MSI, MSU or Prism Package, you can browse to the package using the browse button.


bcx package tasks x64.png


Adding 64bit packages to a custom package type, is the same process as adding the default package.

Type the command in manually, or use the browse button to find the executable.

If you do not specify a 64bit package, the default package or command will be installed or run.

Advanced Options

bcx package tasks advanced.png


Limit by Operating System enable you to target a specific OS for deployment of a package, and for Windows 10 this further includes builds.

Limit by Architecture allows deployment to any, or either x86 or x64 architectures.

You can select restriction by both Operating System and Architecture if required.

For example, to restrict a package to 64bit versions of Windows 10 build 1903, you would select the radio button for x64 Only, and tick the boxes for Windows 10, and filter equal to 1903.

Package Tasks Exit Codes will display any non-standard exit codes relating to the task. There is a lookup function which will attempt to return the reason for the code.

If the package succeeds in installing, but still throws a non standard exit code, you can add it as an expected code on the task, and it won't be reported in the future.

Notes

This is a free form text area for your comments on the Package Task

bcx package tasks notes.png

Package Tasks

This is a visual representation of the status of the actual deployment of the Package Task.

Stations become aware of their relevant package tasks when their BCXClient syncs with the BCX Server.


bcx package tasks package tasks.png


Refresh performs a refresh of the window contents.

Create Tasks allows you to populate the window immediately after creating the task, without waiting for stations to sync.

Export as CSV provides the option of creating a copy of the displayed information.

RE Run Task will mark a completed entry as not completed and prompt to sync station to run the task again.

Mark Completed changes from not completed, this is useful if you need to Re Run a task that has previously completed.

Sync Station forces the selected station(s) to sync with the BCX Server in order to process any Package Tasks.

View Options gives you the ability to show/hide application exit codes, and also show/hide tasks that are disabled or limited by OS.

Custom Package Tasks

Custom packages are used to deploy software that can not be packaged using Prism, or an MSI is not available. (Typically those with setup.exe installers)

Before you start to deploy a Package please ensure you have copied the Package files to your Central Packages Location.

From the Package Tasks Tab, click the Add Package Task menu, and select Custom.


bcx package tasks add custom.png


The process is very similar to an msi package, but you provide the command and arguments manually

Enter the command in the Package Command box that you wish to run on workstation. You can use the browse button to make this easier.

Add your arguments on to the end of the command and double check them below the input window to confirm that it is formatted correctly.

Custom Tasks are very versatile in that you can run commands as well as installing packages as shown below:


bcx package tasks custom command.png


Once you are happy with your command, you need to assign your Package Task to your stations.


Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network

Central Packages Location

Your central Packages Location can usually be found at \\yourappsservername\packages$

Alternatively you can double check this by looking at the file paths of exiting similar packages types, or using Edit Package Types under settings to view the Default Locations.

Package Types

  • Custom - can be used to run scripts or special installs using a setup.exe /argument where the executable can be run silently.
  • MSI Install - A standard Microsoft Installer File used to install a piece of software.
  • MSI Uninstall - A command used to uninstall a deployed Microsoft Installer Package.
  • MSU Update - An MSU is a self-contained update format known as a 'Microsoft Update Standalone Installer'.
  • Powershell Script - Run a Powershell script.
  • Prism Package Install - A package created to deploy software where an MSI is not available.
  • Prism Package Uninstall - A command used to uninstall a deployed Prism Package.

Edit Package Types in the Settings menu can be used to add new, or amend the default package types.


Pending Package Tasks

Selecting Pending Package Tasks from the Ribbon will display a table of the tasks not reported as completed.


bcx package tasks pending package tasks.png


There are seperate tabs for: Tasks.


bcx package tasks summary views all.png


And: Station Summary.


bcx package tasks summary views station.png

Unexpected Exit Codes

To view a list of packages that are generating an unexpected exit code, select Unexpected Exit Codes from the Ribbon


bcx package tasks select unexpected exit codes.png


Here we see a report of any tasks that have run, but generated an unexpected exit code, with a right click option to assist in dealing with them.


bcx package tasks unexpected exit codes.png

Updating a Package File

Updating a file for a package task is easy. Any package task that is an MSI or Prism package can be updated.


Right click the package task you wish to modify, and select the 'Update Package Setup File' option. This will let you browse and select a new file to use in the task.


bcx package tasks update file.png


You can then rerun the package task to update existing machines, or it will be used in all subsequent assignments.


Custom types will have to be edited manually from within the task.

Uninstalling deployed Package Tasks

To uninstall a package you need to tell BCX that you want this to happen. Removing the package task doesn't do this for you.


For MSI installs and Prism packages right click and choose the option to convert to an uninstall task.


bcx package tasks uninstall file.png


This will then ask you if you want to convert and rerun on all of the stations its assigned to. Once the package task has completed on all stations, you can then remove the task.


Custom types will have to be done with a custom command line or script.


Removing a Package Task

Removing package tasks is a simple process. Select the package you wish to remove. right click, and choose the Remove Task option.

MSI and Prism Package Tasks also include an option to delete the installation file.


bcx package tasks remove task.png


Removing a task will prevent it being redeployed to workstations in the future. However, it will not remove the package from the workstations it is currently assigned to.

To do this, please see Uninstalling deployed Package Tasks.

Importing and Exporting Package Tasks

From the Ribbon, choose Package Data, then Import or Export.


bcx package tasks import export.png


This is especially useful if you are an academy with multiple BCX instances wanting to standardise packages across your schools.


Creating a Package Task with Prism Deploy

The Prism Deploy software uses snaphot technology to create a package for deployment.

It creates a baseline for the workstation then after your required software is installed, compares the workstation to the baseline to create a package of the changes for deployment.

Prism requires a relatively clean workstation, that has never had the software you intend to deploy installed on it previously.

Download any software you will need to run before continuing.

On opening, Prism deploy presents you with the Prism deploy Package Expert wizard.


bcx prism deploy wizard.png


Click next to begin and take the baseline image of the workstation.

This can take a 5-10 minutes to complete depending on how much data is on the local disk.


bcx prism deploy baseline.png


Once the baseline has been taken, you will be asked to install your software.

Install and configure your software exactly how you would like the end-user to use it.

When you are happy that it is ready click next to continue.


bcx prism deploy install.png


A Windows File Explorer save window will open to allow you to Name and select a save location for the package.

This is usually your BCX Packages Directory \\servername\Packages$\Prism\filename.pwc


bcx prism deploy save.png


When you click save, the package is created, it may take several minutes for the process to complete.


bcx prism deploy create.png


You will then be presented with an editing view of the changes that are included in the package.

You can browse the package like you would in a Windows Explorer window. Deleting any files or changes you don't want, or adding them as appropriate.


bcx prism deploy edit.png


When happy with your package, close the editing window, and it is ready to deploy from BCXManager as a Prism Package Task.

Troubleshooting Deployment of Package Tasks

You can troubleshoot package task problems from within BCX Manager.

Under Station Information, find the station that is having trouble installing a particular package. Right click it and click 'View Package Tasks for Station(s)'


bcx package tasks view tasks.png


This will show a list of completed and outstanding packages that are yet to be installed.

If a package is missing from this list you can force a Station Sync using the Station Sync button. This tells the computer to update with the server to check for new packages.


bcx package tasks list tasks.png


The last tab in the window is for Package Logs. Clicking this will make BCX manager retrieve a log from the station that contains in depth details about deployment.

This will include exit codes and any errors that come up. One of the most common errors is when outstanding windows updates are due to be installed, and the installer fails to continue. Restarting the workstation will fix this.


Return to Contents page