| Table of Contents |
|---|
To build, deploy or execute a project , open it and go to the execution screen.On the Execute tab you will see two sections titled Current State of Project Deployments and Project Activity. Current State of Project Deployments section is not available on Partial Deployment Projects or Utility Projects.
The Current State of Project Deployments indicates which environments contain which version of the project. If the project has not been deployed to an environment it will not appear in the list. This provides an easy to access summary of this project's current deployment state across all environments.
...
| Tip |
|---|
Project activity is sorted by requested time in descending order |
...
Object Type
...
Status
...
Description
Workflow Request
...
Initiated
...
The initial status that a request receives when it has first been submitted.
...
Pending Approval
...
Indicates that one or more approvals are required before the request will be sent for execution.
...
Scheduled
...
Indicates that the request has been scheduled for execution at some time in the future.
...
Rejected
...
Indicates that an approval task or scheduled task for the request has been rejected/cancelled.
...
Aborted
...
The workflow execution was aborted by the user for this request.
...
Ready
...
Indicates that the request has received any required approvals or reached the scheduled time and is ready to begin execution.
...
Submitted
...
Indicates that the request has been sent for execution.
...
Failed
...
Indicates that the request has failed.
...
Completed
...
Indicates that the request has been successfully executed.
Workflow Execution
...
Queued
...
The initial status when a request is ready for execution.
...
Running
...
Indicates that execution is in progress.
...
Aborted
...
The workflow execution was aborted by the user.
...
Failure
...
Indicates that the execution has failed.
...
Success
...
. |
| Anchor | ||||
|---|---|---|---|---|
|
From the Execution tab, click the Build button.
Enter values in the Build Request Form as described in the table below.
...
Field
...
Required
...
Description
...
Environment
...
Yes
...
The environment to execute the build on. Note that if there is only one environment configured for the build, it will be preselected.
...
Instance
...
Yes
...
The instance to execute the build on. Note that if there is only one instance configured for the build workflow it is preselected and marked and read-only.
...
Release
...
Depends
...
Select the release the build should be associated to if applicable. If a release is selected, the build will create a snapshot for the release.
...
Stream
...
Yes
...
Select project stream to build from. Defaults to main stream (trunk). You can select any branch stream configured on the Project Configuration screen.
...
Force Build
...
No
...
If selected, forces the build even though no changes detected in the source. By default only build if there is any change from last build.
...
FlexFields
...
Depends
...
Change # above is an example of a FlexField configured on the Administration Tab. Any FlexFields that are configured for a Build Request will display here.
...
Related Tickets
...
Depends
...
Issue tracking tickets related to the build.
...
Workflow Version Override
...
No
...
Optionally select the version of the workflow to execute. Defaults to the active version.
...
Workflow Inputs
...
Depends
...
Enter values for any inputs that are configured for the build workflow. The workflow itself defines whether each input is required or not.
...
Select the Environment, Branch, and optionally Release, Change Numbers, and Issues. If you have enough permissions, you can also open the advanced section and select a different workflow version. The currently active workflow version is the default.
Click Submit to start the build.
| Anchor | ||||
|---|---|---|---|---|
|
...
Project
From the Execution tab, click the Submit Deploy Request button .Enter values in the Deployment Request Form as described in the table below.
...
Field
...
Required
...
Description
...
Project Version
...
Yes
...
in the row of the project
...
Environment
...
Yes
...
The environment to execute the deployment on.
...
Deploy Instance(s)
...
Yes
...
The instance(s) to execute the deployment on. The list of instances which appear in the list are the deploy instances which are configured for the project.
...
Pre-deploy
...
No
...
Select if Pre-deploy workflow should be executed prior to Deploy execution. This will be visible only if project is configured with Pre-deploy workflow.
Pre-deploy workflow can be utilized as means to perform specific validations. For example, Oracle Database Plugin generates DDL statements based on differences in target and baseline being deployed, these statements can be validated by DBA by using Pre-deploy workflow.
...
Force Deploy
...
Yes
...
Force a deployment to occur even if the project version is already current in the selected environment. Defaults to No.
...
Exception To Window
...
Yes
...
Indicate that the deployment is being requested to run outside of any defined deployment window, triggering an approval. Defaults to No.
...
Start Time
...
No
...
An optional delayed start time for the deployment. Start time is not applied to Pre-deploy workflow.
...
FlexFields
...
Depends
...
Rollback on Failure? above is an example of a FlexField configured on the Administration Tab. Any FlexFields that are configured for Deploy / Utility Request will display here.
...
Workflow Version Override
...
No
...
Optionally select the version of the workflow to execute. Defaults to the active version.
...
Workflow Inputs
...
Depends
...
Enter values for any inputs that are configured for the deploy workflow.
...
Submit Request
Click the Submit Request button to submit the build requestversion that you wish to deploy. This is the same for standard and package-based projects.
...
Make sure to select the correct environment and target group(s) that you wish to deploy to.
If the project was already successfully deployed, click the Force Deploy check box.
If you want to schedule the deployment, you can find that option in the Advanced section.
Click the Submit button to submit the deployment request.
| Anchor | ||||
|---|---|---|---|---|
|
Package-based projects have an extra tab called Packages. This tab allows you to define groups of files that will be built and deployed together.
The screenshot below shows a Salesforce project with several packages in it.
...
Open a package to view and modify its contents.
...
Files can be added to the package either from the file list or by adding an SCM revision. If you add by revision, all files that were added or modified in the selected revision will be added to the package.
...
Files can also be removed from the package on the package files screen.
...
Once the package contains the right files, you can create a build and deploy it on the execution tab.
It’s easiest to do it on the Execution tab of the package, but the Execution tab above works too.
...
Select the correct Environment and Branch, and optionally a release, change number, ITS issues, and the workflow version in Advanced. Check Force Build if you have build from the same SCM revision in the past and want to build again..
Click the Submit button to start the the build.
Re-build, Re-deploy, or Re-execute a Workflow Execution
During Sometimes during the course of development this option it is very useful helpful to redo a specific Build, Deploy, Test, or Utility execution. In the case of packages, developers will be updating files and refining the package over time. You can click the Re-build/Re-deploy/Re-execute icon on the project activity screen in the Project Version column. This will to bring up the corresponding Request Form with stream, flexfields, workflow inputs, and force flag selected per selected workflow execution. Depending on the workflow execution selected, more fields will be automatically populated such as for package based build where the files will automatically be populated with selected revisionsthe values from the chosen workflow execution filled in. This helps create new build, deploy, test, or utility requests quickly based on the current workflow execution's parameters. Now user can add / remove files or change revisions or clear out revision to fetch latest files prior to submitting request.
| Info |
|---|
Notice
|
...
Deploying a Partial Deployment Project
From the Execution tab of a partial deploy project, click the Deploy button.
...
Field
...
Required
...
Description
...
Project Version
...
Yes
...
The version of the project to submit for deployment.
...
Environment
...
Yes
...
The environment to execute the deployment on.
...
Deploy Instance(s)
...
Yes
...
The instance(s) to execute the deployment on. The list of instances which appear in the list are the deploy instances which are configured for the project.
...
Pre-deploy
...
No
...
Select if Pre-deploy workflow should be executed prior to Deploy execution. This will be visible only if project is configured with Pre-deploy workflow.
Pre-deploy workflow can be utilized as means to perform specific validations. For example, Oracle Database Plugin generates DDL statements based on differences in target and baseline being deployed, these statements can be validated by DBA by using Pre-deploy workflow.
...
Force Deploy
...
Yes
...
Force a deployment to occur even if the project version is already current in the selected environment. Defaults to No.
...
Exception To Window
...
Yes
...
Indicates that the deployment is being requested to run outside of any defined deployment window, triggering an approval. Defaults to No.
...
Stop when Package Fails
...
Yes
...
When deploying multiple packages, if a prior package fails, the remaining packages will not be deployed.
...
Start Time
...
No
...
An optional delayed start time for the deployment. Start time is not applied to Pre-deploy workflow.
...
Flex Fields
...
Depends
...
Optionally, you can create flex fields for the user to enter as a part of the request. In the Figure above, the Flex Field is "Rollback on Failure?".
...
Workflow Version Override
...
No
...
Optionally select the version of the workflow to execute. Defaults to the active version.
...
Workflow Inputs
...
Depends
...
Enter values for any inputs that are configured for the deploy workflow.
...
Field
...
Required
...
Description
...
Match
...
Yes
...
Select the Any radio button to indicate that the search results should include packages that contain either Project Version or Package Name search string, or the All radio button to indicate that the search results should only include packages that contain both the Project Version and Package Name search string.
...
Project Version
...
No
...
Select the search option (either Starts with, Ends with, Equals, or Contains) and enter the text to search for project versions.
...
Package Name
...
No
...
Select the search option (either Starts with, Ends with, Equals, or Contains) and enter the text to search for package names.
...
If you would like to see the file details for a package, click on the arrow in front of the package:
...
When you have the set of packages you wish to deploy, click the Submit Request button to submit the deployment request. Each package will run as a separate workflow request and workflow execution in the Project Activity table.
...
Executing a Utility Project
From the Execution tab, click the Execute button.
...
Enter values in the Execute Request Form as described in the table below.
...
Field
...
Required
...
Description
...
Environment
...
Yes
...
The environment to execute the deployment on.
...
Execute Instance(s)
...
Yes
...
The instance(s) to execute the workflow on. The list of instances which appear in the list are the deploy instances which are configured for the project.
...
Force Execute
...
Yes
...
Alway set to yes. Utility projects will execute every time.
...
Exception To Window
...
Yes
...
Indicate that the execution is being requested to run outside of any defined execution window, triggering an approval. Defaults to No.
...
Start Time
...
No
...
An optional delayed start time for the execution.
...
FlexFields
...
Depends
...
Change # above is an example of a FlexField configured on the Administration Tab. Any FlexFields that are configured for Deploy / Utility Request will display here.
...
Workflow Version Override
...
No
...
Optionally select the version of the workflow to execute. Defaults to the active version.
...
Related Tickets
...
Depends
...
Issue tracking tickets related to the execution.
...
Workflow Inputs
...
Depends
...
Enter values for any inputs that are configured for the deploy workflow.
...
Fill in the values of the Environment and the Target Groups you wish to execute the utility on. Optionally enter change tickets or a start time in the advanced section.
Click the Submit button to submit the execute request.
...
From the Execution tab, click the Test button.
...
Enter values in the Run Tests Request Form as described below.
...
Field
...
Required
...
Description
...
Environment
...
Yes
...
The environment to execute the test on. The environment, along with the instance, is used to determine the tests to execute based on strategy.
...
Instance
...
Yes
...
The instance to execute the test against. The instance, along with the environment, is used to determine the tests to execute based on strategy.
...
Stream
...
Yes
...
The stream to execute the test against. Along with strategy, the stream helps identify which tests will be executed.
...
Test Type
...
Yes
...
Restricts the test type to execute within the strategy matching the given environment and instance.
...
Test Set
...
Yes
...
Restricts the test set to be executed within the matching strategy and test type.
...
Test Definition
...
Yes
...
Restricts the tests to be executed within the matching strategy, test type, and test set.
Click the Submit Request button to submit the test executionEnvironment and Target Groups to un tests on. Optionally enter a test name to execute. Otherwise all tests that meet the filter criteria of the environment and target group will be executed.
Click the Test button to start the test.
| Anchor | ||||
|---|---|---|---|---|
|
...
Requests
Once a project build or deployment request has been submitted, the request status can be monitored by clicking on the Request Id.
...
The request shows data that was available when the workflow request was created, and doesn’t rely on the workflow having started to show up.
Read more about the Project Workflow Request.
...
Once a project build or deployment request has been submitted, it can be monitored by clicking on the Execution Id.
You can click on the Refresh button and watch the statuses progress throughout the lifecycle until it is either a Failure or Success. To see more details about an execution, click on the id in the Execution Id column of the Project Activity section.
...
The pages changes as the workflow runs. You can see the details in the screens on the left.
...
Read more about the Project Workflow Execution.