API Reference

Information on specific functions, classes, and methods.

• cumulusci package
  • Subpackages
    • cumulusci.cli package
    • cumulusci.core package
    • cumulusci.oauth package
    • cumulusci.robotframework package
    • cumulusci.salesforce_api package
    • cumulusci.tasks package
    • cumulusci.utils package
  • Submodules
  • cumulusci.conftest module
• cumulusci.cli package
  • Submodules
  • cumulusci.cli.cci module
  • cumulusci.cli.logger module
  • cumulusci.cli.runtime module
  • cumulusci.cli.ui module
  • cumulusci.cli.utils module
• cumulusci.core package
  • Subpackages
    • cumulusci.core.config package
    • cumulusci.core.keychain package
    • cumulusci.core.source package
  • Submodules
  • cumulusci.core.exceptions module
  • cumulusci.core.flowrunner module
  • cumulusci.core.github module
  • cumulusci.core.runtime module
  • cumulusci.core.sfdx module
  • cumulusci.core.tasks module
  • cumulusci.core.template_utils module
  • cumulusci.core.utils module
• cumulusci.core.config package
  • Submodules
  • cumulusci.core.config.BaseConfig module
  • cumulusci.core.config.BaseTaskFlowConfig module
  • cumulusci.core.config.OrgConfig module
  • cumulusci.core.config.ScratchOrgConfig module
  • cumulusci.core.config.project_config module
  • cumulusci.core.config.sfdx_org_config module
  • cumulusci.core.config.universal_config module
• cumulusci.core.keychain package
  • Submodules
  • cumulusci.core.keychain.BaseEncryptedProjectKeychain module
  • cumulusci.core.keychain.EnvironmentProjectKeychain module
  • cumulusci.core.keychain.base_project_keychain module
  • cumulusci.core.keychain.encrypted_file_project_keychain module
• cumulusci.core.source package
  • Submodules
  • cumulusci.core.source.github module
  • cumulusci.core.source.local_folder module
• cumulusci.oauth package
  • Submodules
  • cumulusci.oauth.exceptions module
  • cumulusci.oauth.salesforce module
• cumulusci.robotframework package
  • Subpackages
    • cumulusci.robotframework.pageobjects package
  • Submodules
  • cumulusci.robotframework.CumulusCI module
  • cumulusci.robotframework.Salesforce module
  • cumulusci.robotframework.locator_manager module
  • cumulusci.robotframework.locators_49 module
  • cumulusci.robotframework.locators_50 module
  • cumulusci.robotframework.locators_51 module
  • cumulusci.robotframework.utils module
• cumulusci.robotframework.pageobjects package
  • Submodules
  • cumulusci.robotframework.pageobjects.BasePageObjects module
  • cumulusci.robotframework.pageobjects.ObjectManagerPageObject module
  • cumulusci.robotframework.pageobjects.PageObjectLibrary module
  • cumulusci.robotframework.pageobjects.PageObjects module
  • cumulusci.robotframework.pageobjects.baseobjects module
• cumulusci.salesforce_api package
  • Submodules
  • cumulusci.salesforce_api.exceptions module
  • cumulusci.salesforce_api.metadata module
  • cumulusci.salesforce_api.package_install module
  • cumulusci.salesforce_api.package_zip module
  • cumulusci.salesforce_api.soap_envelopes module
  • cumulusci.salesforce_api.utils module
• cumulusci.tasks package
  • Subpackages
    • cumulusci.tasks.apex package
    • cumulusci.tasks.bulkdata package
    • cumulusci.tasks.github package
    • cumulusci.tasks.metadata package
    • cumulusci.tasks.metadata_etl package
    • cumulusci.tasks.preflight package
    • cumulusci.tasks.push package
    • cumulusci.tasks.release_notes package
    • cumulusci.tasks.robotframework package
    • cumulusci.tasks.salesforce package
  • Submodules
  • cumulusci.tasks.command module
  • cumulusci.tasks.connectedapp module
  • cumulusci.tasks.datadictionary module
  • cumulusci.tasks.metadeploy module
  • cumulusci.tasks.metaxml module
  • cumulusci.tasks.package_2gp module
  • cumulusci.tasks.sfdx module
  • cumulusci.tasks.util module
• cumulusci.tasks.apex package
  • Submodules
  • cumulusci.tasks.apex.anon module
  • cumulusci.tasks.apex.batch module
  • cumulusci.tasks.apex.testrunner module
• cumulusci.tasks.bulkdata package
  • Submodules
  • cumulusci.tasks.bulkdata.base_generate_data_task module
  • cumulusci.tasks.bulkdata.dates module
  • cumulusci.tasks.bulkdata.delete module
  • cumulusci.tasks.bulkdata.extract module
  • cumulusci.tasks.bulkdata.factory_utils module
  • cumulusci.tasks.bulkdata.generate module
  • cumulusci.tasks.bulkdata.generate_and_load_data module
  • cumulusci.tasks.bulkdata.generate_and_load_data_from_yaml module
  • cumulusci.tasks.bulkdata.generate_from_yaml module
  • cumulusci.tasks.bulkdata.generate_mapping module
  • cumulusci.tasks.bulkdata.load module
  • cumulusci.tasks.bulkdata.mapping_parser module
  • cumulusci.tasks.bulkdata.step module
  • cumulusci.tasks.bulkdata.utils module
• cumulusci.tasks.github package
  • Submodules
  • cumulusci.tasks.github.base module
  • cumulusci.tasks.github.commit_status module
  • cumulusci.tasks.github.merge module
  • cumulusci.tasks.github.publish module
  • cumulusci.tasks.github.pull_request module
  • cumulusci.tasks.github.release module
  • cumulusci.tasks.github.release_report module
  • cumulusci.tasks.github.tag module
  • cumulusci.tasks.github.util module
• cumulusci.tasks.metadata package
  • Submodules
  • cumulusci.tasks.metadata.ee_src module
  • cumulusci.tasks.metadata.managed_src module
  • cumulusci.tasks.metadata.modify module
  • cumulusci.tasks.metadata.package module
• cumulusci.tasks.metadata_etl package
  • Submodules
  • cumulusci.tasks.metadata_etl.base module
  • cumulusci.tasks.metadata_etl.duplicate_rules module
  • cumulusci.tasks.metadata_etl.help_text module
  • cumulusci.tasks.metadata_etl.layouts module
  • cumulusci.tasks.metadata_etl.permissions module
  • cumulusci.tasks.metadata_etl.picklists module
  • cumulusci.tasks.metadata_etl.sharing module
  • cumulusci.tasks.metadata_etl.value_sets module
• cumulusci.tasks.preflight package
  • Submodules
  • cumulusci.tasks.preflight.licenses module
  • cumulusci.tasks.preflight.packages module
  • cumulusci.tasks.preflight.settings module
  • cumulusci.tasks.preflight.sobjects module
• cumulusci.tasks.push package
  • Submodules
  • cumulusci.tasks.push.push_api module
  • cumulusci.tasks.push.pushfails module
  • cumulusci.tasks.push.tasks module
• cumulusci.tasks.release_notes package
  • Submodules
  • cumulusci.tasks.release_notes.exceptions module
  • cumulusci.tasks.release_notes.generator module
  • cumulusci.tasks.release_notes.parser module
  • cumulusci.tasks.release_notes.provider module
  • cumulusci.tasks.release_notes.task module
• cumulusci.tasks.robotframework package
  • Subpackages
    • cumulusci.tasks.robotframework.debugger package
  • Submodules
  • cumulusci.tasks.robotframework.libdoc module
  • cumulusci.tasks.robotframework.lint module
  • cumulusci.tasks.robotframework.robotframework module
• cumulusci.tasks.robotframework.debugger package
  • Submodules
  • cumulusci.tasks.robotframework.debugger.DebugListener module
  • cumulusci.tasks.robotframework.debugger.model module
  • cumulusci.tasks.robotframework.debugger.ui module
• cumulusci.tasks.salesforce package
  • Submodules
  • cumulusci.tasks.salesforce.BaseRetrieveMetadata module
  • cumulusci.tasks.salesforce.BaseSalesforceApiTask module
  • cumulusci.tasks.salesforce.BaseSalesforceMetadataApiTask module
  • cumulusci.tasks.salesforce.BaseSalesforceTask module
  • cumulusci.tasks.salesforce.BaseUninstallMetadata module
  • cumulusci.tasks.salesforce.CreateCommunity module
  • cumulusci.tasks.salesforce.CreatePackage module
  • cumulusci.tasks.salesforce.Deploy module
  • cumulusci.tasks.salesforce.DeployBundles module
  • cumulusci.tasks.salesforce.EnsureRecordTypes module
  • cumulusci.tasks.salesforce.GetInstalledPackages module
  • cumulusci.tasks.salesforce.ListCommunities module
  • cumulusci.tasks.salesforce.ListCommunityTemplates module
  • cumulusci.tasks.salesforce.PublishCommunity module
  • cumulusci.tasks.salesforce.RetrievePackaged module
  • cumulusci.tasks.salesforce.RetrieveReportsAndDashboards module
  • cumulusci.tasks.salesforce.RetrieveUnpackaged module
  • cumulusci.tasks.salesforce.SOQLQuery module
  • cumulusci.tasks.salesforce.UninstallLocal module
  • cumulusci.tasks.salesforce.UninstallLocalBundles module
  • cumulusci.tasks.salesforce.UninstallLocalNamespacedBundles module
  • cumulusci.tasks.salesforce.UninstallPackage module
  • cumulusci.tasks.salesforce.UninstallPackaged module
  • cumulusci.tasks.salesforce.UninstallPackagedIncremental module
  • cumulusci.tasks.salesforce.UpdateAdminProfile module
  • cumulusci.tasks.salesforce.activate_flow module
  • cumulusci.tasks.salesforce.create_permission_sets module
  • cumulusci.tasks.salesforce.custom_settings module
  • cumulusci.tasks.salesforce.custom_settings_wait module
  • cumulusci.tasks.salesforce.insert_record module
  • cumulusci.tasks.salesforce.install_package_version module
  • cumulusci.tasks.salesforce.license_preflights module
  • cumulusci.tasks.salesforce.org_settings module
  • cumulusci.tasks.salesforce.package_upload module
  • cumulusci.tasks.salesforce.sourcetracking module
  • cumulusci.tasks.salesforce.trigger_handlers module
  • cumulusci.tasks.salesforce.update_dependencies module
  • cumulusci.tasks.salesforce.update_profile module
• cumulusci.utils package
  • Subpackages
    • cumulusci.utils.xml package
  • Submodules
  • cumulusci.utils.fileutils module
  • cumulusci.utils.git module
  • cumulusci.utils.logging module
  • cumulusci.utils.waiting module
  • cumulusci.utils.ziputils module
• cumulusci.utils.xml package
  • Submodules
  • cumulusci.utils.xml.metadata_tree module
  • cumulusci.utils.xml.salesforce_encoding module