Adding Veeva Vault Objects example #56

fivetran-kirkvanarkel · 2024-11-25T18:52:14Z

No description provided.

height · 2024-11-25T18:52:18Z

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

varundhall · 2024-12-04T08:10:59Z

README.md

@@ -114,6 +114,10 @@ Refer to the Multithreading Guidelines in api_threading_utils.py
 This is an example of how we can sync Smartsheets sheets via Connector SDK.
 You would need to provide your Smartsheets api_key for this example to work.

+### veeva vault objects
+This is an example of how we can sync Veeva Vault Object data using VQL via Connector SDK.
+You would need to provide your Veeva Vault vaultDNS, username, and password for this example to work.


Suggested change

You would need to provide your Veeva Vault vaultDNS, username, and password for this example to work.

You would need to provide your Veeva Vault credentials for this example to work.

examples/source_examples/veeva_vault_objects/configuration.json

varundhall · 2024-12-04T08:14:08Z

examples/source_examples/veeva_vault_objects/connector.py

@@ -0,0 +1,171 @@
+# This is a simple example for how to work with the fivetran_connector_sdk module.
+# This code is currently configured to Retrieve Details from All Object Types in Veeva Vault and then utilize VQL to retrieve all Object records, creating 1 table per object


Suggested change

# This code is currently configured to Retrieve Details from All Object Types in Veeva Vault and then utilize VQL to retrieve all Object records, creating 1 table per object

# This code is currently configured to Retrieve Details from All Object Types in Veeva Vault and then utilize VQL to retrieve all Object records, creating one table per object

varundhall · 2024-12-04T08:14:25Z

examples/source_examples/veeva_vault_objects/connector.py

@@ -0,0 +1,171 @@
+# This is a simple example for how to work with the fivetran_connector_sdk module.
+# This code is currently configured to Retrieve Details from All Object Types in Veeva Vault and then utilize VQL to retrieve all Object records, creating 1 table per object
+# You will need to provide your own Veeva Vault credentials for this to work --> vaultDNS, username, and password variables in configuration.json 


Suggested change

# You will need to provide your own Veeva Vault credentials for this to work --> vaultDNS, username, and password variables in configuration.json

# You will need to provide your own Veeva Vault credentials for this to work --> subdomain, username, and password variables in configuration.json

varundhall · 2024-12-04T08:14:51Z

examples/source_examples/veeva_vault_objects/connector.py

+# You will need to provide your own Veeva Vault credentials for this to work --> vaultDNS, username, and password variables in configuration.json 
+# Retrieve Details from All Object Types endpoint: https://developer.veevavault.com/api/24.2/#retrieve-details-from-all-object-types
+# VQL endpoint: https://developer.veevavault.com/api/24.2/#vault-query-language-vql
+# Can also add code to extract from other endpoints as needed


Suggested change

# Can also add code to extract from other endpoints as needed

# You can also add code to extract from other endpoints as needed.

examples/source_examples/veeva_vault_objects/connector.py

varundhall · 2024-12-04T08:17:02Z

examples/source_examples/veeva_vault_objects/connector.py

+            log.severe(f"Failed to create session for user with username: {username}")
+            session_id = None
+    else:
+        log.severe(f"Failed to get 200 response from Auth URL: {auth_url}, received response status code of {response.status_code}")


polish this log statement, and also throw the response.message, so that error is visible

Would this work? "Authentication failed: {auth_url} returned {response.status_code}. Expected 200."

varundhall · 2024-12-04T08:19:09Z

examples/source_examples/veeva_vault_objects/connector.py

+# The state dictionary is empty for the first sync or for any full re-sync
+# This function is designed to loop through and retrieve vault Object data using VQL endpoint: https://developer.veevavault.com/api/24.2/#submitting-a-query
+def update(configuration: dict, state: dict):
+    base_url = f"https://{configuration.get('vaultDNS')}/api/v24.2/"


define this as a constant and then use that for all occurrences
you can keep some regex and then replace that while using in your code with config value.

Defined as a constant at the start of the code under #Constant

examples/source_examples/veeva_vault_objects/connector.py

varundhall · 2024-12-11T17:45:06Z

@orizwanft please re-request the review in future, so we can get notified to review the PR again 😅

….py" This reverts commit f4b61cb.

varundhall

Almost there 🙌🏻

varundhall · 2024-12-19T13:55:27Z

examples/source_examples/veeva_vault_objects/connector.py

+def startVeevaSession(configuration: dict):
+    username = configuration.get('username')
+    password = configuration.get('password')
+    auth_url = f"https://{configuration.get('subdomain')}/api/v24.2/auth"


we are calling the field as sub-domain but then taking the entire value in credentials as the URL

it should be
auth_url = f"https://{configuration.get('subdomain')}.veevavault.com/api/v24.2/auth"

varundhall · 2024-12-19T13:55:53Z

examples/source_examples/veeva_vault_objects/connector.py

+# - session_id: a Veeva Vault session ID generated from the startVeevaSession function
+
+def endVeevaSession(configuration: dict, session_id):
+    deactivate_session_url = f"https://{configuration.get('subdomain')}/api/v24.2/session"


varundhall · 2024-12-19T13:56:02Z

examples/source_examples/veeva_vault_objects/connector.py

+# - session_id: a Veeva Vault session ID generated from the startVeevaSession function
+
+def getVaultObjects(configuration: dict, session_id):
+    base_url = f"https://{configuration.get('subdomain')}/api/v24.2/"


varundhall · 2024-12-19T13:56:27Z

examples/source_examples/veeva_vault_objects/connector.py

+def initialize_sync(configuration: dict, state: dict):
+
+    sub_domain = configuration.get('subdomain')
+    base_url = f"https://{sub_domain}/api/v24.2/"


Adding Veeva Vault Objects example

13879ef

varundhall requested review from varundhall and fivetran-satvikpatil December 3, 2024 07:54

varundhall assigned fivetran-kirkvanarkel Dec 4, 2024

varundhall requested changes Dec 4, 2024

View reviewed changes

varundhall self-requested a review December 11, 2024 17:45

orizwanft and others added 3 commits December 12, 2024 11:51

Applying changes based on review

150585d

Update examples/source_examples/veeva_vault_objects/connector.py

f4b61cb

Revert "Update examples/source_examples/veeva_vault_objects/connector…

1e05115

….py" This reverts commit f4b61cb.

varundhall reviewed Dec 19, 2024

View reviewed changes

Updating url code based on feedback

04dcf46

orizwanft requested a review from varundhall January 7, 2025 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Veeva Vault Objects example #56

Adding Veeva Vault Objects example #56

fivetran-kirkvanarkel commented Nov 25, 2024

height bot commented Nov 25, 2024

varundhall Dec 4, 2024

varundhall Dec 4, 2024

varundhall Dec 4, 2024

varundhall Dec 4, 2024

varundhall Dec 4, 2024

orizwanft Dec 5, 2024

varundhall Dec 4, 2024

orizwanft Dec 5, 2024

varundhall commented Dec 11, 2024

varundhall left a comment

varundhall Dec 19, 2024

orizwanft Jan 7, 2025

varundhall Dec 19, 2024

orizwanft Jan 7, 2025

varundhall Dec 19, 2024

orizwanft Jan 7, 2025

varundhall Dec 19, 2024

orizwanft Jan 7, 2025

	You would need to provide your Veeva Vault vaultDNS, username, and password for this example to work.
	You would need to provide your Veeva Vault credentials for this example to work.

		@@ -0,0 +1,171 @@
		# This is a simple example for how to work with the fivetran_connector_sdk module.
		# This code is currently configured to Retrieve Details from All Object Types in Veeva Vault and then utilize VQL to retrieve all Object records, creating 1 table per object

	# You will need to provide your own Veeva Vault credentials for this to work --> vaultDNS, username, and password variables in configuration.json
	# You will need to provide your own Veeva Vault credentials for this to work --> subdomain, username, and password variables in configuration.json

	# Can also add code to extract from other endpoints as needed
	# You can also add code to extract from other endpoints as needed.

Adding Veeva Vault Objects example #56

Are you sure you want to change the base?

Adding Veeva Vault Objects example #56

Conversation

fivetran-kirkvanarkel commented Nov 25, 2024

height bot commented Nov 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

varundhall commented Dec 11, 2024

varundhall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment