NAME

WWW::Salesforce::Simple.pm - this class provides a simpler abstraction layer between WWW::Salesforce and Salesforce.com.

DESCRIPTION

Because the Salesforce API is somewhat cumbersome to deal with, this class was created to make it a little simpler to get information.

METHODS

This class inherits all the methods from WWW::Salesforce and adds the following new ones.

new( %parameters )

Handles creating new Salesforce objects as well as the login process to use the salesforce objects.

do_query( $sql_query_string )

Executes a query against the information in Salesforce. Returns a reference to an array of hash references keyed by the column names. Strict attention should be paid to the case of the field names.

do_queryAll( $sql_query_string )

Executes a query against the information in Salesforce. Returns a reference to an array of hash references keyed by the column names that includes deleted and archived objects. Strict attention should be paid to the case of the field names.

get_field_list( $table_name )

Gathers a list of fields contained in a given table. Returns a reference to an array of hash references. The hash references have several keys which provide information about the field's type, etc. The key 'name' will provide the name of the field itself.

get_tables( )

Gathers a list of tables available for use from salesforce. Returns a reference to an array of strings representing each table name.

EXAMPLES

new()

    use WWW::Salesforce::Simple;

    my $sforce = WWW::Salesforce::Simple->new(
        'username' => $user,
        'password' => $pass
    );

do_query( $query )

    my $query = 'select Id from Account';

    my $res = $sforce->do_query( $query );

    foreach my $field ( @{ $res } ) {
        print $field->{'Id'} . "\n";
    }
    print "Found " . scalar @{$res} . " results\n";

do_queryAll( $query )

    my $query = 'select Id from Account';

    my $res = $sforce->do_queryAll( $query );

    foreach my $field ( @{ $res } ) {
        print $field->{'Id'} . "\n";
    }
    print "Found " . scalar @{$res} . " results\n";

get_field_list( $table_name )

    my $fields_ref = $sforce->get_field_list( 'Account' );

    foreach my $field( @{$fields_ref} ) {
        print $field->{'name'} . "\n";
        foreach my $key ( keys %{$field} ) {
            print "\t $key --> ";
            print $field->{$key} if ( $field->{$key} );
            print "\n";
        }
        print "\n";
    }

get_tables()

    my $tables_ref = $sforce->get_tables();

    foreach my $table ( @{$tables_ref} ) {
        print "$table\n";
    }
    print "\n";

SUPPORT

Please visit Salesforce.com's user/developer forums online for assistance with this module. You are free to contact the author directly if you are unable to resolve your issue online.

AUTHORS

Chase Whitener <capoeirab@cpan.org>

Fred Moyer <fred at redhotpenguin dot com>

COPYRIGHT & LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.