cumulusci.tasks.metadata package

Submodules

class cumulusci.tasks.metadata.ee_src.CreateUnmanagedEESrc(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

elements = ['*.object:availableFields', "*.object:visibility[.='Protected']"]
task_options = {'path': {'description': 'The path containing metadata to process for managed deployment', 'required': True}, 'revert_path': {'description': 'The path to copy the original metadata to for the revert call', 'required': True}}
class cumulusci.tasks.metadata.ee_src.RevertUnmanagedEESrc(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

task_options = {'path': {'description': 'The path containing metadata to process for managed deployment', 'required': True}, 'revert_path': {'description': 'The path to copy the original metadata to for the revert call', 'required': True}}
class cumulusci.tasks.metadata.managed_src.CreateManagedSrc(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

managed_token = '//cumulusci-managed'
task_options = {'path': {'description': 'The path containing metadata to process for managed deployment', 'required': True}, 'revert_path': {'description': 'The path to copy the original metadata to for the revert call', 'required': True}}
class cumulusci.tasks.metadata.managed_src.RevertManagedSrc(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

task_options = {'path': {'description': 'The path containing metadata to process for managed deployment', 'required': True}, 'revert_path': {'description': 'The path to copy the original metadata to for the revert call', 'required': True}}
class cumulusci.tasks.metadata.modify.RemoveElementsXPath(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

Remove elements based on an XPath.

task_options = {'chdir': {'description': 'Change the current directory before running the replace'}, 'elements': {'description': 'A list of dictionaries containing path and xpath keys. Multiple dictionaries can be passed in the list to run multiple removal queries in the same task. This parameter is intended for usages invoked as part of a cumulusci.yml .'}, 'path': {'description': 'A path to the files to change. Supports wildcards including ** for directory recursion. More info on the details: https://www.poftut.com/python-glob-function-to-match-path-directory-file-names-with-examples/ https://www.tutorialspoint.com/How-to-use-Glob-function-to-find-files-recursively-in-Python '}, 'xpath': {'description': "An XPath specification of elements to remove. Supports the re: regexp function namespace. As in re:match(text(), '.*__c')Use ns: to refer to the Salesforce namespace for metadata elements.for example: ./ns:Layout/ns:relatedLists (one-level) or //ns:relatedLists (recursive)Many advanced examples are available here: https://github.com/SalesforceFoundation/NPSP/blob/26b585409720e2004f5b7785a56e57498796619f/cumulusci.yml#L342"}}
class cumulusci.tasks.metadata.package.BaseMetadataParser(metadata_type, directory, extension, delete)[source]

Bases: object

check_delete_excludes(item)[source]
get_delete_excludes()[source]
parse_item(item)[source]
parse_items()[source]
render_xml()[source]
strip_extension(filename)[source]
class cumulusci.tasks.metadata.package.BundleParser(metadata_type, directory, extension, delete)[source]

Bases: cumulusci.tasks.metadata.package.BaseMetadataParser

class cumulusci.tasks.metadata.package.BusinessProcessParser(metadata_type, directory, extension, delete, item_xpath=None, name_xpath=None)[source]

Bases: cumulusci.tasks.metadata.package.MetadataXmlElementParser

check_delete_excludes(item)[source]
class cumulusci.tasks.metadata.package.CustomLabelsParser(metadata_type, directory, extension, delete, item_xpath=None, name_xpath=None)[source]

Bases: cumulusci.tasks.metadata.package.MetadataXmlElementParser

item_name_prefix(parent)[source]
class cumulusci.tasks.metadata.package.CustomObjectParser(metadata_type, directory, extension, delete)[source]

Bases: cumulusci.tasks.metadata.package.MetadataFilenameParser

class cumulusci.tasks.metadata.package.DocumentParser(metadata_type, directory, extension, delete)[source]

Bases: cumulusci.tasks.metadata.package.MetadataFolderParser

class cumulusci.tasks.metadata.package.MetadataFilenameParser(metadata_type, directory, extension, delete)[source]

Bases: cumulusci.tasks.metadata.package.BaseMetadataParser

class cumulusci.tasks.metadata.package.MetadataFolderParser(metadata_type, directory, extension, delete)[source]

Bases: cumulusci.tasks.metadata.package.BaseMetadataParser

check_delete_excludes(item)[source]
exception cumulusci.tasks.metadata.package.MetadataParserMissingError[source]

Bases: Exception

class cumulusci.tasks.metadata.package.MetadataXmlElementParser(metadata_type, directory, extension, delete, item_xpath=None, name_xpath=None)[source]

Bases: cumulusci.tasks.metadata.package.BaseMetadataParser

check_delete_excludes(item)[source]
get_item_elements(root)[source]
get_item_name(item, parent)[source]

Returns the value of the first name element found inside of element

get_name_elements(item)[source]
item_name_prefix(parent)[source]
namespaces = {'sf': 'http://soap.sforce.com/2006/04/metadata'}
exception cumulusci.tasks.metadata.package.MissingNameElementError[source]

Bases: Exception

class cumulusci.tasks.metadata.package.PackageXmlGenerator(directory, api_version, package_name=None, managed=None, delete=None, install_class=None, uninstall_class=None, types=None)[source]

Bases: object

parse_types()[source]
render_xml()[source]
exception cumulusci.tasks.metadata.package.ParserConfigurationError[source]

Bases: Exception

class cumulusci.tasks.metadata.package.RecordTypeParser(metadata_type, directory, extension, delete, item_xpath=None, name_xpath=None)[source]

Bases: cumulusci.tasks.metadata.package.MetadataXmlElementParser

check_delete_excludes(item)[source]
class cumulusci.tasks.metadata.package.UpdatePackageXml(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

task_options = {'delete': {'description': 'If True, generate a package.xml for use as a destructiveChanges.xml file for deleting metadata'}, 'managed': {'description': 'If True, generate a package.xml for deployment to the managed package packaging org'}, 'output': {'description': 'The output file, defaults to <path>/package.xml'}, 'package_name': {'description': 'If set, overrides the package name inserted into the <fullName> element'}, 'path': {'description': 'The path to a folder of metadata to build the package.xml from', 'required': True}}
cumulusci.tasks.metadata.package.metadata_sort_key(name)[source]
cumulusci.tasks.metadata.package.metadata_sort_key_section(name)[source]

Module contents