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 |
|---|---|
Create Package and manage packages that are not yet deployed to company sites. | |
View details about packages that have been deployed to company sites. |
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:
NotaIf 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. |
Create Package
→ → →
To create a new package:
From the upper-right of the Package List homepage, select New Package.
In the Package Name field, type a name for the package.
(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.
From the upper-right of the screen, select Save.
Add Changes to Package
To add changes to a package:
Open the applicable Data Management editor (e.g. Product List).
From the Package dropdown in the upper-right of the editor, select Select Package.
From the Select Package popup, follow these steps to select the package:
To the left of the package name, select the square to select the package.
From the lower-right of the Select Package window, select Select Package.
Nota
Once selected, the package dropdown in the upper-right of the Data Management editor will be labeled with the name of the selected package.
Return to the Data Management editor and make the necessary changes to the records.
From the upper-right of the Data Management editor, select Add to 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.
Repeat steps 1-5 to add additional changes to the package.
Sugerencia
From the package dropdown in the upper-right, select View Package Details to view the changes included in the package.
From the package dropdown in the upper-right, select Exit Package to exit the package.
Other Package Actions
When editing a Data Management record, the following actions are available from the Add to Package dropdown in the upper-right of the screen:
Action | Description |
|---|---|
Add to Other Package | Add the current record changes to a different package. |
Apply Now | Apply the record changes to the sites immediately. |
Duplicate | Create a new record based on the existing record. |
Delete | Delete the record. |
Edit Package
→ → →
To edit an active package:
From the Package List homepage, select the square to the left of the package.
From the Actions dropdown, select Edit.
In the Package Name field, type a name for the package.
(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.
From the Changes section, select the square to the left of the record to edit.
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.
From the upper-right of the screen, select Save Changes.
Deploy Package
→ → →
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:
From the Package List homepage, select the square to the left of the package(s).
From the Actions dropdown, select Deploy Now.
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.
Delete Package
→ →
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.
From the Package List homepage, select the square to the left of the package.
From the Actions dropdown, select Remove.
When prompted to confirm the operation, select Yes.
Deployed Packages
→ → →
The following information is provided for each package on the Deployed Package List homepage:
Nota
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:
From the Deployed Package List homepage, select the package name.
From the left menu pane, select General to view the list of changes included in the package.
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.
Sugerencia
Select the 3-dot menu to refresh the terminals with the latest Data Management configuration data.