We recommend following the exact steps to ensure that you systematically understand how to use Flosum. After this tutorial, you will be ready to explore further capabilities of Flosum on your own.
Please do not use Internet Explorer for step #3 in setups.
Out of Scope:
3. The tutorial does not cover the best practice of how to bring all your existing source code into the Repository for version control.
4. Flosum is a very rich and powerful application, but this tutorial will not discuss all the various features of Flosum.
Tutorial:Step 1: Register both the organizations
Step 2: Make changes in your source organization
Step 3: Create a snapshot to retrieve your changes
- Log into the Flosum organization.
- Go to Orgs Tab.
- Go to the source organization.
- Click on Create snapshots.
- Give it to a appropriate name - SourceSnapshot_1 . Under the last modified days, please specify 1. This will retrieve the changes that have been done in the source organization in the last one day.
Step 4: Deploy these changes
- Click on the Deployments tab
- Click on New.
- Select source organization
- Select the snapshot that you just created - SourceSnapshot.
- Enter the Deployment name - Deployment_1.
- Select the components (both visualforce page and custom object) that you want to deploy.
- Click on Add to Deployment.
- Click on Deploy.
- Select the Target Organization.
- Click on Deploy.
Congratulations, you have done your first deployment with a just a few clicks. If required, you can modify the same deployment before deploying it again.
Observe: On the deployment definition page, scroll down to the Deployments related list. View your current deployment. View the success log and the error log for the components that have been deployed successfully.
This newly created deployment can be deployed upstream (to your QA, UAT and Stage organizations) or downstream(to any of your development environments).
- Login to the target organization.
- Make a change to the Visualforce page. It could be as simple as adding a quick comment to the page.
- Goto the Flosum organization and create another snapshot for the Source Organization as described in Step 3 above. Call this snapshot SourceSnaphot_2.
- Login to Flosum.
- Click on Orgs tab.
- Click on Target Organization.
- Click on Create Snapshot - TargetSnapshot_1
- Give it a name - TargetSnapshot and select the number of modified days to 1.
Step 7: Compare two orgs.
- Login to Flosum (if required).
- Click on Snapshot comparison tab.
- On the left hand side, Select Source organization.
- Select Snapshot: SourceSnapshot_2.
- On the right hand side, Select Target Organization.
- Select Snapshot: TargetSnapshot.
- Leave the Compare Different checkbox checked. If the checkbox is checked, it will show you only the missing and different components in the table below.
- First choose the Metadata type: ApexPage and then, Custom Object.
Step 8: Create a private branch
Typically, a new branch is created for every new feature, user story or bug fix. In Flosum, a branch can be shared by multiple developers.
Once the code is ready to be committed to version control, they can merge the code with the repository.
- Click on the Branches tab.
- Create a new Branch - Let's call it NewFeature.
- Go back to snapshot SourceSnapshot_1 that you created from the source organization.
- Click on the Commit button for snapshot.
- Select the components (Visualforce page and custom object) that you just created in the source organization.
- Goto the branch that you just created.
- Click on the Merge button.
- You will see the page divided into three sections:
- Already updated components: There is no change in these components. The version control will not be updated with these components.
- Safe components: These components are safe to be committed with version control.
- Conflicting components: These components have been updated by some other user since you started working on your branch. You can view the side-by-side comparison of your latest feature with the latest component from the branch.
4. Click on Merge. Your components are now in the version control.
Version Control keeps complete and audit details of each component.
- Click on the Deployments tab.
- Click on New
- Click on Repository
- Please enter the name of the Deployment
- Select components that you just committed. (Visualforce page and custom object).
- Click Add to Deployment.
- Click on Deploy. Select the Target Organization and deploy the deployment.
- Observe: Go back to the patch page. Scroll down to the Deployment related list.
- Click on Deployment Name.
- Click on Deployment URL.
- Inspect the Success Log and Error Log.
Step 11: Automate Continuous Integration
- Click on the Settings page.
- Enter the "Build Organization" on the Settings page. Build Organization should be a replica (or have the baseline) as your source organization.
Steps for Continuous Integration:
- Go to the source organization.
- Change the Visualforce page.
- Go to Flosum organization.
- Create a snapshot - SourceSnapshot2 - to get the changes done in last 1 day.
- On the snapshot page, commit the changes to the old branch that you have created - NewBranch.
- Merge the changes with the repository.
Observe: Go to the builds tab. You will see the new code changes that were created were packaged and automatically deployed to the build organization. Also, all the test classes for that organization were run automatically.
For advanced users, there is a lot to explore. Please see the advanced features sections that you can play with.
Step 12: Reports
- Destructive Changes
- Profile & Permission set Migration
- Integration with Agile Accelerator
- Automatic Rollback
- Running tests in Sandbox