ScriptableDataStream : champ d’application, global
L’API ScriptableDataStream fournit des méthodes permettant d’interagir avec un flux de données.
Cette classe ne peut être utilisée que dans un script côté serveur après avoir récupéré un objet ScriptableDataStream à l’aide de l’une de ces API :
- La méthode executeDataStreamAction() dans la classe FlowAPI . Voir FlowAPI.
- La méthode getDataStream() dans la classe ScriptableFlowRunnerResult . Consultez ScriptableFlowRunnerResult.
Après avoir récupéré un objet ScriptableDataStream, appelez les méthodes dans l’ordre spécifique suivant :
- Utilisez la méthode hasNext() pour déterminer s’il y a plus d’éléments dans le flux de données.
- Utilisez la méthode next() pour accéder à l’élément suivant du flux.
- Utilisez les méthodes getItemIndex(),getItemInPageIndex() et getPageIndex() pour obtenir des informations à partir du flux.
- Utilisez la méthode close() pour fermer le flux.
Cette classe s’exécute dans l’espace de noms sn_fd .
try/catch pour intercepter les erreurs. Incluez toujours une instruction finally qui se termine par la méthode close() de la classe ScriptableDataStream pour fermer le flux de données et éviter les problèmes de performances.ScriptableDataStream : close()
Ferme la connexion à un flux de données. Appelez toujours cette méthode après avoir effectué des opérations souhaitées sur un flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| nul |
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_snc_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var user = stream.next();
// Only log the first item in each page
if (stream.getItemInPageIndex() == 0) {
gs.info('first user on page is ' + user.name);
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();ScriptableDataStream : getItemIndex()
Renvoie l’index actuel d’un élément dans un flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Numéro | Index actuel d’un élément dans un flux de données à l’aide de l’indexation de base zéro. |
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var User = stream.next();
// Use the item. Example:
// var now_GR = new GlideRecord(<table_name>);
// now_GR.<field_name> = User.<field_name>;
// now_GR.insert();
// By default, this code snippet will terminate after 10 items.
// Remove or modify this limit after your code has been tested.
if (stream.getItemIndex() >= 9) {
break;
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();ScriptableDataStream : getItemInPageIndex()
Renvoie l’index actuel d’un élément dans la page actuelle dans un flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Numéro | Index actuel d’un élément dans la page actuelle dans le flux de données à l’aide de l’indexation de base zéro. |
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_snc_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var user = stream.next();
// Only log the first item in each page
if (stream.getItemInPageIndex() == 0) {
gs.info('first user on page is ' + user.name);
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();ScriptableDataStream : getPageIndex()
Renvoie l’index actuel d’une page dans un flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Numéro | Index actuel d’une page dans un flux de données avec l’indexation de base zéro. |
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var item = stream.next();
// Use the item.
var now_GR = new GlideRecord('incident');
now_GR.setValue('number',item.id);
now_GR.setValue('short_description',item.name);
now_GR.insert();
// By default, this code snippet will terminate after 5 pages.
// Remove or modify this limit after testing your code.
if (stream.getPageIndex() >= 4) {
break;
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();ScriptableDataStream : hasNext()
Renvoie la valeur true s’il existe d’autres éléments dans le flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Booléen | Marqueur qui détermine s’il existe d’autres éléments dans le flux de données. Les valeurs comprennent :
|
Cet exemple crée un enregistrement d’incident pour chaque élément renvoyé dans le flux de données.
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var item = stream.next();
// Use the item.
var now_GR = new GlideRecord('incident');
now_GR.setValue('number',item.id);
now_GR.setValue('short_description',item.name);
now_GR.insert();
// By default, this code snippet will terminate after 10 items.
// Remove or modify this limit after testing your code.
if (stream.getItemIndex() >= 9) {
break;
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();ScriptableDataStream : next()
Renvoie l’élément suivant dans un flux de données.
Vous ne pouvez appeler cette méthode que sur un objet ScriptableDataStream renvoyé par la méthode executeDataStreamAction() dans la classe FlowAPI. Voir FlowAPI.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Objet | L’élément suivant dans le flux de données. Cet objet contient les sorties définies par l’action Flux de données. Pour afficher les résultats de l’action Flux de données, accédez à la section Sorties de l’action Flux de données dans l’interface du Concepteur de flux. |
Cet exemple crée un enregistrement d’incident pour chaque élément renvoyé dans le flux de données.
(function() {
try {
// Execute Data Stream Action.
var stream = sn_fd.FlowAPI.executeDataStreamAction('x_my_scope.data_stream_name');
// Process each item in the data stream
while (stream.hasNext()) {
// Get a single item from the data stream.
var item = stream.next();
// Use the item.
var now_GR = new GlideRecord('incident');
now_GR.setValue('number',item.id);
now_GR.setValue('short_description',item.name);
now_GR.insert();
// By default, this code snippet will terminate after 10 items.
// Remove or modify this limit after testing your code.
if (stream.getItemIndex() >= 9) {
break;
}
}
} catch (ex) {
var message = ex.getMessage();
gs.error(message);
} finally {
stream.close();
}
})();