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:

• Snippets — small, atomic examples of single-step use cases.
• Patterns — walkthroughs of common multi-step implementation patterns.

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.

Java Python Raw REST API

apiName

builder.apiName("String0"); // (1)
salesforce.getApiName(); // (2)
client.assets.select().where(Salesforce.API_NAME.eq("String0")); // (3)
client.assets.select().where(Salesforce.API_NAME.match("String0")); // (4)

1. Set the apiName for a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiName from a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. 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.

4. 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

builder.organizationQualifiedName("String0"); // (1)
salesforce.getOrganizationQualifiedName(); // (2)
client.assets.select().where(Salesforce.ORGANIZATION_QUALIFIED_NAME.eq("String0")); // (3)

1. Set the organizationQualifiedName for a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the organizationQualifiedName from a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. 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

builder.api_name = ...  # (1)
salesforce.api_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Salesforce)).where(Salesforce.API_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Salesforce)).where(Salesforce.API_NAME.match("String0"))  # (4)

1. Set the api_name for a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_name from a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. 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.

4. 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

builder.organization_qualified_name = ...  # (1)
salesforce.organization_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Salesforce)).where(Salesforce.ORGANIZATION_QUALIFIED_NAME.eq("String0"))  # (3)

1. Set the organization_qualified_name for a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the organization_qualified_name from a Salesforce.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. 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

{
  "attributes": {
    "apiName": "String0" // (1)
  }
}

1. Set the apiName for a Salesforce.

   For more details

   For more information, see the asset CRUD snippets.

organizationQualifiedName

{
  "attributes": {
    "organizationQualifiedName": "String0" // (1)
  }
}

1. Set the organizationQualifiedName for a Salesforce.

   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