ControlTier Inc. > Open.ControlTier > ModuleForge.ControlTier
 
 
PDF -icon
PDF
Font size:      

AtgProjectUpdater

Updater type designed orchestrate the end-to-end build and deployment process

Overview

Open in Workbench AtgProjectUpdater: Updater type designed orchestrate the end-to-end build and deployment process

Design

Super Type
Updater
Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name AtgProjectUpdater

Constraints

Allowed Child Dependencies

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

  • Node

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.

Build

Build the project

Usage
Build -buildstamp <> [-command <Build>] [-resourcetype <AtgModuleUpdater|AtgDataUpdater>]

Workflow

  1. dispatchCmd

Success Handler

Email
Subject [${context.type}:${context.name} @ ${framework.node}] ${command.name} - SUCCESS
File ${modules.dir}/Deployment/templates/notice.html

Options

Option Description
buildstamp Unique build and deployment identifier
command Build command
resourcetype Builder type

BuildAndUpdate

runs the build and deployment processes

Usage
BuildAndUpdate -buildstamp <>

Workflow

  1. Build
  2. Change-Dependencies
  3. Update

Success Handler

Email ${entity.attribute.notificationList}
Subject [${context.type}:${context.name} @ ${framework.node}] ${command.name} - SUCCESS
File ${modules.dir}/Deployment/templates/notice.html

Error Handler

Notify
Email
${entity.attribute.notificationList}
Subject
[${context.type}:${context.name} @ ${framework.node}] ${command.name} - ERROR
File
${modules.dir}/Deployment/templates/notice.html
Report

Workflow failed.

Options

Option Description
buildstamp build id

Change-Dependencies

Queries model and then switches dependencies

Usage
Change-Dependencies -buildstamp <> [-command <Change-Dependencies>] [-resourcetype <AtgModuleUpdater|AtgDataUpdater>]

Workflow

  1. dispatchCmd

Success Handler

Email
Subject
File

Options

Option Description
buildstamp build id
command Build command
resourcetype Builder type

Install

Installs the object, and its modules

Usage
Install [-basedir <${entity.instance.dir}>] [-buildstamp <>] [-depot <${context.depot}>] [-name <${context.name}>] [-nodir] [-nodispatch] [-nomodule] [-noproperties] [-subdirs <bin,conf,logs,var>] [-type <${context.type}>]

Options

Option Description
basedir base directory
buildstamp Unique build and deployment identifier (ignored)
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

update the site

Usage
Update -buildstamp <null> [-command <Update>] [-resourcetype <AtgModuleUpdater|AtgDataUpdater>]

Workflow

  1. dispatchCmd

Success Handler

Email
Subject [${context.type}:${context.name} @ ${framework.node}] ${command.name} - SUCCESS
File ${modules.dir}/Deployment/templates/notice.html

Options

Option Description
buildstamp Unique identifer for the build and release
command Update command
resourcetype Type to update

dispatchCmd

dispatches command to child

Usage
dispatchCmd [-buildstamp <>] -command <> [-keepgoing] [-resourcename <.*>] [-resourceorder <[^.]*>] [-resourcetype <[^.]*>] [-sortorder <ascending>]

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

Related Types

The following types are defined for use with AtgProjectUpdater.

NotificationList

Overview

Open in Workbench NotificationList: List of email addresses used by the project updater for workflow success/failure notification

Design

Super Type
Setting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
notificationList settingValue

Requestor

Overview

Open in Workbench Requestor: Email address of a project's owner

Design

Super Type
Setting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
requestor settingValue