Downloads and Uploads to SalesForce from BoardEx stfp
Project description
Introduction
- boardex_salesforce package connects to salesforce bulk api. Downloads contact and accounts data.
- Uploads the downloaded data to BoardEx SFTP for concordance.
- Uploads BoardExID to salesforce from the concordance results.
Requirements
- BoardEx app on salesforce
- Python 3
Installation
pip install boardex-salesforce
Overview
boardex_salesforce package has pre-build modules. The two main ones are:
- run_daily
- run_monthly
Usage
from boardex_salesforce import config
config.username = 'username@salesforce.com'
config.password='salesforcePassword'
config.security_token='salesforce_security_token'
run_daily
from boardex_salesforce import run_daily
run_daily.run_daily()
This script calls the methods:
- download_ContactDetails_from_sf
- download_UserDetails_from_sf
They download all the user relationship and contact details and place them in a download folder.
run_daily
from boardex_salesforce import run_monthly
run_monthly.run_monthly()
Please note if sftp is not being used, a folder must be created with the name 'upload' and place all the output csv files from BoardEx inside the upload folder
This script calls the methods:
- upload_to_sf
- download_company_from_sf
- download_contact_from_sf
- download_ContactDetails_from_sf
- download_UserDetails_from_sf
upload_to_sf uploads all the contact and conpany csv OUT file to salesforce
Parameters accessible from config
Boardex sftp credentials
The sftp credentials are provided by BoardEx, leave empty if not provided
config.myHostname
config.myPassword
config.myUsername
Upload to sftp
- To upload to sftp server, sftp credentials are required and set upload_to_sftp = True
- By default the upload_to_sftp is set to false. (The csv files will not be uploaded to the sftp server)
config.upload_to_sftp = False
log level
- Python has 6 log levels: CRITICAL, ERROR, WARNING, INFO, DEBUG and NOTSET
- The default log level is set to CRITICAL if not selected
- If log_level is NOTSET, no logs will be provided
config.log_level = 'DEBUG'
query_email
query_email is a boolean if set to True downloads email address from salesforce
- If set to False, Email data will not be retrieved from the contact_query
config.query_email = True
path_local_temp
Specifies where to place the logs, download and upload folder on local machine
config.config.path_local_temp
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for boardex_salesforce-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f214e1808551337fcb6a246df7a040cfd1337eb03d83c6af1e030be6017b7f7 |
|
MD5 | 70493ab8a6b22e0576fe33dd4ed5a707 |
|
BLAKE2b-256 | 25065deb74a3774b1ce9dcd6f9da8739abb8ca633ec270da8ff9874584153034 |