Collecter SharePoint données de dépannage du flux de travail 2013 avec ShowScopeDebugInfo

La fonction ShowScopeDebugInfo() permet de résoudre plus facilement les problèmes courants qui affectent les flux de travail SharePoint 2013 et fournit également des informations supplémentaires aux agents de support qui vous aident à résoudre les problèmes de flux de travail.

Comment exécuter la fonction ShowScopeDebugInfo()

  1. Sur le site qui rencontre le problème de flux de travail, sélectionnez Paramètres (icône d’engrenage), puis sélectionnez Site Paramètres > Workflow Paramètres Workflow > Health.

    • Vous pouvez également accéder à l’état du flux de travail à partir d’une URL. Par exemple : https://<contoso>.sharepoint.com/sites/<test>/_layouts/15/WorkflowServiceHealth.aspx. (Dans cet exemple, remplacez contoso par votre domaine et testez avec le nom du site SharePoint site.)
  2. Ouvrez les outils de développement à partir d’un navigateur web (Edge ou Google Chrome est recommandé).

    • Pour Microsoft Edge, appuyez sur la touche F12.
    • Pour Google Chrome, appuyez sur Shift+Ctrl+J.
  3. Select Console.

  4. Entrez le nom de la fonction suivante : ShowScopeDebugInfo().

    • Appuyez sur Entrée. La commande exécute une fonction JavaScript pour imprimer les données en arrière-plan.
    • Remarque: la page État du service de flux de travail doit être actualisée pour obtenir des données mises à jour à partir de ShowScopeDebugInfo. Les informations générées par ShowScopeDebugInfo ne sont pas renvoyées en temps réel. Il existe un léger délai avant la mise à jour des résultats.

Exemple de sortie:

{
  "SupportDocument": "https://go.microsoft.com/fwlink/?linkid=847765",
  "ScopePath": "/spo/ec63b09b-9748-47ba-9018-beeadd405204/f19089ae-d6c6-4feb-be0b-ff4de40a04fc/88890858-ae38-407a-b1e7-152c7cff6fe5",
  "WorkflowEndpoint": "spo-dm3-001.workflow.windows.net",
  "WorkflowAppId": "i:0i.t|ms.sp.ext|5958c314-3699-407a-b142-2d459b5161c4@72f988bf-86f1-41af-91ab-2d7cd011db47",
  "IsThrottled": false,
  "ThrottledUntil": "",
  "ActiveMessageCount": "965436",
  "StatusDetails": "MaxTopicSize",
  "ScopeSizeInBytes": "6447069028",
  "MaxScopeSizeInBytes": "6442450944",
  "CorrelationFilterCount": "1851",
  "MaxCorrelationFilterCount": "100000",
  "ScopeUsageInfoAggregatedByWorkflow": [
    {
      "workflowName": "87effe93-5c6a-474d-8a72-0ef451ff0100",
      "workflowDisplayName": "ANewWF",
      "sizeInBytes": 0,
      "correlationFilterCount": 0
    },
    {
      "workflowName": "df26aa85-85a7-4466-a273-1775c9da38bb",
      "workflowDisplayName": "Neat2013ListWorkflow",
      "sizeInBytes": 52591272,
      "correlationFilterCount": 1827
    },
    {
      "workflowName": "fc7a63c5-ff72-42e5-87fd-3f2944f8a6ef",
      "workflowDisplayName": "Spec_Document_Approval",
      "sizeInBytes": 277327,
      "correlationFilterCount": 24
    }
  ]
}

Comment lire les résultats

Étiquette Définition
SupportDocument SharePoint documentation publique de flux de travail 2013 pour aider les auteurs de flux de travail à éviter les conceptions de flux de travail problématiques courantes et les erreurs courantes.
ScopePath Informations requises pour impliquer SharePoint de fonctionnalités de flux de travail 2013.
WorkflowEndpoint Informations requises pour impliquer SharePoint de fonctionnalités de flux de travail 2013.
WorkflowAppId Informations requises pour impliquer SharePoint de fonctionnalités de flux de travail 2013.
IsThrottled Indique si le service de flux de travail Azure est en cours de limitation SharePoint flux de travail du site SharePoint 2013. La limitation est par site SharePoint et est évaluée toutes les 10 minutes. Si toutes les instances de flux de travail SharePoint 2013 dépassent la limite de limitation dynamique, le service de flux de travail Azure limite toutes les instances de flux de travail SharePoint 2013 pendant un minimum de cinq minutes, et les instances de flux de travail reprennent au cours de la fenêtre de traitement de 10 minutes suivante.
ThrottledUntil Si IsThrottled est vrai, throttledUntil contiendra une date et une heure UTC pour indiquer à quel moment la limitation expirera.
ActiveMessageCount Représente l’abonnement ServiceBus ActiveMessageCount. Au SharePoint instances de flux de travail 2013 sont lancées, les messages sont mis en file d’attente dans Azure ServiceBus et ces messages sont traitées par le système de service de flux de travail Azure. Si SharePoint instances de flux de travail 2013 sont traitées lentement, cela est souvent dû à une limitation et/ou à une file d’attente Azure ServiceBus importante, comme indiqué par ActiveMessageCount.
StatusDetails Indique la raison pour laquelle les flux de travail SharePoint 2013 du site SharePoint actuel ne progressent pas et pourquoi il n’est pas possible de démarrer les instances de flux de travail SharePoint 2013 manuellement ou automatiquement. Actuellement, MaxTopicSize et MaxCorrelationFilter sont inclus pour indiquer quelle limite a été dépassée.
ScopeSizeInBytes Représente le stockage SharePoint flux de travail d’un site SharePoint 2013 dans le service de flux de travail Azure. Le service de flux de travail Azure utilise Azure Service Bus et Azure SQL pour activer SharePoint flux de travail 2013. Chaque SharePoint site est alloué à 6 Go. Le service de flux de travail Azure est la version cloud de l’Gestionnaire de flux de travail. Si ScopeSizeInBytes a dépassé MaxScopeSizeInBytes, statusDetails indique MaxTopicSize. Cela signifie que la limite a été dépassée et que les instances de flux de travail SharePoint 2013 ne démarrent pas lorsqu’elles sont déclenchées manuellement ou en créant et en éditant des données dans SharePoint Online. Il est possible de déterminer quel flux de travail SharePoint 2013 utilise le plus d’espace en examinant ScopeUsageInfoAggregatedByWorkflow. ScopeUsageInfoAggregatedByWorkflow n’est pas renvoyé en temps réel, mais est relativement à jour. Chaque flux de travail SharePoint 2013 contient sizeInBytes et peut servir de guide pour identifier le flux de travail SharePoint 2013 à supprimer d’une liste ou d’une bibliothèque SharePoint. En supprimant un flux SharePoint 2013 d’une page de flux de travail de liste ou de bibliothèque Paramètres page, un processus de nettoyage est lancé. Une fois ce processus terminé, le SharePoint flux de travail du site reprendra le traitement. La colonne StatusDetails ne contient plus MaxTopicSize ou ScopeSizeInBytes. Elle sera plus petite que MaxScopeSizeInBytes. Il sera possible de démarrer les flux de SharePoint 2013.
MaxScopeSizeInBytes Représente le stockage maximal alloué au service de flux de travail Azure pour le site SharePoint actuel.
CorrelationFilterCount Représente l’utilisation actuelle du service de flux de travail Azure des filtres de corrélationAzure ServiceBus. Lorsqu’un flux de travail SharePoint 2013 simple est démarré manuellement ou en créant ou en éditant des données dans SharePoint Online, deux filtres de corrélation sont utilisés par instance de flux de travail. À mesure SharePoint flux de travail 2013 devient plus complexe, davantage de filtres de corrélation sont utilisés. Les actions telles que Attendre que le champ change ou Attendre la modification dans la liste consomment complètement des filtres de corrélation.

MaxCorrelationFilterCount représente la limite maximale du filtre de corrélation à 100 000. Si le flux de travail SharePoint 2013 est créé, cela signifie qu’il y a un maximum de 50 000 instances de flux de travail actives par site SharePoint site. Toutefois, il est peu probable que vous pouvez atteindre 50 000 instances de flux de travail, car la plupart des flux de travail utilisent plus que les deux filtres de corrélation par défaut qui sont nécessaires pour démarrer une instance de flux de travail. Une fois qu’une instance de flux de travail est arrivée à terme, le nombre de filtres de corrélation est réduit. Cela permet d’avoir plus d’instances de flux de travail.

Si CorrelationFilterCount est supérieur à MaxCorrelationFilterCount, statusDetails contiendra MaxCorrelationFilter. Il ne sera pas possible de démarrer des instances de flux de travail. Le même comportement décrit dans ScopeSizeInBytes se produit lorsque CorrelationFilterCount dépasse MaxCorrelationFilterCount. En outre, la même solution est possible. Utilisez ScopeUsageInfoAggregatedByWorkflow et recherchez le flux de travail avec le plus élevé correlationFilterCount et envisagez de le supprimer de la liste ou de la bibliothèque SharePoint, à l’aide de la page Flux de Paramètres. Si un flux SharePoint 2013 est supprimé à l’aide de SharePoint Designer, il supprime la logique de flux de travail et le flux de travail doit être recréé. Il est préférable de supprimer le flux de travail à l’aide de la page flux de travail Paramètres, puis ajuster la logique de flux de travail en fonction des recommandations trouvées ici.
MaxCorrelationFilterCount Représente le nombre de filtres de corrélation alloués dans le service de flux de travail Azure pour le site SharePoint actuel.
ScopeUsageInfoAggregatedByWorkflow Contient l’SharePoint flux de travail du site SharePoint 2013. Chaque flux de travail contient les données suivantes : workflowName, workflowDisplayName, sizeInBytes et correlationFilterCount. Les données dans ScopeUsageInfoAggregatedByWorkflow ne sont pas mises à jour en temps réel. Il s’agit d’un instantané fréquemment mis à jour.
  • workflowName est map pour le WorkflowSubscription.Id.
  • workflowDisplayName est map WorkflowSubscription.Name. Ce nom est le nom SharePoint flux de travail 2013 dans l’SharePoint UX. Ce nom peut différer de celui qui se trouverait dans SharePoint Designer.
  • sizeInBytes est l’utilisation du stockage des flux de travail. Il est regroupé dans ScopeSizeInBytes.
  • correlationFilterCount est l’utilisation du filtre de corrélation de flux de travail. Il est agrégé dans CorrelationFilterCount.