Difference between revisions of "Package Items"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 138: Line 138:


====How Package Items are Applied====
====How Package Items are Applied====
These principles describe the behavior of package items at installation time. (A detailed table of elements follows this summary.)
The principles that follow summarize the behavior of package items at installation time. Detailed tables list the behavior for individual items, following the summary.
 
=====Principles=====
:* New items in the Package are added to the subscriber's system.
:* New items in the Package are added to the subscriber's system.
:* If the subscriber created a new platform element with the same name as an item included in the package, the subscriber gets an error. (The error occurs immediately after they select the package. Installation is not allowed to proceed.)
:* If the subscriber created a new platform element with the same name as an item included in the package, the subscriber gets an error. (The error occurs immediately after they select the package. Installation is not allowed to proceed.)
Line 148: Line 150:
:* Items deleted from the packager's application are never deleted from the subscriber's system unless the [[Overwrite Previous Package]] option has been enabled by the Service Provider, and the packager has chosen the ''Overwrite'' option. (Then, and then only, items deleted from the Service Provider's system are deleted from the subscriber's system when the package is installed.)
:* Items deleted from the packager's application are never deleted from the subscriber's system unless the [[Overwrite Previous Package]] option has been enabled by the Service Provider, and the packager has chosen the ''Overwrite'' option. (Then, and then only, items deleted from the Service Provider's system are deleted from the subscriber's system when the package is installed.)


;Details:
INCLUDE THESE AS NEVER OVERWRITTEN:
::* Global Picklists
::* Classes         
::* Email Templates 
::* Roles           
::* Sites           
::* Teams           
::* Web Forms
 
=====Object Aspects=====
This table describes the behavior of individual [[Object Aspects]].
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
! align="left"|Platform Element !! Added if New !! Replaced if Modified !! Deleted if Old
! align="left"|Object Aspect !! Added if New !! Replaced if Modified !! Deleted if Old
|-
| [[Business Rules]]                  ||  Y || Y ||
|-
| [[Custom Form Actions]]              ||  Y || Y ||
|-
| [[Document Templates]]              ||  Y || Y ||
|-
| [[Email Templates]]                  || Y || '''N''' || '''N'''
|-
| [[External Data Source]] definitions ||  Y || Y ||
|-
| [[Fields]]                          ||  Y || Y ||
|-
| [[Field Scripts]]                    ||  Y || Y ||
|-
| [[Forms]]                            ||  Y || Y ||   
|-
| [[Form Scripts]]                    ||  Y || Y ||
|-
| [[Indexes]]                          ||  Y || Y ||
|-
| [[Layout Rules]]                    ||  Y || Y ||
|-
| [[Macros]]                          ||  Y || Y ||
|-
| [[Processes]]                        ||  Y || Y ||
|-
| [[Record Locators]]                  ||  Y || Y ||
|-
| [[Validations]]                      ||  Y || Y ||
|-
|-
| [[Application]] settings      ||  || ||
| [[Web Forms]]                       || Y || Y || '''N'''
|}


=====Application Elements=====
This table describes the behavior of other platform elements that go into an application.
:{| border="1" cellpadding="5" cellspacing="0"
! align="left"|Platform Element !! Added if New !! Replaced if Modified !! Deleted if Old
|-
|-
| [[Object]]s and [[Object Aspects]]
| [[Application]] settings      || Y ||  ||
:[[Business Rules]]
:[[Custom Form Actions]]
:[[Document Templates]]
:[[External Data Source]] definitions
:[[Fields]]
:[[Field Scripts]]
:[[Forms]]
:[[Form Scripts]]
:[[Indexes]]
:[[Layout Rules]]
:[[Macros]]
:[[Processes]]
:[[Record Locators]]
:[[Validations]]
:[[Web Forms]]
|   ||  ||
 
|-
|-
| [[Access Profiles]]            || colspan="3" align="center"|''not included''
| [[Access Profiles]]            || colspan="3" align="center"|''not included''
Line 178: Line 208:
| [[Business Hours Calendars]]  || colspan="3" align="center"|''not included''
| [[Business Hours Calendars]]  || colspan="3" align="center"|''not included''
|-
|-
| [[Classes]]                    || || ||
| [[Classes]]                    || Y || Y || '''N'''
|-
|-
| [[Dashboards]]                || ||  ||
| [[Dashboards]]                || Y ||  ||
|-
|-
| [[Global Picklists]]          || || ||
| [[Global Picklists]]          || Y || '''N''' || '''N'''
|-
|-
| [[Mapping Profile]]s          || ||  ||
| [[Mapping Profile]]s          || Y ||  ||
|-
|-
| [[Pages]]                      || ||  ||
| [[Pages]]                      || Y ||  ||
|-
|-
| [[Processes]]                  || ||  ||
| [[Processes]]                  || Y ||  ||  
|-
|-
| [[Reports]]                    || ||  ||
| [[Reports]]                    || Y ||  ||
|-
|-
| [[Roles]]                      || || ||
| [[Roles]]                      || Y || Subscriber choice || '''N'''
|-
|-
| [[Sites]]                      || ||  ||
| [[Sites]]                      || Y ||  || '''N'''
|-
|-
| [[SLAs]]                      || colspan="3" align="center"|''not included''
| [[SLAs]]                      || colspan="3" align="center"|''not included''
|-
|-
| [[Static Resources]]          || ||  ||
| [[Static Resources]]          || Y ||  ||
|-
|-
| [[Tab Preferences]]            || ||  ||
| [[Tab Preferences]]            || Y ||  ||
|-
|-
| [[Team]] definitions          || ||  ||
| [[Team]] definitions          || Y ||  || '''N'''
|-
|-
| [[Team Data Sharing Policies]] || ||  ||
| [[Team Data Sharing Policies]] || Y ||  ||
|-
|-
| [[Translation Workbench]]      || || ||
| [[Translation Workbench]]      || Y || colspan="2" align="center"|{{TBD|}}
|-
|-
| [[View Preferences]]          || || ||
| [[View Preferences]]          || Y || Y ||
|-
|-
| [[Web Services]]              ||colspan="3" align="center"|{{TBD|}}  
| [[Web Services]]              ||colspan="3" align="center"|{{TBD|}}  
|-
|-
| [[Web Tabs]]                  || || ||
| [[Web Tabs]]                  || Y || Y ||
|}
|}

Revision as of 03:47, 4 March 2015

Platform elements can be selected for inclusion in a Package as package items. When selected, dependent elements are automatically included. Items that are related, but upon which the selected item does not actually depend are excluded by default--although they can generally be selected manually, if desired.

Standard Dependencies

Platform Element Dependent Elements
  • Application
  • Excludes Reports and Web Forms
    Reports can be individually selected. Reports on an object are not automatically included.
  • Excludes data
    Data is not included automatically. Java code can be written to create Package Data classes that add selected records during packaging, and that take the records out when the package is installed.
  • Classes (includes
    user-created classes)
  • The Business Hours Calendar used in processes.
    (A calendar modified by the installer is never overwritten, so installers are free to modify the calendar to suit their purposes.)
  • Teams and Roles used in Process tasks
  • Sites
  • Includes Teams and Roles involved
  • Includes Child Teams if the Include Child Teams option is selected for that team
  • Includes localized labels and items


  • Web Tabs

Special Dependencies

When the following elements are added to a package, the listed items are added as dependencies:

Team Data Sharing Policies
Roles and Teams included as dependencies
  • If the Include Child Teams checkbox is enabled, the child teams of the selected teams in the Data Sharing Policy are added as dependencies
Objects in a Master-Detail relationship

Notepad.png

Note:
The "Master-Detail relationship" option on a Lookup field has been deprecated. This section is provided for legacy objects that have a Lookup field for which that option has been selected.
Learn more: Master-Detail relationships

  • If a Detail object is added to a Package, the Master object is added (automatically) as a dependent object
  • If a Master object is added to a Package and if that Master object includes any Rollup Summary Fields, then the Detail object is added (automatically) as a dependent object
  • When a Tenant installs a Package, the Rollup Summary Fields limit defined in Manage Tenant Capabilities is honored
  • If the limit is exceeded, the installation process will stop and cannot proceed
  • In order to complete the installation, delete existing Rollup Summary Fields to reduce the total number to within the defined limit
  • After packaging, do not add or remove any Master-Detail relationships; doing so may cause unexpected results and/or loss of data

Items that are Never Packaged

These platform elements are never added to a package. Customizations made by the subscriber remain intact.

How Package Items are Applied

The principles that follow summarize the behavior of package items at installation time. Detailed tables list the behavior for individual items, following the summary.

Principles
  • New items in the Package are added to the subscriber's system.
  • If the subscriber created a new platform element with the same name as an item included in the package, the subscriber gets an error. (The error occurs immediately after they select the package. Installation is not allowed to proceed.)
  • With few exceptions, modified items in the Package replace the versions that came from a previous Package.
    The exceptions are:
  • Global Picklists -- Subscribers are expected to have added items and modified labels, so they are left intact.
  • Email Templates -- Subscribers are expected to have customized email templates with their return address, signature text, and possibly logo images, so they are left intact.
  • Roles -- During installation, the subscriber has the option of merging or overwriting roles that are included in the package.
  • __TBD: Confirm that Web Services are not part of this list.__
  • Items deleted from the packager's application are never deleted from the subscriber's system unless the Overwrite Previous Package option has been enabled by the Service Provider, and the packager has chosen the Overwrite option. (Then, and then only, items deleted from the Service Provider's system are deleted from the subscriber's system when the package is installed.)

INCLUDE THESE AS NEVER OVERWRITTEN:

  • Global Picklists
  • Classes
  • Email Templates
  • Roles
  • Sites
  • Teams
  • Web Forms
Object Aspects

This table describes the behavior of individual Object Aspects.

Object Aspect Added if New Replaced if Modified Deleted if Old
Business Rules Y Y
Custom Form Actions Y Y
Document Templates Y Y
Email Templates Y N N
External Data Source definitions Y Y
Fields Y Y
Field Scripts Y Y
Forms Y Y
Form Scripts Y Y
Indexes Y Y
Layout Rules Y Y
Macros Y Y
Processes Y Y
Record Locators Y Y
Validations Y Y
Web Forms Y Y N
Application Elements

This table describes the behavior of other platform elements that go into an application.

Platform Element Added if New Replaced if Modified Deleted if Old
Application settings Y
Access Profiles not included
Business Hours Calendars not included
Classes Y Y N
Dashboards Y
Global Picklists Y N N
Mapping Profiles Y
Pages Y
Processes Y
Reports Y
Roles Y Subscriber choice N
Sites Y N
SLAs not included
Static Resources Y
Tab Preferences Y
Team definitions Y N
Team Data Sharing Policies Y
Translation Workbench Y __TBD__
View Preferences Y Y
Web Services __TBD__
Web Tabs Y Y