Accéder au contenu principal Passer au contenu complémentaire

Propriétés du tODataInput Standard

Ces propriétés sont utilisées pour configurer le tODataInput s'exécutant dans le framework de Jobs Standard.

Le composant tODataInput Standard appartient à la famille Internet.

Le composant de ce framework est disponible dans tous les produits Talend nécessitant une souscription.

  • Ce composant est disponible uniquement si vous avez installé la mise à jour mensuelle 8.0 R2024-01 du Studio Talend ou une mise à jour plus récente fournie par Talend. Pour plus d'informations, contactez votre administrateur ou administratrice.
  • Ce composant supporte uniquement la version 4.x d'OData.

Basic settings

Property type Peut-être Built-In ou Repository.
  • Built-In : propriétés utilisées ponctuellement.
  • Repository : sélectionnez le référentiel dans lequel sont stockées les propriétés. Les champs suivants sont automatiquement renseignés à l'aide des données récupérées.
Root URL Saisissez l'URL identifiant la racine du service OData auquel accéder, par exemple, https://services.odata.org/V4/xxx. Pour plus d'informations, consultez Service Root URL (en anglais).
Authentication type Sélectionnez l'une des méthodes d'authentification suivantes selon les prérequis de sécurité du serveur :
  • No authentication (Pas d'authentification) : aucune authentification n'est attendue pour accéder au serveur.
  • Basic : un identifiant et un mot de passe sont attendus. Pour plus d'informations, consultez RFC 2617.
  • Digest : un identifiant et un mot de passe sont attendus. Pour plus d'informations, consultez RFC 2617.
  • Bearer token : un jeton d'accès brut est attendu. Il sera passé dans l'en-tête de la requête en tant que Authorization: Bearer <votre jeton>.
  • NTLM : un identifiant (pouvant contenir un nom de domaine) et un mot de passe sont attendus. Pour plus d'informations, consultez NT LAN Manager (NTLM) Authentication Protocol (en anglais).
  • API key : utilise une manière flexible de passer un jeton de clé d'API au serveur, avec la possibilité de sélectionner où le passer, avec quel nom et un préfixe :
    • Destination : sélectionnez où sera configuré le jeton : dans un en-tête avec le nom donné ou dans un paramètre de requête avec le nom donné (non recommandé car le jeton peut être visible dans les logs).
    • Name (Nom) : saisissez le nom de l'en-tête ou le paramètre de requête.
    • Prefix (Préfixe) (facultatif) : saisissez le préfixe à ajouter devant le jeton (uniquement si la Destination est Request header (En-tête de la requête)).
    • Token (Jeton) : saisissez le jeton d'authentification.
  • OAuth 2.0 gère automatiquement la récupération et le renouvellement du jeton d'accès par rapport au serveur OAuth puis le passe à l'endpoint cible en tant que jeton Bearer :
    • Flow (Flux) : le flux OAuth que vous souhaitez exécuter. Atuellement, seul le flux Client Credentials est supporté.
    • Authentication mode : pour toutes les méthodes d'authentification supportées, les paramètres de flux et de périmètre (scope) sont configurés dans le corps, au format 'application/x-www-form-urlencoded' avec les clés 'grant_type=xxx&scope=xxxx'.
    • Token endpoint : saisissez le jeton d'authentification au format oauth2/mydomain.com/token.
    • Client ID (ID Client) et Client secret (Secret du client) : saisissez l'ID client et le secret du client.
    • Scopes : saisissez le périmètre. S'il n'est pas configuré, la clé du périmètre n'est pas ajoutée dans le formulaire du corps.
Note InformationsConseil : Pour saisir un mot de passe, un jeton ou une clé secrète du client, cliquez sur le bouton [...] près du champ correspondant pour ouvrir la boîte de dialogue Enter a new password. Saisissez le mot de passe, le jeton ou la clé secrète dans le champ de texte et cliquez sur OK. Vous pouvez saisir une chaîne de caractères JSON en mode pure password ou une expression Java en mode Java. Vous pouvez passer d'un mode à l'autre en cliquant sur switch to Java mode ou switch to pure password mode au-dessus du champ de texte.
Entity set Saisissez ou sélectionnez l'ensemble d'entités à récupérer depuis le service. Pour plus d'informations, consultez Addressing Entities (en anglais).
Note InformationsConseil : Pour visualiser tous les ensembles d'entités, cliquez sur le bouton [...] près du champ correspondant pour ouvrir la boîte de dialogue Retrieve values et cliquez sur Run in background. Une nouvelle boîte de dialogue s'ouvre, affichant tous les ensembles d'entités récupérés que vous pouvez sélectionner. Vous pouvez également fournir une valeur personnalisée (Custom value) en cochant la case Use custom value.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Specify entity key Cochez cette case pour saisir la clé utilisée pour identifier de manière unique un ensemble spécifique d'entités. Pour plus d'informations, consultez Addressing Entities (en anglais).

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $filter Cochez cette case pour saisir une requête filtrant la collection de ressources gérées par l'URL de la requête. Pour plus d'informations, consultez System Query Option $filter (en anglais).

Si les deux options Use $filter et Use $search sont appliquées à la même requête, les résultats incluent uniquement les entités correpondant aux deux critères.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $search Cochez cette case pour saisir une requête qui sera appliquée à l'URL de la requête et retournera toutes les entités correspondantes dans la collection. Pour plus d'informations, consultez System Query Option $search (en anglais).

Si les deux options Use $filter et Use $search sont appliquées à la même requête, les résultats incluent uniquement les entités correpondant aux deux critères.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $select Cochez cette case pour saisir une requête qui sera appliquée à l'URL de requête et retournera un ensemble spécifique de propriétés pour chaque entité ou type complexe. Pour plus d'informations, consultez System Query Option $select (en anglais).

Si les deux options Use $select et Use $expand sont appliquées à la même requête, les résultats comprennent uniquement les entités correspondant au critère de filtre $select. Vous devez inclure le critère $expand dans la requête $select, afin de retourner toutes les propriétés attendues.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $expand Cochez cette case pour saisir une requête qui sera appliquée à l'URL de requête et retournera les ressources développées associées à inclure dans les ressources récupérées. Pour plus d'informations, consultez System Query Option $expand (en anglais).

Si les deux options Use $select et Use $expand sont appliquées à la même requête, les résultats comprennent uniquement les entités correspondant au critère de filtre $select. Vous devez inclure le critère $expand dans la requête $select, afin de retourner toutes les propriétés attendues.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Return type Sélectionnez l'une des options suivantes en fonction de la manière dont vous souhaitez parser les données retournées par le serveur.
  • Record : parse le corps de la réponse et génère des enregistrements (une entité par ligne).

  • Raw : retourne le corps complet inchangé de la réponse dans une colonne body.
Schema et Edit Schema Un schéma est une description de lignes, il définit le nombre de champ qui sont traités et passés au composant suivant. Le schéma est soit local (Built-in), soit distant dans le Repository.
  • Built-in : le schéma est créé et stocké localement pour ce composant seulement. Pour plus d'informations concernant les schémas des composants dans l'onglet Basic settings (Paramètres simples), consultez Onglet Basic settings.

  • Repository : le schéma existe déjà et est stocké dans le Repository. Ainsi, il peut être réutilisé dans des Jobs et projets. Pour plus d'informations concernant les schémas des composants dans l'onglet Basic settings (Paramètres simples), consultez Onglet Basic settings.

Créez le schéma en cliquant sur le bouton Edit Schema. Si le schéma est en mode Repository, trois options sont disponibles :

  • View schema : sélectionnez cette option afin de voir uniquement le schéma.

  • Change to built-in property : sélectionnez cette option pour passer le schéma en mode Built-In et effectuer des modifications locales.

  • Update repository connection : sélectionnez cette option afin de modifier le schéma stocké dans le référentiel et décider de propager ou non les modifications à tous les Jobs.

    Si vous souhaitez propager les modifications uniquement au Job courant, cliquez sur No et sélectionnez à nouveau la métadonnée du schéma dans la fenêtre Repository Content.

Guess schema Cliquez sur ce bouton pour récupérer le schéma en fonction de vos paramètres. Ce bouton fonctionne lorsque l'option Status, headers and body est sélectionnée dans la liste déroulante Returned content ou que l'option Output key/value pairs est sélectionnée et que les paires clé/valeur sont configurées dans la table, sous l'option Output key/value pairs.

Lorsque vous récupérez des données depuis OData, vous pouvez spécifier le format et le contenu des données récupérées à l'aide du schéma, du bouton Guess schema, de l'option Entity set, de l'option Specify entity key, de l'option $filter/search/select/expand et de l'option Return type.

Paramètres avancés

Statistiques du tStatCatcher Cochez cette case pour collecter les données de log au niveau du Job ainsi qu'au niveau de chaque composant.
Connection timeout (ms) Configurez le délai avant expiration (en millisecondes) de l'établissement de la connexion au serveur par le connecteur. Une erreur survient si une tentative d'établissement de la connexion échoue.
Receive timeout (ms) Configurez le délai avant expiration (en millisecondes) de la réception des données de réponse. Une erreur survient si aucune donnée n'est reçue lorsque le délai avant expiration est dépassé.
Utiliser un proxy Sélectionnez cette option pour utiliser un proxy HTTP ou SOCKS.
  • Proxy type (Type de proxy) : sélectionnez le type de proxy à utiliser, HTTP ou SOCKS. Le proxy HTTP supporte l'authentification basique.
  • Proxy host (Hôte du proxy) et Proxy port (Port du proxy) : saisissez l'adresse et le port du proxy.
  • Proxy login (identifiant du proxy) et Proxy password (Mot de passe du proxy) : saisissez les identifiants nécessaires à l'authentification au proxy. Ces deux champs sont disponibles uniquement lorsque l'option HTTP est sélectionnée dans la liste déroulante Proxy type.
Accept header et Headers Utilisez ces options pour définir l'ensemble des formats acceptés pour les en-têtes de requêtes en tant que paires nom-valeur. Pour plus d'informations, consultez Header Accept (en anglais).

Si vous avez sélectionné Record (Enregistrement) comme type de retour dans l'onglet Basic settings (Paramètres simples), il est possible que vous deviez remplacer odata.metadata=minimal par odata.metadata=full dans le champ Accept header (En-tête Accept), afin de parser correctement tous les types primitifs non String.

Use custom URL parameters Cochez cette case pour spécifier les paramètres qui seront configurés dans l'URL de la requête après le caractère ?, sous forme de paires nom-valeur.
Use $skip Cochez cette case afin de spécifier, dans la collection sur laquelle la requête est effectuée, le nombre d'éléments à ignorer et ne pas inclure dans le résultat. Pour plus d'informations, consultez System Query Option $top and $skip (en anglais).

Si les deux options Use $skip et Use $top sont appliquées à la même requête, les résultats incluent uniquement les entités correpondant aux deux critères.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $top Cochez cette case afin de spécifier, dans la collection sur laquelle la requête est effectuée, le nombre de premiers éléments à inclure dans le résultat. Pour plus d'informations, consultez System Query Option $top and $skip (en anglais).

Si les deux options Use $skip et Use $top sont appliquées à la même requête, les résultats incluent uniquement les entités correpondant aux deux critères.

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Use $orderBy Cochez cette case pour saisir une requête qui sera appliquée à l'URL de requête et retournera les ressources associées dans un ordre particulier. Pour plus d'informations, consultez System Query Option $orderby (en anglais).

Cette option affecte le schéma du flux de sortie de ce composant. Il est recommandé de mettre à jour le schéma en cliquant sur le bouton Guess schema après avoir configuré les paires clé/valeur dans la table sous cette option.

Variables globales

Variables globales

ERROR_MESSAGE : message d'erreur généré par le composant lorsqu'une erreur survient. Cette variable est une variable After et retourne une chaîne de caractères. Cette variable fonctionne uniquement si la case Die on error est décochée, lorsque le composant contient cette case.

NB_LINE : nombre de lignes lues par un composant d'entrée ou passées à un composant de sortie. Cette variable est une variable After et retourne un entier.

Utilisation

Règle d'utilisation Ce composant peut être utilisé en composant intermédiaire dans un flux de données ou en composant de fin dans un Job design.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.