Ctrlk
Customer Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieving Organization Metadata

Overview

In Flosum Cloud DevOps, a Retrieve job fetches the most recent version of your organization’s metadata: the components that make up a branch. Each Retrieve job fetches only the components that have changed since the last retrieval.

This metadata is retrieved automatically every hour to keep you up to date on changes. Even so, it’s recommended to manually retrieve metadata before committing or deploying a branch that uses this organization, so you’re working with the latest data.

With a manual retrieve, you can configure a declarative filter to retrieve only the components that match the filter. This reduces the time a Retrieve job takes when many unnecessary components have changed in the organization.

This guide explains how to manually retrieve metadata for an organization.

Retrieve Settings’ Excluded Components

If you have configured this organization’s Retrieve Settings to exclude any components from Retrieve jobs, excluded components are also left out of a manual retrieve, even when a Declarative Filter would normally include them. See the following article for more details about Retrieve Settings.

What is Metadata?

Read the following Salesforce article to learn more about what Salesforce metadata is and how it is used.

Retrieve Metadata

1

Start Retrieve

  1. Click Organizations from the left sidebar menu.

  2. Click the organization to retrieve metadata from.

  3. Click Retrieve.

2

(Optional) Add Declarative Filter

  1. Click the Declarative filter toggle.

  2. Click the Select field dropdown menu.

  3. Select the field to use for the filter condition.

  4. Click the Select option dropdown menu.

  5. Select the logic operation to use for the filter condition.

  6. Enter a filter Value in the last filter box of the filter condition.

The last filter box of the filter condition adapts to the type of Field selected in the first filter box. For example, in the screenshot above, lastModifiedDate is selected, so clicking the last filter box opens a date picker where you can select a valid date.

3

(Optional) Add Multiple Declarative Filters

You can add multiple declarative filter conditions and combine them in two ways:

Basic Logic

All filter conditions are combined with an AND operation, meaning all filter conditions must be met.

Custom Logic

You can combine filter conditions by defining your own logic using AND, OR, and () operations. Filter conditions are referenced by their row number. For example, 2 AND (1 OR 3) means that the filter is true if condition 2 is met and either condition 1 or condition 3 is met.

  1. Click Add Filter to add another filter condition.

  2. Complete the filter by following the instructions in the section above.

  3. Repeat this process to add as many filter conditions as needed.

  4. Determine how you want the filter conditions combined. See the table above for an explanation of the options. If Basic Logic is used, no other action is necessary.

Use Custom Logic

  1. Select the Custom option to enable custom logic.

  2. Enter your custom logic in the text box to the right of the dropdown menu.

Custom logic can use AND, OR, and () operations to combine filter conditions by their row number.

4

Run Retrieve

  1. Click Run once you have finished configuring the Retrieve job.

  2. After starting the Retrieve job, you will be taken to the Activities tab, where you can view its status.

Retrieve Status

The Retrieve job can take several minutes to complete, depending on how many components it is retrieving. The job starts as Queued, then changes to In Progress once it begins working. Click the refresh button to update the job status.

For large Retrieve jobs, the status may show Partially Completed. This means some components have already been retrieved and are available to use while the job continues retrieving the rest in the background.

  1. Wait for the job status to show Completed.

5

View Log

In the Retrieve job log, you can track the actions taken, including components added or deleted since the last retrieval. It also highlights errors, which is crucial for troubleshooting. For more details about the Retrieve job’s results and logs, see the following article.

  1. Click the job’s Retrieve link to view the log.

  2. The following screenshot shows an example of a Partially Completed job that has not yet detected any changed components.

PreviousIndividual Organizations
NextUsing an Organization's Components Tab

Last updated

Was this helpful?