Objects
For a data object to show up in Gearset after selecting the source and target for a data deployment, several conditions need to be met:
The object metadata type needs to exist on both the source and target (with the same API name), and the fields need to be identical. For example, to deploy knowledge articles, you would deploy the metadata component first, followed by the data, as explained in this article.
The user needs to have permission to access the object.
The object must be
queryable
andretrievable
in the source, and
createable
andupdateable
in the target. You can check these properties using Workbench: https://workbench.developerforce.com/describe.php.
If these conditions are met, then you should see the object as a top-level selectable item in the first stage of configuring your data deployment in Gearset:
If you only just added the object to either the source or target org, try starting a new data deployment to make it show up (as we cache the object list within the deployment).
Exceptions
Limitation of data deployment:
User - this is because each Salesforce username is unique across orgs
UserRole
RecordType
Group
GroupMember
If your object isn't on the exception list, and you think you have met all the conditions, but you still can't find what you need, talk to us via the in-app chat!
Fields
Firstly, note that these fields cannot be deployed:
some
base64
fields (this is a work in progress, check this article for details)deprecatedAndHidden
fields that are eithernillable
ordefaultedOnCreate
To be able to deploy a field:
It must exist on both the source and target.
It should be
createable
andupdateable
. (If a field iscreateable
but notupdateable
, it can be deployed if the field is notnillable
and notdefaultedOnCreate
.) You can check these properties using Workbench, as mentioned above for objects: https://workbench.developerforce.com/describe.php.
In addition to this, if a field is a lookup field (or master-detail field), it will only be deployed if:
All objects that it points to can be deployed (as described above).
All objects that it points to have been included in the data deployment, either in the page where you first select objects (below), or on the page afterward where you confirm/select related objects.
The relationship field has been included in the deployment as a
reference field to deploy
:
Note that if the lookup field points to multiple objects (such as Task.WhatId
), all the possible objects it can point to must meet these requirements, or the field will not be deployed.