Configuration d’une date d’expiration

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

La définition de la date d’expiration d’une transaction vous permet de limiter le temps dont dispose votre signataire pour finaliser la transaction. Après l’expiration d’une transaction, elle retourne dans le dossier des brouillons et son statut passe à EXPIRED. Par conséquent, les destinataires perdront leur accès à l’expérience du signataire. Une tâche souvent associée à la définition d’une date d’expiration est setting up a Reminder Schedule.

Si vous souhaitez prolonger la date d’expiration d’une transaction, y compris les transactions dont la date d’expiration est déjà dépassée, il vous suffit de fixer la date d’expiration à une date ultérieure et de renvoyer la transaction.

Spécification de la date d’expiration

La date d’expiration est une propriété au niveau de la transaction qui prend une valeur Date. Les valeurs de date dans OneSpan Sign sont formatées à l’aide de l’heure GMT. Si votre valeur de date utilise un autre fuseau horaire, vous devez la convertir en GMT avant d’utiliser la valeur dans votre objet DocumentPackage .

Par exemple, si vous souhaitez que le package expire à « 2019-08-23T00:00:00 EDT », utilisez le code suivant :

// step1: convert to GMT time
// local date, expire at 2019-07-23T00:00:00 EDT
TimeZone localTimeZone = TimeZone.getTimeZone("EDT");
Calendar localCalender = new GregorianCalendar(2019, 8 - 1, 23, 0, 0, 0); 
Date gmtDate = new Date(localCalender.getTimeInMillis() - localTimeZone.getRawOffset());	

Une fois que vous avez défini votre date GMT, incluez-la lors de la création de votre objet DocumentPackage . Pour ce faire, le code suivant :

// step2: create package with expiry date
DocumentPackage pkg = PackageBuilder
.newPackageNamed("Create a package with Expiry Date - " + System.currentTimeMillis())
.expiresAt(gmtDate)
.build();		

Pour définir une date d’expiration , defaultTimeBasedExpiry doit avoir la valeur FALSE. Il s’agit du paramètre par défaut pour ce paramètre. Toutefois, si cela a été modifié par un administrateur à l’aide de l’interface utilisateur de l’expéditeur (comme décrit dans la Transaction Expiry Settings), ce paramètre sera défini sur TRUE. Pour spécifier une date d’expiration , defaultTimeBasedExpiry doit être redéfini sur FALSE.

Expiration basée sur le temps

Une autre façon de définir une date d’expiration consiste à utiliser un intervalle de temps. Cette fonctionnalité permet aux expéditeurs de spécifier plus facilement une date d’expiration, en particulier lorsque le flux de travail dépend de modèles.

Les paramètres de niveau de transaction suivants déterminent l’intervalle de temps à utiliser lors de la définition d’un délai d’expiration.

• defaultTimeBasedExpiry

• restantsJours

Pour définir une date d’expiration basée sur le temps, utilisez le code suivant :

DocumentPackage pkg = PackageBuilder
		.newPackageNamed("Create a package with Expiry Date - " + System.currentTimeMillis())
		.withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()
				.withDefaultTimeBasedExpiry()
				.withRemainingDays(15)
				)
		.build();
PackageId createPackage = eslClient.createPackage(pkg);

• defaultTimeBasedExpiry et remainingDays doivent être définis pour utiliser une date d’expiration basée sur le temps.

• Lors de l’utilisation de l’expiration basée sur le temps, la date est calculée automatiquement en ajoutant les jours d’intervalle à la date de création de la transaction.

• Avec l’expiration basée sur le temps déjà définie pour votre transaction, si vous souhaitez toujours spécifier la date exacte, n’oubliez pas de désactiver l’expiration basée sur le jour en définissant .withoutDefaultTimeBasedExpiry() en même temps que vous mettez à jour la transaction. Cela permettra d’éviter toute confusion potentielle.

Jours d’intervalle par défaut

La définition du nombre de jours par défaut avant l’expiration d’une transaction peut être effectuée aux niveaux suivants :

• Au niveau du compte : Étant donné que l’expiration basée sur le temps est un paramètre de transaction, les valeurs par défaut de cette configuration peuvent être prédéfinies en contactant notre équipe d’assistance . Une fois cela fait, toutes les transactions nouvellement créées hériteront de ces valeurs et calculeront automatiquement l’attribut « due » en fonction de la date de création et des jours d’intervalle.

• Niveau du modèle : La définition d’un nombre de jours par défaut avant l’expiration est très utile lorsque vous travaillez avec des modèles. Si vous utilisez un modèle, cela n’a pas de sens que ce modèle porte une date d’expiration fixe qui serait ensuite recyclée lors des utilisations futures du modèle. En définissant un nombre de jours d’intervalle par défaut, toutes les dates d’expiration sont calculées dynamiquement. Lorsque vous créez des transactions à partir d’un modèle existant, elles héritent alors d’un intervalle de temps par défaut plutôt que d’une date d’expiration fixe.

Transaction Expiration

Une fois votre transaction expirée, notez ce qui suit :

• Tous les signataires perdront immédiatement l’accès à l’expérience du signataire.

• Le changement de statut de la transaction en EXPIRÉ se produit toutes les heures, ce qui signifie qu’il est possible que votre transaction affiche toujours le statut ENVOYÉ pendant une courte période.

• Une fois que le statut de votre transaction est modifié, les destinataires recevront un e-mail de notification. Pour annuler ou personnaliser ce message, contactez notre équipe d’assistance.

Reportez-vous au guide « Créer un écouteur de notification d’événement de rappel » pour savoir comment informer votre application de l’événement d’expiration de la transaction.

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

La définition de la date d’expiration d’une transaction vous permet de limiter le temps dont dispose votre signataire pour finaliser la transaction. Après l’expiration d’une transaction, elle retourne dans le dossier des brouillons et son statut passe à EXPIRED. Par conséquent, les destinataires perdront leur accès à l’expérience du signataire. Une tâche souvent associée à la définition d’une date d’expiration est setting up a Reminder Schedule.

Si une transaction expire et que vous souhaitez prolonger l’accès, il vous suffit de fixer la date d’expiration à une date ultérieure et de renvoyer la transaction.

Spécification de la date d’expiration

La date d’expiration est une propriété au niveau de la transaction qui prend une valeur Date. Les valeurs de date dans OneSpan Sign sont formatées à l’aide de l’heure GMT. Si votre valeur de date utilise un autre fuseau horaire, vous devez la convertir en GMT avant d’utiliser la valeur dans votre objet DocumentPackage .

Par exemple, si vous souhaitez que le package expire à « 2019-08-23T00:00:00 EDT », utilisez le code suivant :

//step1: convert local time to GMT
// local date, expire at 2019-08-23T00:00:00 EDT
DateTime easternTime = new DateTime(2019, 08, 23, 00, 00, 00);
string easternZoneId = "Eastern Standard Time";
TimeZoneInfo easternZone = TimeZoneInfo.FindSystemTimeZoneById(easternZoneId);
DateTime gmtTime = TimeZoneInfo.ConvertTimeToUtc(easternTime, easternZone);

Une fois que vous avez défini votre date GMT, incluez-la lors de la création de votre objet DocumentPackage . Pour ce faire, le code suivant :

// step2: create package with expiry date
DocumentPackage pkg = PackageBuilder
        .NewPackageNamed("Create a package with Expiry Date - " + DateTime.Now)
        <strong>.ExpiresOn(gmtTime)</strong>
        .Build();

Pour définir une date d’expiration , defaultTimeBasedExpiry doit avoir la valeur FALSE. Il s’agit du paramètre par défaut pour ce paramètre. Toutefois, si cela a été modifié par un administrateur à l’aide de l’interface utilisateur de l’expéditeur (comme décrit dans la Transaction Expiry Settings), ce paramètre sera défini sur TRUE. Pour spécifier une date d’expiration , defaultTimeBasedExpiry doit être redéfini sur FALSE.

Expiration basée sur le temps

Une autre façon de définir une date d’expiration consiste à utiliser un intervalle de temps. Cette fonctionnalité permet aux expéditeurs de spécifier plus facilement une date d’expiration, en particulier lorsque le flux de travail dépend de modèles.

Les paramètres de niveau de transaction suivants déterminent l’intervalle de temps à utiliser lors de la définition d’un délai d’expiration.

• defaultTimeBasedExpiry

• restantsJours

Pour définir une date d’expiration basée sur le temps, utilisez le code suivant :

DocumentPackage pkg = PackageBuilder.NewPackageNamed("Create a package with Expiry Date - "  + System.DateTime.Now)
        .WithSettings(DocumentPackageSettingsBuilder.NewDocumentPackageSettings()
                                        <strong>.WithDefaultTimeBasedExpiry()</strong>
                                        <strong>.WithRemainingDays(15)</strong>
        )
        .Build();

PackageId pkgId = eslClient.CreatePackageOneStep(pkg);

• Lors de l’utilisation de l’expiration basée sur le temps, la date est calculée automatiquement en ajoutant les jours d’intervalle à la date de création de la transaction.

• Avec l’expiration basée sur le temps déjà définie pour votre transaction, si vous souhaitez toujours spécifier la date exacte, n’oubliez pas de désactiver l’expiration basée sur le jour en définissant .withoutDefaultTimeBasedExpiry() en même temps que vous mettez à jour la transaction. Cela permettra d’éviter toute confusion potentielle.

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

La définition de la date d’expiration d’une transaction vous permet de limiter le temps dont dispose votre signataire pour finaliser la transaction. Après l’expiration d’une transaction, elle retourne dans le dossier des brouillons et son statut passe à EXPIRED. Par conséquent, les destinataires perdront leur accès à l’expérience du signataire. Une tâche souvent associée à la définition d’une date d’expiration est la mise en place d’un calendrier de rappel.

Si une transaction expire et que vous souhaitez prolonger l’accès, il vous suffit de fixer la date d’expiration à une date ultérieure et de renvoyer la transaction.

Spécification de la date d’expiration

La date d’expiration est une propriété au niveau de la transaction formatée de la manière suivante : {aaaa}-{MM}-{jj}T{HH} :{mm} :{ss}Z. Les valeurs de date dans OneSpan Sign sont formatées à l’aide de l’heure GMT. Si votre valeur de date utilise un autre fuseau horaire, vous devez la convertir en GMT avant d’utiliser la valeur dans votre JSON de création de package.

Pour définir une date d’expiration , defaultTimeBasedExpiry doit avoir la valeur FALSE. Il s’agit du paramètre par défaut pour ce paramètre. Toutefois, si cela a été modifié par un administrateur à l’aide de l’interface utilisateur de l’expéditeur (comme décrit dans la Transaction Expiry Settings), ce paramètre sera défini sur TRUE. Pour spécifier une date d’expiration , defaultTimeBasedExpiry doit être redéfini sur FALSE.

Par exemple, si vous souhaitez que le package expire à « 2019-08-23T00:00:00 EDT », utilisez le code suivant :

Requête HTTP

POST /api/packages 

En-têtes HTTP

Authorization: Basic api_key
Accept: application/json
Content-Type: application/json 

Charge utile de la demande

 {
  "status": "DRAFT",
  "due": "2019-08-23T04:00:00Z",
  "type": "PACKAGE",
  "name": "Example Package"
}

Charge utile de réponse

{
    "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="
}

Expiration basée sur le temps

Une autre façon de définir une date d’expiration consiste à utiliser un intervalle de temps. Cette fonctionnalité permet aux expéditeurs de spécifier plus facilement une date d’expiration, en particulier lorsque le flux de travail dépend de modèles.

Les paramètres de niveau de transaction suivants déterminent l’intervalle de temps à utiliser lors de la définition d’un délai d’expiration.

• defaultTimeBasedExpiry

• restantsJours

Pour définir une date d’expiration basée sur le temps, utilisez le code suivant :

Requête HTTP

POST /api/packages 

En-têtes HTTP

Authorization: Basic api_key
Accept: application/json
Content-Type: application/json 

Charge utile de la demande

 {
  "status": "DRAFT",
  "description": "A test transaction for Time-based Expiry feature.",
  "language": "en",
  "timezoneId": "GMT",
  "settings": {
    "ceremony": {
      "defaultTimeBasedExpiry": true,
      "remainingDays": 15
    }
  },
  "type": "PACKAGE",
  "name": "Test Time based Expiry"
}

Charge utile de réponse

{
    "id": "4tz2ekfB7VcO2cFy6Hx1tkmtyo0="
}

• defaultTimeBasedExpiry et remainingDays doivent être définis pour utiliser une date d’expiration basée sur le temps.

• Lors de l’utilisation de l’expiration basée sur le temps, la date est calculée automatiquement en ajoutant les jours d’intervalle à la date de création de la transaction.

• Avec l’expiration basée sur le temps déjà définie pour votre transaction, si vous souhaitez toujours spécifier la date exacte, n’oubliez pas de désactiver l’expiration basée sur le jour en définissant .withoutDefaultTimeBasedExpiry() en même temps que vous mettez à jour la transaction. Cela permettra d’éviter toute confusion potentielle.