Dans ce document, nous partons du principe que vous savez comment créer et utiliser des tâches. Il fournit des exemples spécifiques pour finaliser les tâches d'expédition comme suit :
Fermer une tâche : lorsque vous fermez une tâche d'expédition, son état passe à
CLOSED
et indique qu'elle n'est plus active.Définissez le résultat de la tâche: une fois la tâche fermée, vous pouvez la finaliser en définissant son résultat sur
SUCCEEDED
ouFAILED
. Il s'agit d'une partie importante de la finalisation d'une tâche. Elle permet de montrer le résultat de la livraison dans le partage du parcours et de garantir une facturation correcte pour le service Fleet Engine.
Fermer une tâche
Vous pouvez fermer une tâche de différentes manières:
- Mettez à jour l'état de l'arrêt du véhicule. Vous supprimez l'arrêt du véhicule, ce qui ferme toutes les tâches associées à l'arrêt. Pour en savoir plus, consultez la section Mettre à jour l'état d'un arrêt.
- Supprimez la tâche de la liste des arrêts du véhicule. Cela implique de mettre à jour la liste des tâches pour l'arrêt, mais la tâche fermée ne fait plus partie de la liste. Consultez la section Modifier l'ordre des tâches.
- Définissez l'état de la tâche sur
CLOSED
. Cela ne peut être effectué que pour des tâches qui ne sont pas attribuées à des véhicules. Cette section présente cette approche.
Une fois que vous avez fermé une tâche, vous ne pouvez pas la rouvrir.
La fermeture d'une tâche n'indique pas si elle a réussi ou échoué. Il indique que la tâche n'est plus considérée comme en cours. Pour indiquer le résultat réel d'une tâche et l'afficher à des fins de suivi de la flotte et de partage de trajet, vous devez indiquer le résultat réel d'une tâche. Consultez la section Définir le résultat de la tâche ci-dessous.
Champs de tâche pour les tâches de clôture
Cette section décrit les champs obligatoires à définir lors de la clôture d'une tâche. Fleet Engine ignore tous les autres champs de l'entité pour la mise à jour.
Champ obligatoire | Valeur |
---|---|
state |
State.CLOSED |
Fermer une tâche directement
Les exemples suivants montrent comment définir une tâche non attribuée sur un état fermé, que ce soit en gRPC ou à l'aide d'un appel de requête REST HTTP à UpdateTask
.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
Task task = Task.newBuilder()
.setName(taskName)
.setState(Task.State.CLOSED) // You can only directly CLOSE a
.build(); // task that is NOT assigned to a vehicle.
// Task request
UpdateTaskRequest updateTaskRequest =
UpdateTaskRequest.newBuilder() // No need for the header
.setTask(task)
.setUpdateMask(FieldMask.newBuilder().addPaths("state"))
.build();
try {
Task updatedTask = deliveryService.updateTask(updateTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=state
- <id> est un identifiant unique pour la tâche.
- L'en-tête de la requête doit contenir un champ Authorization avec la valeur Bearer <token>, où <token> est émis par votre serveur conformément aux consignes décrites dans Rôles de compte de service et Jetons Web JSON.
- Vous devez inclure une entité
Task
dans le corps de la requête.
Exemple de commande curl
:
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=state,taskOutcome,taskOutcomeTime" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"state": "CLOSED",
"taskOutcome": "SUCCEEDED",
"taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
}
EOM
Définir le résultat de la tâche
Pour indiquer le résultat réel d'une tâche, définissez le résultat des tâches clôturées sur SUCCEEDED
ou FAILED
. Une tâche doit être fermée avant de définir son résultat. Fleet Engine ne facture que les tâches de livraison dont l'état est SUCCEEDED
.
Détails du résultat de la tâche
Les tâches fournissent également des informations supplémentaires sur le résultat de la tâche. Vous pouvez les définir directement. Fleet Engine respecte vos paramètres:
- Emplacement du résultat de la tâche: Fleet Engine indique automatiquement l'emplacement du résultat de la tâche en indiquant la dernière position connue du véhicule. Vous pouvez fournir cette information à la place si vous préférez.
- Délai de résultat de la tâche: Fleet Engine ne remplit pas ce champ, mais vous pouvez le définir.
Vous pouvez utiliser l'une des approches suivantes pour définir task_outcome_location
et task_outcome_time
:
- Mettez-les à jour dans la même requête qui définit le résultat de la tâche.
- Mettez-les à jour plus tard, après avoir défini le résultat de la tâche.
- Modifiez-les à nouveau une fois qu'ils ont été définis.
Fleet Engine empêche les mises à jour suivantes liées aux résultats des tâches:
- Vous ne pouvez pas modifier le résultat d'une tâche une fois qu'il est défini sur
SUCCEEDED
ouFAILED
. - Vous ne pouvez pas définir d'emplacement ou d'heure de résultat des tâches pour des tâches sans résultat défini.
Champs de tâche pour définir le résultat
Cette section décrit les champs obligatoires et facultatifs à définir lors de la définition d'un résultat de tâche. Fleet Engine ignore les autres champs de l'entité pour la mise à jour.
Champ obligatoire | Valeur |
---|---|
taskOutcome |
Outcome.SUCCEEDED ou Outcome.FAILED |
Champ facultatif | Valeur |
---|---|
taskOutcomeLocation |
Emplacement où la tâche a été effectuée. Si cette règle n'est pas configurée, Fleet Engine utilise par défaut la dernière position du véhicule. |
taskOutcomeTime |
Horodatage de la fin de la tâche. |
Exemples de résultats de tâche
L'exemple suivant montre comment utiliser la bibliothèque gRPC Java et un appel REST HTTP à UpdateTask
pour définir un résultat de tâche sur SUCCEEDED
et définir l'emplacement où la tâche a été effectuée.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
Task task = Task.newBuilder()
.setName(taskName)
.setTaskOutcome(TaskOutcome.SUCCEEDED)
.setTaskOutcomeTime(now())
.setTaskOutcomeLocation( // Grand Indonesia East Mall
LocationInfo.newBuilder().setPoint(
LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
.build();
// Task request
UpdateTaskRequest updateTaskRequest =
UpdateTaskRequest.newBuilder() // No need for the header
.setTask(task)
.setUpdateMask(FieldMask.newBuilder().addPaths("task_outcome", "task_outcome_time", "task_outcome_location"))
.build();
try {
Task updatedTask = deliveryService.updateTask(updateTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation
- <id> est un identifiant unique pour la tâche.
- L'en-tête de requête doit contenir un champ Authorization avec la valeur Bearer <token>, où <token> est émis par votre serveur conformément aux instructions décrites dans les sections Rôles de compte de service et Jetons Web JSON.
- Le corps de la requête doit contenir une entité
Task
.
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"taskOutcome": "SUCCEEDED",
"taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
"taskOutcomeLocation": {
"point": {
"latitude": -6.195139,
"longitude": 106.820826
}
}
}
EOM