AtgAppServerCollection
A collection of ATG Servers
Overview
AtgAppServerCollection:
A collection of ATG Servers
Design
- Super Type
- ServiceMediator
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | AtgAppServerCollection |
Constraints
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
Prepare
prepares and validates install
- Usage
- Prepare
Workflow
Install
Installs self and local child resources
- Usage
- Install [-basedir <${entity.instance.dir}>] [-depot <${context.depot}>] [-name <${context.name}>] [-nodir] [-nodispatch] [-nomodule] [-noproperties] [-subdirs <bin,conf,logs,var>] [-type <${context.type}>]
Options
| Option | Description |
|---|---|
| basedir | base directory |
| depot | project depot |
| name | object name |
| nodir | do not create directories |
| nodispatch | do not dispatch Install action to child resources |
| nomodule | do not update module |
| noproperties | do not update properties |
| subdirs | directory list |
| type | object type |
Update
performs a software deployment
- Usage
- Update [-command <Update>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Packages-Install
installs all the package dependencies
- Usage
- Packages-Install [-command <Packages-Install>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Status
Check services
- Usage
- Status [-command <Status>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Configure
Configure services
- Usage
- Configure [-command <Configure>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Start
Start services
- Usage
- Start [-command <Start>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Stop
Stop services
- Usage
- Stop [-command <Stop>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
Restart
Restart services
- Usage
- Restart [-command <Restart>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
dispatchCmd
dispatches command to child
- Usage
- dispatchCmd [-buildstamp <>] -command <> [-keepgoing] [-resourcename <.*>] [-resourceorder <[^.]*>] [-resourcetype <[^.]*>] [-sortorder <ascending>] [-threadcount <6>]
Options
| Option | Description |
|---|---|
| buildstamp | Unique build and deployment identifier |
| command | command to dispatch |
| keepgoing | If true, all iterations of the called workflow will be executed, even if a task in one or more of them fails. |
| resourcename | resource name pattern |
| resourceorder | resource order name |
| resourcetype | resource type name |
| sortorder | order to sort resources |
| threadcount | Number of concurrent threads to dispatch |
switchDatastore
switches the datastore
- Usage
- switchDatastore [-atgservertype <>] -datastore <>
Options
| Option | Description |
|---|---|
| atgservertype | type name |
| datastore | datastore name |
packagesInstallChildren
Workflow runs packagesInstall process
- Usage
- packagesInstallChildren [-command <Packages-Install>]
Workflow
Options
| Option | Description |
|---|---|
| command | command to dispatch |
packagesInstallSelf
installs packages
- Usage
- packagesInstallSelf [-packagetype <[^\.]*>]
Options
| Option | Description |
|---|---|
| packagetype | type of packages to install |
updateDatastoreModelObject
updates the datastore model object
- Usage
- updateDatastoreModelObject [-datastore <>]
Options
| Option | Description |
|---|---|
| datastore | datastore name |
invalidateCache
invalidates the caches
- Usage
- invalidateCache [-atgservertype <>]
Options
| Option | Description |
|---|---|
| atgservertype | atg server type name |
mkdirStructure
creates directories and makes necessary symlinks
- Usage
- mkdirStructure [-dynamo_root <>] [-name <>]
| Execution | bash |
| Arguments | echo implement procedure |
Options
| Option | Description |
|---|---|
| dynamo_root | dynamo install dir |
| name | install unit name |
generateInstallUnit
Creates the app install unit
- Usage
- generateInstallUnit [-dynamo_root <>] [-name <>]
Options
| Option | Description |
|---|---|
| dynamo_root | dynamo root directory |
| name | name of the instal unit |
getDatastoreName
gets the current datastore name
- Usage
- getDatastoreName [-atgservertype <>]
Options
| Option | Description |
|---|---|
| atgservertype | type pattern |
Related Types
The following types are defined for use with AtgAppServerCollection.
AtgAppServerCollectionSetting
Overview
AtgAppServerCollectionSetting:
an AtgAppServerCollection setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
AtgEnvironment
Overview
AtgEnvironment:
An Atg environment
Design
- Super Type
- AtgAppServerCollectionSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| environment | settingValue |
AtgDynamoInstallUnit
Overview
AtgDynamoInstallUnit:
ATG install unit name
Design
- Super Type
- AtgAppServerCollectionSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgInstallUnit | settingValue |
AtgServerPattern
Overview
AtgServerPattern:
Type name or regex to dispatch commands
Design
- Super Type
- AtgAppServerCollectionSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| atgServerPattern | settingValue |