Difference between revisions of "Publish a Package"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Β 
(60 intermediate revisions by the same user not shown)
Line 1: Line 1:
Publishing a package makes it available for tenants to install. It also makes it possible for the publisher (you) to automatically upgrade local Package Subscribers, using the [[Deploy]] option.
Publishing a package makes it available for tenants to install. It also makes it possible for the publisher (you) to automatically upgrade local Package Subscribers, using the [[Deploy]] option.
__TOC__
{{:Option:Publish Package}}
Β 
====Publishing a Package====
====Publishing a Package====
''Publishing'' a package creates a zip file that can be deployed to installers in one of several ways.


{{Enablefeature|Publish Package|Manage Tenant Capabilities|}}
'''To publish a package:'''
Β 
'''To publish a [[Package]]:'''
#Follow the instructions to [[Package#Create_a_Package|Create a Package]], then [[Package#Add Item to a Package|Add items to the Package]].
#Follow the instructions to [[Package#Create_a_Package|Create a Package]], then [[Package#Add Item to a Package|Add items to the Package]].
#Optionally, click '''[Edit]''' to make changes to an existing package before publishing.
#Optionally, click '''[Edit]''' to make changes to an existing package before publishing.
Line 11: Line 11:
#Click '''[Publish]''' to begin the publishing process.
#Click '''[Publish]''' to begin the publishing process.


====Package Settings====
====Publishing a Delta Package====
=====Basic Information=====
A ''delta'' package is one that contains only those elements which have changed--that is, the differences, or "delta", from the original version of the package. So if the original version of the package contained an entire application, the "delta" (update) package might contain a single object.
:{| class="tight-rows"
|-
|align="right" width="110em"| '''Name''' || Name of the package


|-
'''To publish a delta package:'''
| align="right"| '''Version''' Β 
#Follow the instructions to [[Package#Create_a_Package|Create a Package]], then [[Package#Add Item to a Package|Add items to the Package]].
| Version number of the package.
#Fill in the package settings below.
: The default value is an auto-incrementing dot-version.
#Click '''[Publish]''' to begin the publishing process.
:: If the Package version is "1", the default will be "1.1".
#: Often, that is all you need to do to generate a delta package. Β 
:: If the Package version is "1.1", the default will be "1.2", and so on.
#: Each item in the package has a {{^GUID}}, so the equivalent item in the target system is automatically updated when the package is installed.
: The value can be changed to whatever you like.
#: At times, though, you need the additional behaviors that result from using the [[Overwrite Previous Package]] option. Β 
: After publication, the value is displayed as the version number in the Package object.
#: That option updates a couple of object aspects that are normally left alone, and it causes items deleted from the source system to be deleted from the target system.
:: (The Package object stores version numbers and notes for the last five versions.)
# When package-overwrite behavior is needed, publish the package a second time, without changing it.<br>The overwrite option now appears.
# Choose the '''Overwrite Previous Package''' option to get those behaviors.
:''Learn more:'' [[Package Items#How Package Items are Applied]]


|-
====Package Settings====
| align="right"| '''Version Notes'''
:'''Basic Information'''
| Notes about the package. <br>These notes appear in the revision list for the package.
::* '''Name -''' Name of the package
|}
::* '''Version -''' Version number of the package.
Β 
::*: The value can be set to whatever you like.
:::* '''-''' .
::*: The default value is an auto-incrementing dot-version:
:::* ''' -''' Β 
::*::*Β  If the current Package version is "1", the default will be "1.1".
:::* '''Catalog Information -'''
::*::* If the current version is "1.1", the default will be "1.2", and so on
Β 
::*::* After publication, the value is displayed as the version number in the Package object.<br>(The Package object stores version numbers and notes for the last five versions.)
======Additional Information======
This section and those that follow appear when the '''Catalog Information''' option has been selected.
:{| class="tight-rows"
|-
|align="right" width="110em"| '''Field Label'''
| Description
Β 
|-
| align="right"| '''Label'''
| Description
|}


:::::* '''Summary Description -''' Provide a short description for the catalog, to tell the installer what the package provides
::* '''Version Notes -''' Notes about the package.
:::::* '''Catalog Icon -''' Upload a 55x55 pixel icon to accompany the package in the catalog.
::*: Version notes appear in the package's [[Packages#Revision Details|Revision Details]].
:::::* '''Screenshot 1 -''' Attach an image that shows the package or application in operation.
::*: They are also shown to installers, when they are doing a direct online install--for example, from the [[Community Marketplace]].
:::::* '''Screenshot 2 -''' Attach a second image
::*: The notes are not included in the archive, so they are not shown when installing from a file.
:::::* '''Overview Benefits -''' A summary of the advantages to be gained from use of the package.
::*: (The notes should be copied to the email or web page that includes the file, along with any other information the installer needs to know.)
:::::* '''Overview Description -''' A brief description of the package. For example, what it does and how it works.


======Section======
:'''Installation Options'''
:{| class="tight-rows"
:This section appears when the [[Overwrite Previous Package]] option has been enabled by the Service Provider.
|-
::* '''Merge with Previous Version'''
|align="right" width="110em"| '''Field Label''' Β 
::*: Make additions to installed package items, and add new package items.
| Description
::* '''Overwrite Previous Version''' Β 
::*: Delete installed package items that have been dropped from the package,<br>make additions to previously installed items, and add new items.<noinclude>


|-
[[Category:Development]]
| align="right"| '''Label'''
[[Category:System Administration]]
| Description
</noinclude>
|}

Latest revision as of 19:23, 14 July 2015

Publishing a package makes it available for tenants to install. It also makes it possible for the publisher (you) to automatically upgrade local Package Subscribers, using the Deploy option.

Lock-tiny.gif

Publishing a Package

Publishing a package creates a zip file that can be deployed to installers in one of several ways.

To publish a package:

  1. Follow the instructions to Create a Package, then Add items to the Package.
  2. Optionally, click [Edit] to make changes to an existing package before publishing.
  3. Fill in the package settings below.
  4. Click [Publish] to begin the publishing process.

Publishing a Delta Package

A delta package is one that contains only those elements which have changed--that is, the differences, or "delta", from the original version of the package. So if the original version of the package contained an entire application, the "delta" (update) package might contain a single object.

To publish a delta package:

  1. Follow the instructions to Create a Package, then Add items to the Package.
  2. Fill in the package settings below.
  3. Click [Publish] to begin the publishing process.
    Often, that is all you need to do to generate a delta package.
    Each item in the package has a GUID, so the equivalent item in the target system is automatically updated when the package is installed.
    At times, though, you need the additional behaviors that result from using the Overwrite Previous Package option.
    That option updates a couple of object aspects that are normally left alone, and it causes items deleted from the source system to be deleted from the target system.
  4. When package-overwrite behavior is needed, publish the package a second time, without changing it.
    The overwrite option now appears.
  5. Choose the Overwrite Previous Package option to get those behaviors.
Learn more: Package Items#How Package Items are Applied

Package Settings

Basic Information
  • Name - Name of the package
  • Version - Version number of the package.
    The value can be set to whatever you like.
    The default value is an auto-incrementing dot-version:
    • If the current Package version is "1", the default will be "1.1".
    • If the current version is "1.1", the default will be "1.2", and so on
    • After publication, the value is displayed as the version number in the Package object.
      (The Package object stores version numbers and notes for the last five versions.)
  • Version Notes - Notes about the package.
    Version notes appear in the package's Revision Details.
    They are also shown to installers, when they are doing a direct online install--for example, from the Community Marketplace.
    The notes are not included in the archive, so they are not shown when installing from a file.
    (The notes should be copied to the email or web page that includes the file, along with any other information the installer needs to know.)
Installation Options
This section appears when the Overwrite Previous Package option has been enabled by the Service Provider.
  • Merge with Previous Version
    Make additions to installed package items, and add new package items.
  • Overwrite Previous Version
    Delete installed package items that have been dropped from the package,
    make additions to previously installed items, and add new items.