Ajouter des fonctions personnalisées

Étapes : fonctions personnalisées définies dans d'autres documents

Ajoutez des fonctions personnalisées à votre barre d'outils Fonctions à partir de n'importe quel document sur lequel vous disposez d'un ensemble d'autorisations minimum « Afficher, copier et exporter ». Vous pouvez ajouter des fonctions personnalisées lorsque vous vous trouvez dans un Atelier des pièces auquel vous avez accès en écriture ou lorsque vous visualisez une version contenant l'Atelier des fonctions qui définit les fonctions.

Dans un Atelier des pièces, cliquez sur dans la barre d'outils Fonctions.
Dans la boîte de dialogue, recherchez le document dans lequel la fonction personnalisée souhaitée est définie :
1. Exemples FeatureScript - Ce filtre répertorie tous les documents fournis par Onshape contenant des exemples FeatureScript que vous pouvez tester.
2. Filtres standard Onshape - Utilisez ces filtres comme vous le faites sur la page de documents pour localiser un document spécifique.
3. Zone de recherche - Saisissez le nom d'un document ou collez l'URL d'un document contenant FeatureScript (généralement acquis via une action Partager).
Les fonctions personnalisées sont liées à partir de versions spécifiques d'autres documents ; la dernière version est sélectionnée par défaut. S'il n'y a pas de version, vous pouvez demander au propriétaire du document (ou à une personne disposant d'un accès en écriture) d'en créer une.
Cliquer sur un nom de document affiche les fonctions personnalisées qui y sont définies.
Sélectionnez l'icône de niveau supérieur pour y insérer toutes les fonctions personnalisées (chacune représentée par sa propre icône sur votre barre d'outils), ou sélectionnez une fonction.
L'icône de fonction personnalisée apparaît dans la barre d'outils Fonctions.
Pour supprimer la fonction personnalisée avant de fermer la boîte de dialogue, sélectionnez à nouveau la fonction personnalisée dans la boîte de dialogue. (Cette option permet de basculer la fonction personnalisée dans et hors de la barre d'outils.)
S'il existe plusieurs versions du document, la dernière version est affichée par défaut. Cliquez sur pour accéder au tableau des versions et sélectionner une autre version.
Cliquez sur le X dans le coin supérieur droit de la boîte de dialogue pour la fermer.

La fonction personnalisée est désormais disponible dans la barre d'outils Fonctions.

Utiliser une fonction personnalisée

L'utilisation d'une fonction personnalisée crée une fonction dans la Liste des fonctions de l'Atelier des pièces, comme toute autre fonction Onshape. Les entités personnalisées liées à un autre document sont indiquées dans la Liste des fonctions par cette icône Icône Fonctions personnalisées liées .

Les fonctions personnalisées se comportent comme les autres fonctions Onshape ; elles peuvent être modifiées, retirées, masquées et supprimées.

Mettre à jour une fonction personnalisée

Lorsqu'une version plus récente du document à partir duquel vous avez inséré la fonction personnalisée est créée, l'icône du lien dans la liste des fonctions est surlignée en bleu et une icône identique apparaît dans l'onglet Atelier des pièces :

Il s'agit uniquement d'une notification, aucune action n'est requise.

Pour mettre à jour la version de la fonction personnalisée utilisée :

Cliquez sur l'icône de mise à jour (ou cliquez avec le bouton droit sur la fonction et sélectionnez Mettre à jour le document lié) pour accéder au Gestionnaire de références, dans lequel vous pouvez choisir les options de mise à jour.
Pour mettre à jour vers la dernière version, cliquez sur Tout mettre à jour.
Pour effectuer une mise à jour vers une version spécifique :
1. Cliquez sur Mise à jour sélective :
1. Sélectionnez le document (s'il y en a plusieurs) et cliquez sur pour ce document :
2. Sélectionner la version à mettre à jour.
3. Répétez l'opération pour tous les autres documents de la liste, si nécessaire.
4. Cliquez sur Mettre à jour la sélection.

Si une fonction de la Liste des fonctions d'un utilisateur correspond à un outil ajouté par l'administrateur, elle ne s'affichera pas comme obsolète (même si l'outil l'est), mais si elle ne provient pas de la même version que l'outil, elle apparaîtra comme Icône Désynchronisé hors synchronisation.

La commande Tout mettre à jour du Gestionnaire de références met à jour les fonctions non synchronisées vers la version de la barre d'outils, même si cette version est inférieure à la dernière version ou inférieure à la version d'où provient actuellement la fonction. Un utilisateur peut cliquer sur l'icône et utiliser la commande Mettre à jour pour mettre à jour l'outil :

Gestionnaire de références, mise à jour la plus récente.

Supprimer une fonction personnalisée

Pour retirer une fonction personnalisée de votre barre d'outils, cliquez avec le bouton droit sur l'icône dans la barre d'outils et sélectionnez Retirer.

La fonction personnalisée n'apparaît plus dans la barre d'outils lors de la modification des ateliers de pièces, sauf si cette fonctionnalité a été utilisée et existe dans la Liste des fonctions. Si la Liste des fonctions contient une fonction personnalisée et que votre barre d'outils n'a pas d'icône de fonction personnalisée correspondante (soit parce qu'elle a été supprimée ou que le document a été partagé avec vous et que votre barre d'outils n'a jamais contenu l'icône), l'icone des fonctions personnalisées liées dans cet atelier de pièces apparaît dans la barre d'outils et la fonction personnalisée est disponible dans la liste déroulante :

exemple de la façon de supprimer une fonction personnalisée

Cela permet aux utilisateurs ayant accès à cet atelier de pièces de continuer à utiliser cette fonction personnalisée.

Ouvrir le document d'une fonction personnalisée liée

Pour vous familiariser à nouveau avec une fonction personnalisée dans votre document et son fonctionnement, cliquez avec le bouton droit sur l'icône de fonction personnalisée dans la barre d'outils et sélectionnez Ouvrir un document lié. Le document contenant l'Atelier des fonctions de la fonction personnalisée s'ouvre dans un autre onglet.

Étapes : ajouter des fonctions personnalisées depuis le même espace de travail

Si vous avez écrit votre propre fonction personnalisée dans cet espace de travail, les fonctions personnalisées qui y sont définies sont automatiquement disponibles à partir de la liste déroulante Fonctions personnalisées dans la barre d'outils Fonctions :

Cliquez sur l'icône pour répertorier toutes les fonctions personnalisées définies dans l'espace de travail :
Sélectionnez la fonction personnalisée à utiliser.

Les fonctions personnalisées de l'espace de travail actif sont automatiquement mises à jour lorsque le FeatureScript qui définit la fonction est modifié et commité. Ceci est utile pour tester rapidement lors du développement de fonctions personnalisées.

Partager une fonction personnalisée

Pour mettre vos fonctions personnalisées à la disposition d'autres utilisateurs :

Créez une version du document contenant la fonction personnalisée FeatureScript.
Soit :
1. Partagez le document avec des personnes ou des équipes spécifiques, en spécifiant au moins les autorisations « Peut afficher, copier et exporter ».
2. Rendre le document public.

Utilisation d'une icône personnalisée pour une fonction personnalisée

Une icône de fonction personnalisée est spécifiée en téléchargeant l'icône sous la forme d'un onglet de blog SVG dans le document, puis en la référençant. Pour plus d'informations, consultez les instructions de Icônes personnalisées dans la documentation FeatureScript.

Ajout d'une image de description

Une image de description est une image de la sortie de l'entité. Elle est spécifiée en téléchargeant l'image sous forme d'onglet de blog SVG dans le document, puis en la référençant. Pour plus d'informations, reportez-vous aux instructions de la section Icônes personnalisées dans la documentation FeatureScript.

Publier une fonction personnalisée

Si votre document contient une fonction personnalisée que vous souhaitez publier et mettre à la disposition du public, vous pouvez le faire lorsque vous créez une nouvelle version du document ou directement depuis le menu contextuel de la version dans le panneau Versions et historique. Cela facilite également la recherche de documents contenant des fonctionnalités personnalisées publiques.

Étapes

Créez un document public contenant la fonction personnalisée dans un onglet Atelier des fonctions. Voir Ajouter une fonction personnalisée pour plus d'informations.
Dans le même document, cliquez sur l'icône Insérer un nouvel onglet () et créez un Atelier des pièces qui utilise la fonction personnalisée.
Dans le même document, cliquez sur l'icône Insérer un nouvel onglet () et cliquez sur Importer. Localisez et importez un fichier PDF. Il s'agit généralement d'un document d'instructions qui explique la fonction personnalisée.
Cliquez sur l'icône Versions et historique () pour ouvrir le panneau Versions et historique.
Cliquez sur l'icône Créer une version () pour ouvrir la boîte de dialogue Créer une version.
Indiquez un nom et une description.
Cliquez sur l'option Publier des fonctions et des tableaux personnalisés. S'il y a des erreurs avec le FeatureScript de votre document, elles apparaissent avec une icône en forme de x rouge () à gauche de leur explication dans la liste de contrôle. Une icône en forme de coche () indique que les exigences de publication sont respectées.

L'option Publier des fonctions et des tableaux personnalisés s'affiche uniquement si le document contient un onglet Atelier des fonctions.

Custom features must also have a description (this is different than the Description field in the above dialog). See Feature UI: Description in the FeatureScript documentation for more information.

Cliquez sur Créer et publier ou Créer une version, publier et modifier les propriétés pour créer la version et publier les fonctions et les tableaux personnalisés simultanément.

Si vous n'utilisez pas l'option Publier des fonctions et des tableaux personnalisés dans la boîte de dialogue Créer une version, vous pouvez publier après coup en cliquant avec le bouton droit sur la version (V1 dans l'exemple ci-dessous) et en sélectionnant Publier FeatureScript dans le menu contextuel :

Publier FeatureScript depuis le panneau Versions et historique

Recherche de fonctions personnalisées publiées

Pour rechercher des fonctions personnalisées publiées, procédez comme suit :

Sur la page Documents, sélectionnez le filtre Public dans le panneau de gauche.
Dans le champ de recherche en haut de l'écran, cliquez sur la flèche déroulante sur la droite.
Cliquez sur le menu déroulant Ajouter des critères et sélectionnez FeatureScript publié :
Sélectionnez True pour filtrer tous les documents dont le FeatureScript a été publié ou False pour exclure tous les documents dont le FeatureScript a été publié :
Cliquez sur Rechercher. Les résultats sont affichés ci-dessous.

Conseils

Onshape répertorie automatiquement les entités personnalisées par ordre alphabétique.
Si vous choisissez de mettre à jour vers une version qui n'est pas la plus récente, l'icône « obsolète » reste.
La mise à jour de la version référencée d'une fonction personnalisée ne modifie pas la version de la fonction personnalisée pointée par votre barre d'outils. Pour mettre à jour la version pointée par la barre d'outils, supprimez l'icône existante et ajoutez une nouvelle fonction personnalisée qui pointe vers la version la plus récente.
Après la mise à jour d'une fonction personnalisée, vous devrez peut-être modifier la fonction pour qu'elle se régénère sans erreurs (par exemple, avec l'ajout de champs nécessitant une entrée).
Une fois que vous avez utilisé une fonction personnalisée liée dans votre document, vous y avez accès même si le document source est supprimé ou non partagé.
L'ajout de fonctions personnalisées à votre barre d'outils est un paramètre de compte et non un paramètre de document. L'icône (et la fonction personnalisée associée) est disponible dans tous vos documents.
L'ajout d'une fonction personnalisée à votre barre d'outils (ou l'ouverture d'un document contenant une fonction personnalisée) active automatiquement les notifications FeatureScript, indiqués par dans la barre de navigation. Ces notifications fournissent des commentaires qui peuvent être utiles au développeur de la fonction personnalisée.

Important

FeatureScript a été conçu avec la sécurité à l'esprit. Pour vous protéger, FeatureScript s'exécute dans un bac à sable étroit et limite l'impact de la fonctionnalité sur l'atelier des pièces dans lequel elle est utilisée. Cela garantit que l'utilisation de fonctions personnalisées écrites même par des utilisateurs non fiables est relativement sûre.

Une fonction personnalisée ne peut pas :

Modifiez tout sauf l'atelier des pièces dans lequel elle est utilisée.
« Infecter » votre compte Onshape de quelque façon que ce soit.
Communiquer quoi que ce soit à son auteur ou à quelqu'un d'autre.
Affecter la régénération de l'atelier des pièces après sa suppression de la Liste des fonctions.
Modifiez d'autres fonctions dans la liste des Fonctions.

Une fonction personnalisée malveillante (ou mal écrite) peut :

Prenez beaucoup de temps pour régénérer ou consommer des ressources excessives, ce qui interfère avec votre capacité à travailler avec l'atelier des pièces jusqu'à ce que vous supprimiez la fonction personnalisée.
Modifiez les valeurs de variable ou la géométrie dans l'atelier des pièces pour tenter de causer des dommages.

La publication de FeatureScript malveillants est contraire aux conditions d'utilisation d'Onshape et ne sera pas tolérée.

Veuillez signaler les fonctions personnalisées malveillantes à l'aide du bouton Commentaires du menu Aide.