Adding packages

This section discusses adding packages in VHQ.

Use this when you need to upload a new software package to the Download Library.

You can add a software package to the Download library.

Add a package

1

Open the Download Library

Go to Device Management > Manage Downloads > Download Library, then select the folder (create a new one if required).

2

Choose a folder

Click the folder where you want to add the package (Root is the default).

3

Click Add Package

4

Browse and select the package

You can upload bundles (.TGZ, .tar files) for V/OS-based devices, VPI packages (.ZIP files), and Carbon tablet files (.APK files) for eVo-based devices. The .bintbl extension is used for VCL BIN table updates.

• The maximum file name length for packages uploaded to the VHQ download library is 248 characters, though the actual length may be further constrained by the target device:

  • MX8xx and MX760 devices: maximum 32 characters.
  • Verix eVo devices: maximum 32 characters.
  • MX9xx and Ux devices: maximum 85 characters.

5

Fill in the package details

1. Enter the Package Name.
2. Select the compatible device models from the Model(s) drop-down, or select All Models.
3. Select the Package Type: Application, Bundle, Feature Enablement License, Form, OS, Parameter File, or Service Pack.
4. Enter the Package Version and Tags (tags help you search for the package later in Download library).
5. Set the post-installation action to Reboot, Restart application(s), or None. If a download job has multiple packages with reboot specified, the server suppresses the reboot instruction on all but the last package.

6

Click Add

The package is added to Download Library.

On upload, the VHQ server checks for a manifest file or control file inside the package. If one exists, Validate for Download Automation remains selected by default and the package qualifies for automated download. If neither exists, the checkbox remains unselected and the software must be scheduled manually.

The V/OS bundles must contain control files, and VPI packages must contain manifest files, to qualify for automated downloads. See V/OS Bundle and VPI Package for details.

Package upload size

By default, the package file name can be 50 characters — contact the VCS team to change the configured value. Package file names uploaded through VHQ or the API are validated against this length; exceeding it shows: File name cannot exceed 50 characters. This change doesn't affect existing packages or path names created before the enhancement.

Guidelines

• The Post Install action is not supported for VX, Carbon, and PWM family packages. Carbon APK supports .zip. MX, Engage, and UX all support post-install actions for .tgz and .zip.
• Package Type and File version are for user information only — they aren't used in any processing logic.
• Post Install Action: Restart Application(s) doesn't restart the VHQ application on a device; it restarts all other running applications. If VHQ itself must restart after a download, select Reboot before uploading the file.

Validation rules

VHQ validates a package against the following scenarios during upload:

• VHQ won't allow adding a package with content identical to an existing one.
• Uploading a .zip or .tgz package containing files with duplicate names (including across nested folders) is restricted, with an error indicating duplicate files were found.
• A CP package (.zip) must include a manifest file in JSON format with Name, ID, Version, Type, Purpose, and Signatures:

"schema_version": "1.0", "application": {
 	"name": "ValidTestApp",
 	"id": "validTest-695973514",
 	"version": "1.0.0",
 	"type": "CP_ANDROID",
 	"purpose": "CP_INSTALL",
 	"signatures": [
 	"Android"
 	]
 	}
}

• CP package "purpose" can be "CP_INSTALL" or "CP_UNINSTALL" — both require a manifest file. CP_INSTALL requires an .apk file (only one is considered if multiple are present).

package: name='com.verifone.poc.validtestapp' versionCode='1' versionName='1.0.0' sdkVersion:'22'
targetSdkVersion:'22'
application: label='ValidTestApp' icon='res/mipmap-mdpi-v4/ic_launcher.png'
launchable activity name='com.verifone.poc.validtestapp.MainActivity'label='' icon=''
uses-feature:'android.hardware.touchscreen' main
supports-screens: 'small' 'normal' 'large' 'xlarge' supports-any-density: 'true'
locales: '--_--'
densities: '160' '240' '320' '480' '640'

• The name and version in the manifest file must match the label and version in the .apk file — mismatches are rejected.
• Uploading an uninstall package without its corresponding install package is rejected.
• A CP package can contain only one application.
• An OTA .zip must contain a build.prop file on extraction.
• The application purpose must be CP_ANDROID or CP_TERMAPP for automated download; other types can still be uploaded manually.
• CP install packages can't be CP_TERMAPP — they must be CP_ANDROID.
• A CP_ANDROID install package must contain the .apk file, or the upload is rejected.
• CP_UNINSTALL packages don't have .apk files.

If Package1.tgz and Package2.tgz both contain files abc.tgz and 123.tgz, VHQ won't allow the second package to be added.

In the Add package screen, the tab next to the package details lists the applications — including Bundle Name, Bundle Version, application name, application version, and the parameter definition file. This tab is only visible if the package is eligible for download automation.

Keywords

Also called: add package, upload package, download library upload. Search terms: manifest file, control file, package validation.