Passer au contenu principal
La flexibilité et la personnalisation sont des aspects clés que nous cherchons à fournir dans Hyperline. Pour y parvenir, nous vous permettons de définir des propriétés personnalisées afin de représenter et stocker toutes les données supplémentaires dont vous avez besoin. Les propriétés personnalisées peuvent être définies et associées aux entités client, produit, abonnement et facture. Les propriétés personnalisées d’abonnement peuvent également être utilisées dans les modèles d’abonnement. De plus, les valeurs sont structurées avec une gamme de types incluant texte, nombre, booléen, date et une liste de sélection de valeurs prédéfinies.

​
Cas d’usage

Les propriétés personnalisées offrent un large éventail de possibilités. Par exemple, elles peuvent être utilisées pour représenter des champs supplémentaires pour vos clients, intégrer des détails de facturation supplémentaires dans vos abonnements ou modèles d’abonnement, aider à la gestion des droits d’accès et au feature flagging en représentant des fonctionnalités activables sur des produits ou abonnements spécifiques. Ce ne sont que des exemples, et elles peuvent être personnalisées pour répondre à tout besoin spécifique selon votre cas d’usage.

​
Créer une propriété personnalisée

1

Accédez à Settings puis Custom properties

2

Cliquez sur New custom property

3

Remplissez le formulaire

Vous serez invité à saisir un nom, un slug (un identifiant unique principalement utilisé pour l’intégration technique via l’API), le type de propriété et les entités sur lesquelles la propriété personnalisée sera disponible.En outre, vous pouvez décider d’activer cette propriété personnalisée uniquement à des fins techniques, ce qui signifie qu’elle ne sera pas modifiable dans l’interface Hyperline mais sera uniquement disponible via l’API. Lorsque cette option est désactivée, le champ est à la fois modifiable dans l’interface et l’API.

​
Gérer les valeurs des propriétés personnalisées

Une fois créée, la propriété personnalisée peut être trouvée sur l’entité associée dans l’interface. Sur le client, les propriétés personnalisées apparaissent en bas du panneau d’informations sur la page de détails du client.
Pour les produits, elles apparaîtront dans une zone dédiée sur le produit dans la section « Advanced settings ».
Pour les abonnements, vous pouvez définir la valeur lors de la deuxième étape du flux d’attribution d’abonnement. Les mêmes propriétés personnalisées d’abonnement sont disponibles lors de la configuration d’un modèle d’abonnement.
Pour les factures, vous pouvez définir les valeurs depuis les détails de la facture lors de la création ou de la modification d’une facture. Lorsqu’une facture est générée à partir d’un abonnement, Hyperline copie automatiquement les valeurs des propriétés personnalisées de l’abonnement vers la facture lorsque la même propriété personnalisée est disponible sur les deux entités. Vous pouvez toujours modifier la valeur de la facture par la suite lorsque la facture peut être mise à jour.
La copie automatique ne s’applique qu’aux propriétés personnalisées disponibles à la fois sur les entités abonnement et facture.

​
Filtrer par propriétés personnalisées

Vous pouvez filtrer les clients, abonnements et factures par leurs valeurs de propriétés personnalisées dans les vues de liste correspondantes. Lorsque vous créez des propriétés personnalisées pour les clients, abonnements ou factures, des contrôles de filtre apparaissent automatiquement dans le menu déroulant des filtres sur les pages Customers, Subscriptions et Invoices. Le type de filtre dépend du type de propriété personnalisée :
  • Propriétés booléennes : Affichées comme un menu déroulant avec les options On et Off
  • Propriétés de sélection : Affichées comme un menu déroulant avec les valeurs prédéfinies que vous avez configurées
Pour filtrer par propriétés personnalisées :
  1. Accédez à la page Customers, Subscriptions ou Invoices
  2. Cliquez sur le menu déroulant des filtres
  3. Sélectionnez le filtre de propriété personnalisée que vous souhaitez appliquer
  4. Choisissez la valeur par laquelle filtrer
La liste se mettra automatiquement à jour pour n’afficher que les enregistrements correspondant aux critères que vous avez sélectionnés.
Seules les propriétés personnalisées de type booléen et sélection sont disponibles comme filtres. Les propriétés de type texte, nombre et date ne peuvent pas être utilisées pour le filtrage dans l’interface.
Les propriétés personnalisées marquées comme « API only » n’apparaîtront pas dans le panneau de filtres.

​
Afficher les propriétés personnalisées sur les pages hébergées

Pour l’instant, cela n’est disponible que pour la page portail client. Vous pouvez choisir les propriétés personnalisées à afficher sur le portail client en naviguant vers la section Settings > Hosted pages.

​
Utiliser l’API

Vous pouvez créer, récupérer et gérer des propriétés personnalisées via l’API. De plus, vous pouvez récupérer les valeurs en utilisant le champ custom_properties lors de la récupération d’un client, produit, abonnement ou facture. Vous pouvez également définir les propriétés personnalisées de facture lorsque vous créez ou mettez à jour une facture via l’API. Les configurations de modèles d’abonnement utilisent le même champ custom_properties que les abonnements lorsque vous créez ou mettez à jour une configuration via l’API.

​
Comment cela diffère du champ properties

Le champ properties a été introduit lors de l’étape initiale, mais il manque de structure (par ex. il n’est ni nommé ni typé) et n’est pas gérable via l’interface pour les utilisateurs non techniques. Bien que ce champ puisse toujours être utilisé pour stocker des détails techniques non structurés sur les entités prises en charge, nous recommandons d’utiliser les propriétés personnalisées lorsque cela est possible pour garantir la sécurité et une meilleure facilité de gestion.