Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La configuración de la fecha de caducidad de una transacción le permite limitar el tiempo que tiene su firmante para completar la transacción. Después de que una transacción caduque, volverá a la carpeta de borradores y el estado cambiará a CADUCÓ. En consecuencia, los destinatarios perderán su acceso a la Signer Experience. Una tarea que suele ir unida a la fijación de una fecha de caducidad es la creación de un calendario de recordatorios.

Si desea ampliar la fecha de vencimiento de una transacción, incluidas aquellas transacciones cuya fecha de vencimiento ya ha pasado, simplemente establezca la fecha de vencimiento en una fecha futura y vuelva a enviar la transacción.

Especificar la fecha de caducidad

La fecha de caducidad es una propiedad del nivel de transacción que toma un valor de Fecha. Los valores de la fecha de OneSpan Sign se formatean utilizando la hora GMT. Si su valor de fecha utiliza otra zona horaria, debe convertirlo a GMT antes de utilizar el valor en su objeto DocumentPackage.

Por ejemplo, si desea que el paquete caduque el "2019-08-23T00:00:00 EDT", use el siguiente código:

// 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());

Una vez que haya establecido su fecha GMT, inclúyala al crear su objeto DocumentPackage . Use el siguiente código para hacerlo:

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

Caducidad basada en el tiempo

Otra forma de establecer una fecha de caducidad es utilizar un intervalo de tiempo. Esta función facilita a los remitentes la especificación de una fecha de caducidad, especialmente cuando el flujo de trabajo depende de formularios.

Los siguientes ajustes de nivel de transacción determinan el intervalo de tiempo que se utilizará al establecer un tiempo de caducidad.

  • defaultTimeBasedExpiry

  • remainingDays

Para establecer una caducidad basada en el tiempo, utilice el siguiente código:

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

  • Tanto defaultTimeBasedExpiry como remainingDays se deben configurar para usar una caducidad basada en el tiempo.
  • Cuando se utiliza la caducidad basada en el tiempo, la fecha se calcula automáticamente agregando los días de intervalo a la fecha de creación de la transacción.
  • Con la caducidad basada en el tiempo ya establecida para su transacción, si aún desea especificar la fecha exacta, no olvide desactivar la caducidad basada en días estableciendo .withoutDefaultTimeBasedExpiry() al mismo tiempo que actualiza la transacción. Este método ayuda a evitar cualquier posible confusión.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La configuración de la fecha de caducidad de una transacción le permite limitar el tiempo que tiene su firmante para completar la transacción. Después de que una transacción caduque, volverá a la carpeta de borradores y el estado cambiará a CADUCÓ. En consecuencia, los destinatarios perderán su acceso a la Signer Experience. Una tarea que suele ir unida a la fijación de una fecha de caducidad es la creación de un calendario de recordatorios.

Si una transacción caduca y desea prorrogar el acceso, solo tiene que cambiar la fecha de caducidad a una fecha futura y enviar de nuevo la transacción.

Especificar la fecha de caducidad

La fecha de caducidad es una propiedad del nivel de transacción que toma un valor de Fecha. Los valores de la fecha de OneSpan Sign se formatean utilizando la hora GMT. Si su valor de fecha utiliza otra zona horaria, debe convertirlo a GMT antes de utilizar el valor en su objeto DocumentPackage.

Por ejemplo, si desea que el paquete caduque el "2019-08-23T00:00:00 EDT", use el siguiente código:

//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);

Una vez que haya establecido su fecha GMT, inclúyala al crear su objeto DocumentPackage . El siguiente código hará lo siguiente:

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

Caducidad basada en el tiempo

Otra forma de establecer una fecha de caducidad es utilizar un intervalo de tiempo. Esta función facilita a los remitentes la especificación de una fecha de caducidad, especialmente cuando el flujo de trabajo depende de formularios.

Los siguientes ajustes de nivel de transacción determinan el intervalo de tiempo que se utilizará al establecer un tiempo de caducidad.

  • defaultTimeBasedExpiry

  • remainingDays

Para establecer una caducidad basada en el tiempo, utilice el siguiente código:

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

PackageId pkgId = eslClient.CreatePackageOneStep(pkg);

  • Tanto defaultTimeBasedExpiry como remainingDays se deben configurar para usar una caducidad basada en el tiempo.
  • Cuando se utiliza la caducidad basada en el tiempo, la fecha se calcula automáticamente agregando los días de intervalo a la fecha de creación de la transacción.
  • Con la caducidad basada en el tiempo ya establecida para su transacción, si aún desea especificar la fecha exacta, no olvide desactivar la caducidad basada en días estableciendo .withoutDefaultTimeBasedExpiry() al mismo tiempo que actualiza la transacción. Este método ayuda a evitar cualquier posible confusión.

Días de intervalo predeterminados

Establecer el número predeterminado de días antes de que una transacción caduque puede hacerse en los siguientes niveles:

  • Nivel de cuenta: Dado que la caducidad basada en el tiempo es una configuración de transacción, los valores predeterminados para esta configuración se pueden preestablecer comunicándose con nuestro Equipo de asistencia. Una vez hecho esto, todas las transacciones recién creadas heredarán estos valores y calcularán automáticamente el atributo "due" basándose en la fecha de creación y los días de intervalo.

  • Nivel de formulario: Establecer un número predeterminado de días antes de la caducidad es muy útil cuando se trabaja con formularios. Si se utiliza un formulario, no tiene sentido que ese formulario tenga una fecha de caducidad fija que luego se reciclará en futuros usos del formulario. Al establecer un número predeterminado de días de intervalo, todas las fechas de caducidad se calculan dinámicamente. Cuando cree transacciones a partir de un formulario existente, heredarán un intervalo de tiempo predeterminado en lugar de una fecha fija para su caducidad.

Caducidad de la transacción

Una vez que caduque su transacción, tenga en cuenta lo siguiente:

  • Todos los firmantes perderán el acceso a la Signer Experience inmediatamente.
  • El cambio de estado de la transacción a CADUCÓ se produce cada hora, lo que significa que es posible que su transacción siga apareciendo en estado ENVIADO durante un breve período de tiempo.
  • Una vez que se cambie el estado de la transacción, los destinatarios recibirán una notificación por correo electrónico. Para cancelar o personalizar este mensaje, póngase en contacto con nuestro Equipo de asistencia.

Consulte la guía "Crear una escucha de notificaciones de eventos de devolución de llamada" para ver cómo notificar a su aplicación el evento de caducidad de la transacción.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La configuración de la fecha de caducidad de una transacción le permite limitar el tiempo que tiene su firmante para completar la transacción. Después de que una transacción caduque, volverá a la carpeta de borradores y el estado cambiará a CADUCÓ. En consecuencia, los destinatarios perderán su acceso a la Signer Experience. Una tarea que suele ir unida a la fijación de una fecha de caducidad es la creación de un calendario de recordatorios.

Si una transacción caduca y desea prorrogar el acceso, solo tiene que cambiar la fecha de caducidad a una fecha futura y enviar de nuevo la transacción.

Especificar la fecha de caducidad

La fecha de caducidad es una propiedad a nivel de transacción formateada de la siguiente manera {yyyy}-{MM}-{dd}T{HH}:{mm}:{ss}Z. Los valores de la fecha de OneSpan Sign se formatean utilizando la hora GMT. Si su valor de fecha utiliza otra zona horaria, debe convertirlo a GMT antes de utilizar el valor en su JSON de creación de paquetes.

Por ejemplo, si desea que el paquete caduque el "2019-08-23T00:00:00 EDT", use el siguiente código:

Solicitud HTTP

POST /api/packages

Encabezados HTTP

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

Carga útil de solicitud

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

Carga útil de respuesta

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

Caducidad basada en el tiempo

Otra forma de establecer una fecha de caducidad es utilizar un intervalo de tiempo. Esta función facilita a los remitentes la especificación de una fecha de caducidad, especialmente cuando el flujo de trabajo depende de formularios.

Los siguientes ajustes de nivel de transacción determinan el intervalo de tiempo que se utilizará al establecer un tiempo de caducidad.

  • defaultTimeBasedExpiry

  • remainingDays

Para establecer una caducidad basada en el tiempo, utilice el siguiente código:

Solicitud HTTP

POST /api/packages

Encabezados HTTP

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

Carga útil de solicitud

 {
  "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"
}

Carga útil de respuesta

{
    "id": "4tz2ekfB7VcO2cFy6Hx1tkmtyo0="
}

  • Tanto defaultTimeBasedExpiry como remainingDays se deben configurar para usar una caducidad basada en el tiempo.
  • Cuando se utiliza la caducidad basada en el tiempo, la fecha se calcula automáticamente agregando los días de intervalo a la fecha de creación de la transacción.
  • Con la caducidad basada en el tiempo ya establecida para su transacción, si aún desea especificar la fecha exacta, no olvide desactivar la caducidad basada en días estableciendo .withoutDefaultTimeBasedExpiry() al mismo tiempo que actualiza la transacción. Este método ayuda a evitar cualquier posible confusión.

Días de intervalo predeterminados

Establecer el número predeterminado de días antes de que una transacción caduque puede hacerse en los siguientes niveles:

  • Nivel de cuenta: Dado que la caducidad basada en el tiempo es una configuración de transacción, los valores predeterminados para esta configuración se pueden preestablecer comunicándose con nuestro Equipo de asistencia. Una vez hecho esto, todas las transacciones recién creadas heredarán estos valores y calcularán automáticamente el atributo "due" basándose en la fecha de creación y los días de intervalo.

  • Nivel de formulario: Establecer un número predeterminado de días antes de la caducidad es muy útil cuando se trabaja con formularios. Si se utiliza un formulario, no tiene sentido que ese formulario tenga una fecha de caducidad fija que luego se reciclará en futuros usos del formulario. Al establecer un número predeterminado de días de intervalo, todas las fechas de caducidad se calculan dinámicamente. Cuando cree transacciones a partir de un formulario existente, heredarán un intervalo de tiempo predeterminado en lugar de una fecha fija para su caducidad.

Caducidad de la transacción

Una vez que caduque su transacción, tenga en cuenta lo siguiente:

  • Todos los firmantes perderán el acceso a la Signer Experience inmediatamente.
  • El cambio de estado de la transacción a CADUCÓ se produce cada hora, lo que significa que es posible que su transacción siga apareciendo en estado ENVIADO durante un breve período de tiempo.
  • Una vez que se cambie el estado de la transacción, los destinatarios recibirán una notificación por correo electrónico. Para cancelar o personalizar este mensaje, póngase en contacto con nuestro Equipo de asistencia.

Consulte la guía "Crear una escucha de notificaciones de eventos de devolución de llamada" para ver cómo notificar a su aplicación el evento de caducidad de la transacción.