Salesforce Workbench

Introduction

Workbench est une suite d’outils Web puissante conçue pour interagir avec Salesforce.com organisations via le Force.com API.

Cet article décrit divers sujets importants de Salesforce Workbench:

  1. Manipulation de données à l’aide de workbench.
  2. Utilisation de l’API REST et des méthodes asynchrones dans workbench.
  3. Migration via workbench.
  4. Différence entre la console de développement et l’atelier.
  5. Scénarios décrivant les fonctionnalités de workbench.

Connexion à Salesforce Workbench

  • Connectez-vous à Workbench en utilisant l’URL suivante.

URL: https://workbench.developerforce.com/login.php

  • Sélectionnez l’Environnement, la version de l’API et entrez les informations d’identification Salesforce.
  • Salesforce Workbench s’affiche après une connexion réussie.
  1. Manipulation de données à l’aide de workbench

Accédez à l’onglet « Données  » pour effectuer diverses opérations de manipulation de données.

1.1 Pour effectuer des opérations d’insertion, de mise à jour et d’Upsert,

  • Sélectionnez un objet dans le menu déroulant  » Type d’objet « .
  • Sélectionnez l’option « Enregistrement unique » ou « À partir du fichier » et cliquez sur Suivant.
  • Téléchargez tout fichier CSV ou ZIP valide dans l’option « À partir du fichier ».
  • Cliquez sur le bouton « Confirmer » pour confirmer le nombre d’enregistrements d’insertion /Mise à jour / Mise à jour.
  • Une fois l’opération de manipulation des données réussie, l’écran s’affiche,
  1. Identifiant Salesforce des enregistrements
  2. Résultat
  3. Statut

1.2 Pour effectuer des opérations de Suppression, de Suppression et de Purge,

  • Sélectionnez l’option « Enregistrement unique » ou « À partir du fichier » et cliquez sur Suivant.
  • Saisissez l’ID d’enregistrement (ID Salesforce) à Supprimer, Annuler ou Purger.
  • Cliquez sur le bouton « Confirmer » pour confirmer le nombre d’enregistrements de Suppression/Restauration/Purge.
  • Workbench affiche le ‘Salesforce ID’ et l’état du résultat après une manipulation réussie des données.
  1. Utilisation de l’API REST et des méthodes asynchrones dans workbench

2.1 REST Explorer

REST Explorer dans workbench aide l’utilisateur à explorer et à découvrir l’API REST, lui permettant ainsi de récupérer, créer, mettre à jour ou supprimer les données dans l’organisation Salesforce.

  • Accédez à l’onglet ‘Utilitaires’ et sélectionnez ‘REST Explorer’
  • Par défaut, la méthode HTTP est définie sur ‘GET’.
  • Cliquer sur le bouton ‘En-têtes’ affiche les ‘En-têtes de requête’
  • La réponse est définie au format ‘JSON’ par défaut. Il peut également être changé en ‘XML’

2.1.1 Méthodes HTTP dans l’API REST

Méthode 1: POST

  • Pour créer des enregistrements à l’aide de l’API REST, la méthode ‘POST’ est utilisée.
  • Assurez-vous de définir la connexion comme ‘/sobjects/URI’.
  • Définit le ‘Corps de la requête’ avec les champs et ses valeurs.
  • Cliquez sur le bouton « Exécuter » pour recevoir le message de réponse confirmant l’insertion réussie.

Méthode 2 : GET

  • Pour lire un enregistrement de l’organisation Salesforce, la méthode ‘GET’ est utilisée.
  • Définit la requête SOQL qui renvoie tous les enregistrements présents dans l’organisation Salesforce.

Requête: /services/data/v41.0/requête/?q = Sélectionnez + Id, Nom + de + Compte + LIMITE+5

  • Cliquez sur le bouton « Exécuter » pour recevoir le message de réussite ainsi que la « Réponse brute ».

Méthode 3 : PATCH

  • Pour éditer /mettre à jour des enregistrements via l’API REST, la méthode ‘PATCH’ est utilisée.
  • Définissez le ‘Corps de la requête’ avec des champs et des valeurs pour la mise à jour des enregistrements.
  • Cliquez sur le bouton « Exécuter » pour recevoir le message de réponse.

Méthode 4 : DELETE

  • Pour supprimer des enregistrements via l’API REST, la méthode ‘DELETE’ est utilisée.
  • Définissez l’URI en fonction de l’objet à supprimer et entrez son ID associé.
  • Cliquez sur le bouton « Exécuter » pour recevoir le message de réponse confirmant la suppression réussie.

2.2 Méthodes asynchrones dans workbench

Le code Apex et l’état des travaux d’API peuvent être exécutés dans workbench via des méthodes asynchrones.

2.2.1 Apex Execute

  • En utilisant Apex Execute, l’utilisateur peut créer, mettre à jour et supprimer les enregistrements.
  • Accédez à Utilitaires à Apex Execute.
  • Entrez le code Apex dans l’espace prévu, qui fonctionne comme une fenêtre anonyme.
  • Sélectionnez la « Catégorie de journal » comme « Code Apex » et « Niveau de journal » comme « Débogage ».
  • Cliquez sur le bouton ‘Exécuter’ pour voir les résultats de l’exécution Apex dans la même fenêtre.

2.2.2 État de la tâche de l’API en bloc

  • L’état de la tâche de l’API en bloc est utilisé pour afficher l’état et les résultats de la charge de données asynchrones
  • Accédez à Utilitaires à État de la tâche de l’API en bloc.
  • Entrez le ‘Job ID’ dans la zone de texte fournie.
  • Cliquez sur le bouton  » Obtenir l’état  » pour récupérer l’état des tâches de données en masse et les afficher dans la même fenêtre.
  1. Migration via Workbench

La migration dans workbench aide l’utilisateur à « Récupérer » et à « Déployer » les composants de métadonnées qui aident à structurer l’organisation comme des applications personnalisées, des objets et d’autres composants.

3.1 Récupérer

Pour récupérer des composants de métadonnées de l’organisation,

  • Préparez un fichier XML avec des normes et des types définis avec la version de l’API pour la requête.

  • Accédez à Migration à Récupérer
  • Dans la section Manifeste non emballé, sélectionnez le fichier XML du package créé pour obtenir les attributs du composant.
  • En option, entrez les « Noms de paquet » et cochez la case « Paquet unique » et cliquez sur Suivant.
  • Une fois le téléchargement du fichier XML réussi, Cliquez sur « Récupérer »
  • Cliquez sur « Télécharger le fichier ZIP » pour afficher les composants de métadonnées déployés de l’organisation.

3.2 Déployez

Pour déployer les composants de métadonnées dans l’organisation,

  • Créez un dossier avec « Package XML » à la racine et un dossier de sous-niveau avec le nom du composant. ZIP le dossier.
  • Accédez à Migration à Deploy
  • Dans la section Choisir, sélectionnez le dossier contenant le package XML pour déployer les composants de métadonnées.
  • En option, cochez les cases ci-dessous et cliquez sur Suivant.
  • Une fois le téléchargement réussi, cliquez sur « Déployer »
  • Confirmez le déploiement des résultats avec succès, sinon vérifiez les fichiers pour toute erreur.

4.Différence entre la Console de développement et les requêtes Workbench

Salesforce Object Query Language (SOQL) et Salesforce Object Search Language (SOSL) peuvent être exécutées à la fois dans la console de développement et dans workbench.

La principale différence entre l’utilisation de developer console et workbench réside dans l’interface utilisateur. Workbench fournit aux utilisateurs une interface utilisateur améliorée pour interroger les enregistrements.

  • Les requêtes SOQL peuvent être créées simplement en sélectionnant les listes déroulantes ‘Objet’ et ‘champs’.

  • Les requêtes peuvent être filtrées en utilisant les listes déroulantes  » Trier les résultats par  » et  » Filtrer les résultats par « .

  • Dans workbench, les résultats de la requête peuvent être visualisés comme suit,
  1. Liste
  2. Matrice
  3. CSV en vrac
  4. XML en vrac

  • Les enregistrements supprimés et archivés peuvent être exclus ou inclus.

  • Les résultats de la requête SOQL peuvent être exportés via l’option ‘Bulk CSV’ pour analyser les données en vue d’une utilisation future.
  • Les requêtes SOSL peuvent être créées en spécifiant les options ‘Rechercher’ et ‘Renvoyer un objet’.
  • Les résultats des requêtes SOSL sont affichés dans le format de liste spécifiant les ID . Survolez les ID pour effectuer des actions telles que,
  1. Mise à jour
  2. Suppression
  3. Restauration
  4. Purge
  5. Vue dans Salesforce

5.Scénarios décrivant les fonctionnalités de Workbench

Scénario 1

Un utilisateur est invité à connaître le nombre de composants de métadonnées dans une organisation Salesforce.

Pour y parvenir, utilisez workbench,

  • Accédez à l’onglet Informations à Types de métadonnées & Composants.
  • Sélectionnez toutes les métadonnées dans la liste déroulante de.
  • Lors de la sélection, workbench décrit et affiche le « Nombre total de composants » présents dans les métadonnées particulières.

Scénario 2

Exporter des données pour les utilisateurs affectés à des jeux d’autorisations.

Pour réaliser ce scénario en utilisant Workbench,

  • Accédez aux requêtes à SOQL Query
  • Sélectionnez ‘PermissionSetAssignment’ dans la liste déroulante objet et les champs nécessaires.
  • Sélectionnez ‘Bulk CSV’ dans Afficher comme option et cliquez sur Requête.
  • Cela amène l’utilisateur à un écran suivant affichant l’ID et le statut de la tâche.
  • Cliquez sur le bouton télécharger pour exporter la requête SOQL dans un fichier CSV.

Scénario 3

Un utilisateur n’a pas pu se connecter et n’a pas reçu l’e-mail de réinitialisation du mot de passe lorsqu’il a essayé de réinitialiser le mot de passe.

Pour y parvenir, utilisez workbench,

  • Accédez à Utilitaires à Gestion des mots de passe
  • Cliquez sur l’option « Réinitialiser » et entrez l’ID utilisateur.
  • Cliquez sur le bouton « Changer le mot de passe » pour réinitialiser le mot de passe.
  • Cliquez sur l’option ‘Set’ et entrez l’ID utilisateur.
  • Entrez les valeurs des champs ‘Mot de passe’ et ‘Confirmer le mot de passe’.
  • Cliquez sur  » Changer le mot de passe  » pour modifier le mot de passe de l’utilisateur.

Avantages de workbench

  • Il nous donne accès aux données et aux informations structurelles de tous les objets du système.
  • Pour les utilisateurs gelés ou verrouillés, les requêtes SOQL dans Workbench aident à afficher les données.
  • Ceux sur Mac peuvent l’utiliser sans logiciel supplémentaire.

Inconvénients de workbench

  • Workbench ne permet pas d’enregistrer et de réutiliser les mappages de charge de données, comme nous pouvons le faire avec le chargeur de données.
  • Workbench n’a pas la possibilité d’effectuer des actions en ligne de commande ou planifiées, comme avec le chargeur de données.