Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Export

Create Version

In order to create a new version, go through the following steps:

  • Enter the “Create Version” tab of the Export section
  • [In the explorer]

    Click on the explorer entry corresponding to the level of detail you want to see:

    • If you want to browse the content for all projects, click on all projects and flag the version column for every object to be included in the version
    • If you want to browse the content for a specific project type, click on the corresponding explorer entry and flag the version column for every object to be included in the version
    • If you want to browse specific content for one project, click on the corresponding project in the explorer and flag the version column for every object to be included in the version
  • [In the Grid toolbar]
    • Select the workspace corresponding to the projects you want to version. By default, it will show the current workspace.
  • [In the Grid toolbar] (this is an optional step)
    • Click on the function Verify dependencies. This function will browse the projects and/or objects you’ve chosen to version and will automatically identify depending objects, in order to ensure that the repository will remain consistent.
  • [In the Grid toolbar]
    • Click on the function Version selected objects or Fix selected objects (depending on the release chosen on the dashboard).
  • [In the popup] (only if you are creating a version) Enter the following information:
    • Name: enter a name for the version.
      • This name should be unique.
        Warning: The name must not end with a '.' (dot) character or it will compromise the export of that version in further steps of its lifecycle.
  • Comment: enter a description of what has been modified in this version.
  • Date: choose the date and time starting from which this version will be active.
    • The application date that you enter should be later then the application date of the previous version. - In the selector allowing you to enter the date, you have the ability to click on "Today". Pay attention to the fact that "Today" is the date obtained from the CPQ server and not from the computer of the end user.
  • Check (or uncheck) the “export the version” function
    • This function will immediately export the version in order to make it available for subscribers.
  • Check (or uncheck) the “generate database cache” function
    • This function will automatically generate the database cache for the version being created.
  • Check (or uncheck) the “generate Search Index” function
    • This function will automatically generate the search index for the version being created.
  • Check (or uncheck) the “generate Sitemap” function
    • This function will automatically generate the sitemap for the version being created.
  • Check (or uncheck) the "Push metadata to CRM" function. The checkbox is visible only if a corresponding Java class is declared in the cameleon.properties file on the server. If checked, the "export the version" function is automatically checked as well.
    • This function will automatically push CPQ XML structure to a CRM like MS Dynamics, so that CRM and CPQ meta elements remain in sync, meaning that every change done on the model in CPQ is proactively applied accordingly in the CRM. The declared Java class will be called automatically on a successful export.
  • [In the popup, if File type= Excel] - Enter the locale language. The chosen language will be used as the original language for translations.

The versioning progress is shown in the table (in the working section) and will show Versioning succeeded when the process has been successfully completed. If not, it will indicate the reason of failure.

In order to quickly create a version holding all the objects of a set of workspaces, proceed as follows:

  • [In the Grid menu]
    • Select the workspace corresponding to the projects you want to version.
      • By default, it will show All workspaces.
    • Click on “One-click version” (alternatively, click on “One-click fix”)
    • Depending on the currently selected version, the button will:
    • Open a Quick version pop-up if the selected version is the Working version
    • Open a Quick fix pop-up if the selected version is not the Working version
    • Select the workspace corresponding to the projects you want to version.
    • By default, “All workspaces” are selected but you can change the value to the current workspace or to proceed to a selection of workspaces.
    • Check (or uncheck) the “export the version” function
    • This function will immediately export the version in order to make it available for subscribers.
    • Check (or uncheck) the “generate database cache” function
    • This function will automatically generate the database cache for the version being created.
    • Check (or uncheck) the “generate Search Index” function
    • This function will automatically generate the search index for the version being created.
    • Check (or uncheck) the “generate Sitemap” function
    • This function will automatically generate the sitemap for the version being created.
    • Check (or uncheck) the "Push metadata to CRM" function. The checkbox is visible only if a corresponding Java class is declared in the cameleon.properties file on the server. If checked, the "export the version" function is automatically checked as well.
    • This function will automatically push CPQ XML structure to a CRM like MS Dynamics, so that CRM and CPQ meta elements remain in sync, meaning that every change done on the model in CPQ is proactively applied accordingly in the CRM. The declared Java class will be called automatically on a successful export.
    • Click on Create

Manage Publishers

This step allows the administrator to setup the security settings for the publisher. In particular, this page allows fulfilling the Publisher security key.

Audit Exports

This step allows you to manually publish versions, meaning that you can trigger the export of a particular version. Exports are issued to a folder which has been setup in the cameleon.properties file.

Exports can be done in 2 ways: incrementally or full.

Definition:

A full export will contain the complete image of the version (or fix), including items which have been created or modified in previous versions but which have not been modified in the version to be exported.

An incremental export will contain only the differences between the exported version (or fix) and the previous version (or fix).

Tip: In the context of an automatic distribution process, all exports are done incrementally. Full exports will typically not be used, unless you want to restore a node in a cluster.

In order to export a version or a fix:

  • [In the menu toolbar]
    • Click on the function Export
  • [In the popup]
  • Fill in the following information:
    • Choose version: choose the version export.
    • Choose fix: choose the level of fix to export.
    • Choose export mode: incremental or full
    • Choose the file type: zip or xml
    • (optionally) flag the checkbox to export the RMO Gallery
    • (optionally) flag the checkbox to export the Configurator theme(s)
      information: It is also possible to export a working version or a working fix.

When exporting the Rich Media Gallery, an additional zip file will contain all files and folders of the rich media gallery folder, which has been setup in the cameleon.properties file. Likewise, when exporting the themes, an additional zip file will contain the Configurator layout XML file(s) and the associated themes (including css files and graphical resources).

Whenever a version is scheduled for export, a line will be added to the table in the working section. This table contains the following information:

COLUMN DESCRIPTION
Version type Fix or Version.
Export type Delta (= incremental) or Full.
Version The name of the version which has been exported. The following possibilities can be shown: Whenever a version is exported, the label of the version is shown, e.g. “v1” Whenever the working version is exported, the text “working version” is shown Whenever a fix is exported, the label of the version is shown together with the fix number, e.g. “v1 fix 1”. Whenever a working fix is exported, the version label is shown together with the text “working fix”, e.g. “v1 – working fix”.
Original version If the export type is incremental, indicates the name of the original version used to create the “delta” file.
Application date The application date of the version which has been exported.
Publisher name The publisher name used for this export
COLUMN DESCRIPTION
Export status The status of the export. Click on the status in order to see the details.
Export timestamp The date & time the export started.
Export duration The duration of the export.
Model Link to download the exported xml or zip file.
Rich Media Gallery Link to download the export rich media gallery.
Themes Link to download the theme(s)
Metadata Sync Status of the metadata push to CRM when activated

At any time, lines in this table (and associated export files) can be removed by checking these lines and clicking on the Delete function in the menu toolbar.