Salesforce¶
Base class for Salesforce assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing Salesforce assets in Atlan. For that, we would suggest starting with either:
classDiagram
direction RL
class Salesforce {
<<abstract>>
}
link Salesforce "../salesforce"
class SaaS {
<<abstract>>
}
link SaaS "../entities/saas"
SaaS <|-- Salesforce : extends
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- SaaS : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class SalesforceObject
link SalesforceObject "../entities/salesforceobject"
Salesforce <|-- SalesforceObject : extends
class SalesforceField
link SalesforceField "../entities/salesforcefield"
Salesforce <|-- SalesforceField : extends
class SalesforceOrganization
link SalesforceOrganization "../entities/salesforceorganization"
Salesforce <|-- SalesforceOrganization : extends
class SalesforceDashboard
link SalesforceDashboard "../entities/salesforcedashboard"
Salesforce <|-- SalesforceDashboard : extends
class SalesforceReport
link SalesforceReport "../entities/salesforcereport"
Salesforce <|-- SalesforceReport : extends
Type-specific properties¶
Following are the properties uniquely available on Salesforce
assets in Atlan.
apiName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
apiName
for aSalesforce
. -
Retrieve the
apiName
from aSalesforce
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
apiName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
apiName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
organizationQualifiedName
TBC | |
---|---|
1 2 3 |
|
-
Set the
organizationQualifiedName
for aSalesforce
. -
Retrieve the
organizationQualifiedName
from aSalesforce
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
organizationQualifiedName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
api_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
api_name
for aSalesforce
. -
Retrieve the
api_name
from aSalesforce
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
api_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
api_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
organization_qualified_name
TBC | |
---|---|
1 2 3 |
|
-
Set the
organization_qualified_name
for aSalesforce
. -
Retrieve the
organization_qualified_name
from aSalesforce
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
organization_qualified_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
apiName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
apiName
for aSalesforce
.For more details
For more information, see the asset CRUD snippets.
organizationQualifiedName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
organizationQualifiedName
for aSalesforce
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various Salesforce objects inter-relate with each other:
erDiagram
Connection ||..o{ SalesforceOrganization : ""
SalesforceOrganization |o--o{ SalesforceDashboard : dashboards
SalesforceOrganization |o--o{ SalesforceObject : objects
SalesforceOrganization |o--o{ SalesforceReport : reports
SalesforceDashboard }o--o{ SalesforceReport : reports
SalesforceObject |o--o{ SalesforceField : fields
SalesforceObject |o--o{ SalesforceField : lookupFields