NAME
WWW::SFDC - Wrappers around the Salesforce.com APIs.
VERSION
version 0.25
SYNOPSIS
WWW::SFDC provides a set of packages which you can use to build useful interactions with Salesforce.com's many APIs. Initially it was intended for the construction of powerful and flexible deployment tools.
use WWW::SFDC; # Import everything
use WWW::SFDC::Tooling; # Just the tooling API interface
use WWW::SFDC qw'Metadata Manifest';
# Equivalent to importing WWW::SFDC::Metadata and WWW::SFDC::Manifest
CONTENTS
- WWW::SFDC::SessionManager
-
Provides the lowest-level interaction with SOAP::Lite. Handles the SessionID and renews it when necessary.
- WWW::SFDC::Manifest
-
Stores and manipulates lists of metadata for retrieving and deploying to and from Salesforce.com.
- WWW::SFDC::Metadata
-
Wraps the Metadata API.
- WWW::SFDC::Partner
-
Wraps the Partner API.
- WWW::SFDC::Tooling
-
Wraps the Tooling API.
- WWW::SFDC::Zip
-
Provides utilities for creating and extracting base-64 encoded zip files for Salesforce.com retrievals and deployments.
METADATA API EXAMPLES
The following provides a starting point for a simple retrieval tool. Notice that after the initial setup of WWW::SFDC::Metadata the login credentials are cached. In this example, you'd use _retrieveTimeMetadataChanges to remove files you didn't want to track, change sandbox outbound message endpoints to production, or similar.
Notice that I've tried to keep the interface as fluent as possible in all of these modules - every method which doesn't have an obvious return value returns $self.
package ExampleRetrieval;
use WWW::SFDC::Metadata;
use WWW::SFDC::Manifest;
use WWW::SFDC::Zip qw'unzip';
WWW::SFDC::Metadata->instance(creds => {
password => $password,
username => $username,
url => $url
});
my $manifest = WWW::SFDC::Manifest
->readFromFile($manifestFile)
->add(
WWW::SFDC::Metadata
->instance()
->listMetadata(
{type => 'Document', folder => 'Apps'},
{type => 'Document', folder => 'Developer_Documents'},
{type => 'EmailTemplate', folder => 'Asset'},
{type => 'ApexClass'}
)
);
unzip
$destDir,
WWW::SFDC::Metadata->instance()->retrieveMetadata($manifest->manifest()),
\&_retrieveTimeMetadataChanges;
Here's a similar example for deployments. You'll want to construct @filesToDeploy and $deployOptions context-sensitively!
package ExampleDeployment;
use WWW::SFDC::Metadata;
use WWW::SFDC::Manifest;
use WWW::SFDC::Zip qw'makezip';
my $manifest = WWW::SFDC::Manifest
->new()
->addList(@filesToDeploy)
->writeToFile($srcDir.'package.xml');
my $zip = makezip
$srcDir,
$manifest->getFileList(),
'package.xml';
my $deployOptions = {
singlePackage => 'true',
rollbackOnError => 'true',
checkOnly => 'true'
};
WWW::SFDC::Metadata->instance(creds => {
username=>$username,
password=>$password,
url=>$url
})->deployMetadata $zip, $deployOptions;
PARTNER API EXAMPLE
To unsanitise some users' email address and change their profiles on a new sandbox, you might do something like this:
package ExampleUserSanitisation;
use WWW::SFDC::Partner;
use List::Util qw'first';
WWW::SFDC::Partner->instance(creds => {
username => $username,
password => $password,
url => $url
});
my @users = (
{User => alexander.brett, Email => alex@example.com, Profile => $profileId},
{User => another.user, Email => a.n.other@example.com, Profile => $profileId},
);
WWW::SFDC::Partner->instance()->update(
map {
my $row = $_;
my $original = first {$row->{Username} =~ /$$_{User}/} @users;
+{
Id => $row->{Id},
ProfileId => $original->{Profile},
Email => $original->{Email},
}
} WWW::SFDC::Partner->instance()->query(
"SELECT Id, Username FROM User WHERE "
. (join " OR ", map {"Username LIKE '%$_%'"} map {$_->{User}} @inputUsers)
)
);
BUGS
Please report any bugs or feature requests at https://github.com/alexander-brett/WWW-SFDC/issues.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc WWW::SFDC
perldoc WWW::SFDC::Metadata
...
You can also look for information at https://github.com/alexander-brett/WWW-SFDC
AUTHOR
Alexander Brett <alexander.brett@sophos.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2015 by Sophos Limited.
This is free software, licensed under:
The MIT (X11) License
The full text of the license can be found in the LICENSE file included with this distribution.