Develop > CSA Content SDK > Build Your First Capsule > Create Capsule Definition file

Create Capsule Definition File

A Capsule definition file is required to build a Capsule with the SDK packager tool. This file describes high-level metadata that can be displayed while importing and displaying Capsule level information.

To create capsule definition file:

  1. Find the sample capsule.xml file available under /xsd directory of the Content SDK.
  2. Copy the file to your content depot directory.
  3. Enter the required details within appropriate tags by referring the below Capsule File Example:

    Capsule File Example

    <?xml version="1.0" encoding="utf-8"?>
    <buildCapsule sign=true/false>
    		<usecase name="HPE OpenStack" path=“/Usecase Depot/" />
    • Name of the use case: <usecase name="HPE OpenStack" (This is use case directory name).
    • Path of the use case: path=“/Usecase Depot/" /> (This is the path to the parent directory of the use case, which is Use case Depot)
    • Name of the output capsule name: <capsuleName></capsuleName>
    • Location of the output directory name: <outputDir></outputDir>
    • Path to the organizational image logo that appear in the Auto-generated Capsule document:<logo></logo>
    • Complete path of the XSLT file (Optional): <xsltFilePath></xsltFilePath>
      • You can ignore providing the path of the XSLT file, if you do not wish to customize the output of the document as per your requirements.
      • If you wish to customize the output document by editing the XSLT file, see Automatic Document Generation Feature.
    • Note: You must complete editing the XSLT file before moving to Step 4.

    • Provide the Project name, which has the LDAP group configured for HPE Signing: <signProjectName></signProjectName>

      For more information on HPE Signing, see Capsule Signing Feature.

  1. Open the command prompt and execute the following command to generate the capsule:
    java -jar CapsulePackager.jar -i capsule.xml