Creating and deploying a cobranding package

To use the cobranded version of Spotfire, you must create and deploy a package containing the updated cobranding.config XML file together with any images and custom files, such as the custom header HTM file, or custom login files, that are needed.

Before you begin

You must have the following in a local folder:
- An edited cobranding.config file.
- All the images you plan to include.
- All the files you need. For example, if you plan to use a custom header, a custom header .htm file.
For cobranding to work on a Linux system, it is recommended to use "zip" as archive format, see the argument "/archiveformat:" in the section Package Builder console parameter reference, in the Spotfire Developer Documentation. Otherwise, cabextract must be installed on the computers running the Spotfire Server and the node managers (if you have node managers running on Linux).
To use the cobranding package with a Web Player running on Linux as well as for the Spotfire installed client and Web Player for Windows, the package must use IntendedPlatform="UNIVERSAL" and TargetFramework="ANY". Read more about building packages for Linux in the Spotfire Developer Documentation.

Note: You must use the Spotfire Package Builder console to create the cobranding package.

Procedure

Download and unpack the Spotfire Developer software, which is available under Spotfire Server on the Spotfire Download site.
For download instructions, see the Spotfire Developer documentation.
In the Templates folder in the SDK, there is a file called Cobranding_Example.pkdesc, that can be used as a template for specifying what cobranding artifacts that should be included.

Note: Always generate a new GUID for the XML attribute "SeriesId".
Open a command window and go to the folder where the cobranding pkdesc-file is located, and type the following command (modify paths and filenames as needed):
```
Spotfire.Dxp.PackageBuilder-Console.exe
/targettype:package /pkdesc:"Cobranding.pkdesc"
/basefolder:"<path to folder where the artifacts are stored>"
/target:"Cobranding.spk" /archiveformat:zip /saveunpackedmodule
/unpackedmodulefolder:"<path to a folder>"
```
Note: The two last arguments are only needed if the package should be tested in the installed client, see step 4 and 5.
To test you package in the installed client, you must know the path to your installed client.
For example:
- For a shared computer setup, this folder is usually located at: C:\Program Files (x86)\Spotfire\<version number>\Spotfire.Dxp.exe
- For a single user setup, the path to this folder is usually similar to: C:\Users\<username>\AppData\Local\Spotfire\<version number>\Spotfire.Dxp.exe
To test the package locally, on the command line, type the following (where <path to a folder> below is the folder that was referenced by the argument /unpackedmodulefolder when building the package):
```
<path to installed client> /loadallmodules /addmodulefolder:"<path to a folder>"
```
Deploy the cobranding package to Spotfire Server.
For instructions, see Adding software packages to a deployment area in the Spotfire Server and Environment - Installation and Administration guide.
Important: The cobranding package must be deployed on the default deployment area.

What to do next

If updates are not applied automatically to the default deployment area, make sure that end users accept the update when connecting to the server.
If you are adding a custom header to the web client, you must update the Web Player services on each node of the collective. For instructions, see "Updating services" in the Spotfire Server help.