BCX Package Tasks
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.
No only does this simplify software installations, it also allows you to perform bulk management tasks with just a few clicks.
Contents
- 1 How to Deploy a Package to your Network
- 2 Central Packages Location
- 3 Package Types
- 4 Custom Package Tasks
- 5 Setting the Task Priority
- 6 Linking Package Task to Shortcut
- 7 X64 Bit Package Tasks
- 8 Limiting to Operating System
- 9 Summary Views
- 10 Unexpected Exit Codes
- 11 Updating a Package File
- 12 Removing a Package Task
- 13 Uninstalling deployed Package Tasks
- 14 Importing and Exporting Package Tasks
- 15 Using the Create Software Package Wizard (Prism)
- 16 Troubleshooting Deployment of Package Tasks
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 Package Tasks 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.
pic
Now select the Package file you would like to deploy on your network and click Open
pic
Setting Package Task Details
You should now amend the name for your Package Task to something logical as required.
Package Priority can be used to control the order in which this Package Task runs in relation to other tasks.
Unless you have a specific reason to change it, we would recommend you leave this at the default value of 10.
pic
Next you need to decide how you want 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
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.
Manual Station Assignments allows you to run package tasks independently of shortcuts, useful for testing or deploying internet plugins for example.
We would recommend you leave manual station assignments selected for now. Click OK to save, and move on to the next screen for setting the manual assignments.
Manual Station Assignments
Ensure the Package Task you just added is selected and then right click in the Station Assignments window and choose Add
pic
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
- 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'.
- 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.
Custom Package Types can be used to run scripts or special installs using a setup.exe /argument where the executable can be run silently.
Edit Package Types can be used to add/amend the default package types.
Custom Package Tasks
Custom packages are used to deploy software that can not be packaged using Prism, or an MSI is not available.
Examples of software that can be deployed in this manor are Silverlight and Microsoft Office.
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.
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 to check that it is formatted correctly.
You can also click Run Package Command to test.
pic
Next 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
Setting the Task Priority
Package Priority can be used to control the order in which this Package Task runs in relation to other tasks.
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.
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.
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.
pic
Click OK to Save
Linking Package Task to Shortcut
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.
To link an existing task to a shortcut, double click the Package Task, to open the task details, and select Shortcut Linked.
You can now use the shortcut drop down to select the shortcut you want to link the package task too.
pic
Click OK to Save
X64 Bit Package Tasks
Deploy 64bit Package
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.
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
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 ran.
Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network
Limiting to Operating System
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
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 10 build 1903, you would select the radio button for x64 Only, and tick the boxes for Windows 10, and filter equal to 1903.
Remember it is advisable to test your Package Task on one or two machines first before deploying to your whole network
Summary Views
Summary Views
From v3.0.1.4 there is a new function available from the Package Task Tab Ribbon:
Package Summary Views
pic
There are two options available, detailed below.
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.
pic
View Unexpected Exit Codes
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.
pic
Unexpected Exit Codes
Exit Codes
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. 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).
pic
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
Updating a Package File
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
You can then rerun the package task to update existing machines, or it will be used in all subsequent assignments.
Removing a Package Task
Removing packages 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 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. 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
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
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.
Importing and Exporting Package Tasks
Packages Import and Export
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.
pic
Using the Create Software Package Wizard (Prism)
Using the Create Software Package Wizard 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.
Click on the 'Create Software Package Wizard' button to start the wizard.
pic
Using the Create Software Package 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. Work through these as a check list to double check, and press next when ready.
Using the Create Software Package Wizard
pic
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.
Using the Create Software Package Wizard
pic
Now you should see a little dialog like this near the taskbar. Allow this to finish and the wizard will return.
pic
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.
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
When the capture has finished you will see this screen. You have the option to edit the package contents at this point.
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.
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
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.
Troubleshooting Deployment of Package Tasks
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)'
pic
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.
pic
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.