+

Search Tips   |   Advanced Search


Scripts for composite applications

The Portal Scripting Interface includes scripts for retrieving composite application metadata and for managing application lifecycle. The composite application scripts provide an alternative to using the Application Template Library and the Applications catalog for the tasks that the scripts support. The scripts for composite applications are $Application, $ArchivedApplication, $ApplicationCatalog, and $TemplateCatalog.


Application

$Application listall categories

Lists all application categories

$Application listall applications

Lists all active applications by their globally unique identifiers (GUIDs)

$Application listall applications categoryis categoryID

Lists all active applications within the specified category

$Application details applicationID

Retrieves the details of an application

$Application nlsget applicationID title locale

Retrieves the title of an application in the specified language

$Application getattribute applicationID attribute_name

Retrieves the values of the following application attributes:

category

Returns the ID of the category to which the application belongs

lastaccesseddate

Returns the date on which the application was last used, in the format YYYYMMDDHHMMSS

lastmodifieddate

Returns the date on which the application was last modified, in the format YYYYMMDDHHMMSS

owner

Returns the display name of the application owner

size

Returns the size of the application

$Application backup applicationID

Backs up an application

$Application archive applicationID

Archives an application

$Application delete applicationID

Deletes an application


ArchivedApplication

$ArchivedApplication restore applicationID applicationrestorepointID

Restores an archived application from the specified restore point

$ArchivedApplication delete applicationID applicationrestorepointis applicationrestorepointID

Deletes a single restore point of an application

$ArchivedApplication delete applicationID

Deletes all restore points associated with an application

$ArchivedApplication listall categories

Lists all archived application categories

$ArchivedApplication listall archivedapplications

Lists all archived applications by their globally unique identifiers (GUIDs)

$ArchivedApplication listall archivedapplications categoryiscategoryID

Lists all archived applications within a particular category

$ArchivedApplication details applicationID

Retrieves the details of an archived application

$ArchivedApplication nlsget applicationID title locale

Retrieves the title of an archived application in a particular language

$ArchivedApplication listapplicationrestorepoints applicationID

Retrieves a list of strings that represent the restore points for the archived application

$ArchivedApplication getattribute archivedapplication applicationID [applicationrestorepoint applicationrestorepointID] attribute_name

The parameter set applicationrestorepoint applicationrestorepointID is optional. You can retrieve the values of the following application attributes:

category

Returns the ID of the category to which the archived application belongs

createddate

Returns the backup date represented by the application restore point, in the format YYYYMMDDHHMMSS. Requires the parameter applicationrestorepoint.


ApplicationCatalog

ApplicationCatalog deletecategory empty_category

Deletes unused or obsolete application categories. Categories to be deleted must not contain any applications.


TemplateCatalog

TemplateCatalog deletecategory empty_category

Deletes unused or obsolete template categories. Categories to be deleted must not contain any templates.


Parent topic:

Use scripts for composite applications