Skip to main content

Packages

Xenial Portal Data Management Packages

The Packages feature enables administrators to deploy a collection of Data Management updates together in a package. Sites are updated immediately upon deployment of the package -OR- on a scheduled date.

The Packages main menu includes the following selections:

Selection

Description

Active Packages

Create Package and manage packages that are not yet deployed to company sites.

Deployed Packages

View details about packages that have been deployed to company sites.

Create Package

Xenial Portal Data Management Packages Active Packages

To create a new package:

  1. From the upper-right of the Package List homepage, select New Package.

  2. In the Package Name field, type a name for the package.

  3. (Optional) To schedule the package deployment:

    • Toggle Schedule Changes to On.

    • In the Effective Date field, type the deployment date -OR- select the date from the popup calendar.

  4. From the upper-right of the screen, select Save.

Active Packages

Xenial Portal Data Management Packages Active Packages

A Data Management package that is not yet deployed to sites is "active". The following information is provided for each package on the Package List homepage:

Field

Description

Package Name

The name of the package. Select the package name to view the list of changes included in the package.

Scheduled

The date and time when the package is scheduled for deployment.

Created

The package creation date.

Created By

The name of the person who created the package.

Status

The status of the package deployment:

  • Ready

  • Ready to Deploy

  • Scheduled

  • In Progress

Huomaa

If an error occurred during an attempted deployment, "Deploy Error" is displayed in this column.

Select the "Deploy Error" link to view additional details.

Type

Indicates if the package was system-generated or manually created.

Edit Package

Xenial Portal Data Management Packages Active Packages

To edit an active package:

  1. From the Package List homepage, select the square to the left of the package.

  2. From the Actions dropdown, select Edit.

  3. In the Package Name field, type a name for the package.

  4. (Optional) To schedule the package deployment:

    • Toggle Schedule Changes to On.

    • In the Effective Date field, type the deployment date -OR- select the date from the popup calendar.

  5. From the Changes section, select the square to the left of the record to edit.

  6. From the Actions dropdown, select the desired action:

    Action

    Description

    Edit Object

    Open the respective Data Management editor and edit the record.

    Delete Changes

    Remove the record changes from the package.

  7. From the upper-right of the screen, select Save Changes.

Delete Package

Xenial Portal Data Management Packages

  1. From the Packages menu, select the applicable package type:

    Type

    Description

    Active Packages

    Open the list of packages that have NOT been deployed to sites.

    Deployed Packages

    Open the list of packages that have been deployed to sites.

  2. From the Package List homepage, select the square to the left of the package.

  3. From the Actions dropdown, select Remove.

  4. When prompted to confirm the operation, select Yes.

Deploy Package

Xenial Portal Data Management Packages Active Packages

Deploy a package to send the changes to company sites. Once the package is deployed, the sites will be updated after the next config data refresh.

To deploy one or more packages:

  1. From the Package List homepage, select the square to the left of the package(s).

  2. From the Actions dropdown, select Deploy Now.

  3. From the Deploy Package Now popup, select Deploy Now to confirm the deployment.

    • The number of affected sites is specified on the popup.

    • If the package is scheduled for deployment at a later date, the scheduled deployment is automatically canceled.

Deployed Packages

Xenial Portal Data Management Packages Deployed Packages

The following information is provided for each package on the Deployed Package List homepage:

Huomaa

To add additional columns to the list, select the 3-dot menu in the upper-right of the table.

Column

Description

Package Name

The name of the package

Created

The package creation date

Created By

The name of the person who created the package

Deployed

The date the package was deployed

Deploy Status

The status of the deployment

To view details about a deployed package:

  1. From the Deployed Package List homepage, select the package name.

  2. From the left menu pane, select General to view the list of changes included in the package.

  3. From the left menu pane, select Affected Sites to view the sites that received the package.

    The following details are provided:

    Field

    Description

    Site number / Terminal

    The site numbers and terminals that received the package.

    Site name

    The affected site name.

    Online

    The online status of the terminals.

    Deployed status

    The status of the deployment.

    Vihje

    Select the 3-dot menu to refresh the terminals with the latest Data Management configuration data.