Schedule Recurring Deployment

You can schedule ATG Content Administration so it deploys automatically all projects listed in the To Do tab of the Admin Console in the ATG Business Control Center.

To enable this functionality:

  1. Set up your content development and target environments for ATG Content Administration deployments (review the Deployment setup steps described earlier in this chapter).

  2. Configure the /atg/epub/deployment/RecurringDeploymentService, in order to schedule pending projects for deployment. The following table describes each property to configure:

    Property

    Description

    deploymentServer

    The path of the DeploymentServer, by default /atg/epub/DeploymentServer.

    enabled

    Specifies whether the service is enabled. The default is false. Be sure to set all other required properties before enabling this service.

    forceFull

    If set to true, specifies that the RecurringDeploymentService performs a Full Deployment. By default, this property is set to false (perform Incremental Deployment).

    personaPrefix

    The substring in an ACL that is used to identify the user in the UserAuthority. The default is Profile$login$.

    schedule

    Specifies the schedule for deploying pending projects. The schedule is supplied to the Scheduler service specified in the Scheduler property.

    In order to set up a recurring schedule, specify either a PeriodicSchedule or CalendarSchedule. For more information on defining these types of schedules, see the discussion on Scheduler services in the ATG Programming Guide.

    The default setting is calendar * * * * * 0, which specifies to run the job every hour on the hour.

    scheduler

    The path of the Scheduler service to manage deployment scheduling; by default, set to /atg/dynamo/service/Scheduler.

    skipTargetIds

    Specifies targets to exclude from scheduled deployments. By default, the RecurringDeploymentService deploys to all target sites set up to receive deployment.

    topologyManager

    transactionManager

    The path of the Transaction Manager to use; by default, set to /atg/dynamo/transaction/TransactionManager.

    userAuthority

    The userAuthority that resolves the user specified in the username property.

    username

    Specifies the user to authenticate. The default is publishing.

    Set this property to a user name with full access to the /atg/epub/PublishingRepository in order to ensure that the user against whom queries are executed has the required access privileges to all processes.

    versionManager

    The path of the Version Manager to use; by default, set to /atg/epub/version/VersionManagerService.

At application startup, the RecurringDeploymentService schedules a new deployment job with the /atg/dynamo/service/Scheduler (class atg.service.scheduler.Scheduler). The Scheduler component is a service provided with the Adaptive Scenario Engine; it keeps track of all scheduled jobs, and calls as needed on the appropriate services to execute them. (You can view the list of jobs being monitored by the Scheduler by accessing the component via the ATG Dynamo Server Admin.)

According to the schedule you define in the property RecurringDeploymentService.schedule, the Scheduler calls on the RecurringDeploymentService to perform its scheduled task. When called, the RecurringDeploymentService retrieves all pending projects in the system and deploys them to all target sites configured for deployment, except those specified in the skipTargetIds property. You can monitor and manage scheduled activity like other deployment activities.

Extending the RecurringDeploymentService

As described above, the default implementation of the RecurringDeploymentService schedulable service deploys all completed projects. You can extend this service to include only a subset of all completed projects. For example, you might want to include only completed projects of specific types.

To extend the RecurringDeploymentService in this manner, create a subclass of the atg.epub.deployment.RecurringDeploymentService class and override the following method:

public Collection getProjectsToDeploy(Collection pAllPendingProjects)

By default, getProjectsToDeploy() returns the collection of all completed or pending projects. The custom implementation should filter the collection as needed—for example, by project type.

After you create the subclass, configure an instance of the class in Nucleus by placing the configuration file in the CONFIGPATH at /atg/epub/deployment/RecurringDeploymentService.

Note: If project assets that are included in the filtered collection reference assets in other completed projects, the system automatically includes those projects in the deployment.

 
loading table of contents...