Packages

Xenial Portal Data Management Packages

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

The Packages menu includes the following selections:

  • Active Packages - View/edit details about packages that are not yet deployed to sites.

  • Deployed Packages - View details about packages that are deployed to sites.

To create a new package, see Create a New Package.

Create a New Package

To create a new Data Management package:

  1. From the Xenial Portal, select Data Management.

  2. From the Packages menu, select Active Packages.

  3. Select New Package.

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

  5. (Optional) To schedule the deployment of the package for a specific date:

    • Set the Schedule Changes toggle to On.

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

  6. From the Save dropdown in the upper-right, select Save and Close.

To add changes to the package:

  1. Open the applicable Data Management editor.

  2. From the Package dropdown in the upper-right, select Select Package.

  3. From the Select Package popup, select the package, and then select Select Package.

    • The name of the dropdown in the upper-right changes to the name of the selected package.

  4. Make the necessary change(s) to the record.

  5. In the upper-right of the screen, select Add to Package to add the change(s) to the current package.

    • An orange package icon is displayed next to the field names that are updated in the current package.

    • On the main page of the Data Management editor, an orange package icon is displayed next to the records that are updated in the current package.

  6. Repeat steps 1-5 to add additional changes to the package.

    Vihje

    To view the list of changes included in the package, select View Package Details from the [Package Name] dropdown.

  7. To exit the package, select Exit Package from the [Package Name] dropdown.

Additional Actions

When editing a Data Management record, the following additional actions are available from the Add to Package dropdown:

  • Add to Other Package - Add the current record changes to a different package.

  • Apply Now - Apply the changes to the sites immediately.

  • Duplicate - Create a new record based on the existing record.

  • Delete - Delete the record.

View Active Packages

Xenial Portal Data Management Packages

An "Active" Data Management package is a package of configuration changes that has not yet been deployed to the site(s).

To view details about an Active package:

  1. From the Packages menu, select Active Packages. The following information is provided for each package on the Package List screen:

    • Package Name - The name of the package

    • Scheduled - The date and time when the package is scheduled to be deployed

    • Created - The package creation date

    • Created By - The name of the person who created the package

    • Deploy Errors - Any errors that may have occurred during an attempted deployment

    • Status - The status of the package deployment:

      • Scheduled - The package is scheduled for deployment on a specified date.

      • Open - The package is not scheduled for deployment.

      • Failed to Deploy - Package deployment to DM was unsuccessful.

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

  2. From the Package Name column, select the package name to view the list of changes included in the package.

Edit a Package

Xenial Portal Data Management Packages

To edit an Active Data Management package:

  1. From the Packages menu, select Active Packages.

  2. From the package list, select the square to the left of the package.

  3. From the Actions dropdown, select Edit.

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

  5. (Optional) To schedule the deployment of the package for a specific date:

    • Set the Schedule Changes toggle to On.

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

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

  7. From the Actions dropdown, select one of the following actions:

    • Edit Object - Open the record to edit the changes in the package. An orange package icon is displayed next to the field names that are changed in the package.

    • Delete Changes - Remove the record changes from the package,

  8. Select Save Changes.

Delete a Package

Xenial Portal Data Management Packages

  1. From the Packages menu, select the applicable option:

    • Active Packages - Open the list of packages that are not yet deployed to sites.

    • Deployed Packages - Open the list of packages that are deployed to sites.

  2. From the package list, select the square to the left of the package(s) to remove.

  3. From the Actions dropdown, select Remove.

  4. When prompted to confirm the package deletion, select Yes.

Deploy a Package

Xenial Portal Data Management Packages

Deploy a package immediately to update company sites with the changes in the package on the next POS refresh.

  1. From the Packages menu, select Active Packages.

  2. From the package list, select the square to the left of the package.

  3. From the Actions dropdown, select Edit.

  4. From the Save dropdown in the upper-right, select Deploy Now.

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

    • The number of affected sites is specified on the popup. The sites are immediately refreshed with the edits included in the package.

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

View Deployed Packages

Xenial Portal Data Management Packages

To view details about Data Management packages deployed to the site(s):

  1. From the Packages menu, select Deployed Packages. The following information is provided for each package on the Deployed Package List screen:

    • 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

    Huomaa

    To add additional columns to the package list, select the vertical blue ellipsis in the upper-right of the table.

  2. In the Package Name column, select the square to the left of the package name.

  3. From the Actions menu, select Edit.

  4. From the pane on the left, select the General page to view the following details:

    • The package name

    • The scheduled deployment date

    • The list of changes included in the package

  5. From the pane on the left, select the Affected Sites page to view the following details:

    • The site names and numbers that received the package

    • The affected terminals

    • The online status of the terminals

    • The status of the deployment

    Vihje

    Select the vertical blue ellipsis to refresh the terminals with the latest Data Management configuration data.