The Xerox embedded app can be deployed to a device manually using a Xerox SDK tool known as the Xerox Registration Client (reg client). This is useful if deployment via HCP gateway fails.
At time of writing there is a known issue deploying the HCP embedded to the AltaLink 81* series – siteapp log will report “Unable to authenticate user” during deployment. For now it is recommended to use the reg client to deploy.
Important: This is an internal Xerox tool which is not meant for sharing with any non-Xerox personnel. As such we cannot make this freely available nor should we distribute it to partners. We should only use it on a customer device then delete it.
Usual required device settings:
- HTTPS enabled
- SNMP 1/2c enabled with GET/SET strings correctly set in HCP embedded config
- Device admin password is known
Using the Reg Client
The client is in the attached zip. It must be run from the same network as the Xerox device, requires direct connectivity, so will need sending to a site contact and using over a remote session.
In the zip is an .xml file for the embedded URLs. In this file do a find/replace for
Note – this XML file was created using an existing deployed embedded on HCP gateway 3.21. If there have been any changes since then the xml may be out of date. If the customer has a Xerox device which the client can be correctly deployed to, an accurate version can be generated using that device. Instructions on this are at the end of this KB article under “Creating a New XML from an Existing Device”.
When launching the client:
- Ensure the zip is fully extracted
- Ensure the exe is in the same directory as the DLL
- Run the exe as Administrator
Enter the device IP/DNS and admin credentials, then click Connect. If an unhandled exception occurs, click Continue and try Connect again after unchecking Use SSL. A successful connection will return the device cuiregistration URL and API version. Click Create.
Click Load from XML and select your updated XML file. Click Create. After a few seconds, the Load from XML popup will close. Pull Print should now be listed in the listbox on the first window.
Important: This method will not set the correct authentication type and address, these must also be done manually via the device web UI. Requirements:
- Authentication type: Convenience Authentication
- IP: Gateway IP
- Port: 8703
- Path: WebClientNG/Xerox/SmartAuthServerService
- Path correct as of gateway 3.21
On an AltaLink device this setting is located
Properties > Login/Permissions/Accounting > User Permissions > Edit adjacent to Xerox Secure Access > Manually Override Settings.
Device will require a reboot once the embedded app is deployed and authentication is set.
Creating a New XML from an Existing Device
Open the reg client and Connect to the functioning device, as detailed above. Once connected click List. Locate Pull Print in the list and click View. Save as XML will create a new XML file with the listed settings. Assuming the same gateway is required, the only necessary edit will be the Printer IP (addr= parameter) at the end of the Service Url.