Administrar informes programados con Command Manager

En esta entrada vamos a ver algunas posibilidades que nos da MicroStrategy para administrar informes programados con Command Manager por medio de script. Recuerda que para ejecutar estos script tan solo tienes que iniciar Command Manager y en menú Archivo seleccionar Nuevo Script…

Especificaciones del entorno

• Microsoft Windows 10
• MicroStrategy 2021

Listar suscripciones

Listar todas las suscripciones de un proyecto

LIST ALL SUBSCRIPTIONS 
    FOR PROJECT "NOMBRE_PROYECTO";

Listar todas las suscripciones de un informe o documento

LIST ALL SUBSCRIPTIONS 
    FOR CONTENT ("NOMBRE_DOCUMENTO"  
    IN FOLDER "RUTA_CARPETA") 
    FOR PROJECT "NOMBRE_PROYECTO";

Listar todas las suscripciones de un determinado tipo de entrega

LIST ALL SUBSCRIPTIONS 
    FOR DELIVERYTYPE (EMAIL | FILE | PRINT | HISTORYLIST | CACHE | MOBILE ) 
    FOR PROJECT "NOMBRE_PROYECTO";

En el código anterior se debe escoger una opción de las indicadas entre paréntesis antes de ejecutarlo.

Listar todas las suscripciones de un usuario en particular

LIST ALL SUBSCRIPTIONS 
    FOR OWNER "NOMBRE_LOGIN" 
    FOR PROJECT "NOMBRE_PROYECTO";

Listar todas las suscripciones de una planificación en concreto

LIST ALL SUBSCRIPTIONS 
    FOR SCHEDULE "NOMBRE_PLANIFICACION" 
    FOR PROJECT "NOMBRE_PROYECTO";

Listar todas las suscripciones de un destinatario en concreto

LIST ALL SUBSCRIPTIONS 
    FOR RECIPIENTS 
        (
            CONTACT "NOMBRE_CONTACTO"  | 
            ADDRESS "DIRECCION" | 
            USER "NOMBRE_LOGIN" | 
            GROUP "NOMBRE_GRUPO"
        ) 
    FOR PROJECT "NOMBRE_PROYECTO";

En el código anterior se debe escoger una opción de las indicadas entre paréntesis antes de ejecutarlo.

Listar todas las suscripciones de una suscripción en concreto

LIST ALL SUBSCRIPTIONS 
    FOR NAME "NOMBRE_SUSCRIPCION" 
    FOR PROJECT "NOMBRE_PROYECTO";

Listar todas las propiedades de una suscripción en concreto

LIST ALL PROPERTIES 
    FOR SUBSCRIPTION GUID F8888B8888D8E888E88DB8AE888E08C8
    FOR PROJECT "MicroStrategy Tutorial";

Crear suscripciones

Crear una suscripción de tipo email

CREATE EMAILSUBSCRIPTION "Mi Primera Suscripción" 
    FOR OWNER "migueltroyano_com" 
    SCHEDULE "DAILY"  
    CONTACT "Contact1" 
    CONTENT "Informe de Ventas" 
    IN FOLDER "\Objetos Publicos\Informes\Ventas\Informe de Ventas"  
    IN PROJECT "Microstrategy Tutorial"  
    DELIVERYFORMAT PDF 
    COMPRESSCONTENTS ZIPFILENAME "zip.txt"  
    ZIPFILEPASSWORD "password" 
    EXPIRATIONDATE 26/09/1986 
    FILENAME "MiSuscripcion"  
    SUBJECT "Mi Primera Suscripcion" 
    MESSAGE "Mi Primer Mensaje" 
    INCLUDELINK TRUE 
    SENDPREVIEWNOW TRUE 
    SENDTOHISTORYLIST TRUE 
    INCLUDEDATA TRUE;

Crear una suscripción de tipo caché

CREATE CACHEUPDATESUBSCRIPTION "Mi Primera Suscripción"
FOR OWNER "migueltroyano_com"
SCHEDULE  "DAILY" 
USER "migueltroyano_com" // Opciones USER | GROUP
CONTENT "Nuevo(a) Informe" 
IN FOLDER "\Objetos públicos\Informes"  // puedes sustituir esta linea por CONTENT GUID xxxxxxx
CONTENTTYPE REPORT // Opciones: REPORT | DOCUMENT
IN PROJECT  "MicroStrategy Tutorial"
DELIVERYFORMAT PDF //Opciones: PLAINTEXT | EXCEL | CSV | HTML | PDF | FLASH
SENDNOTIFICATION TRUE // Opciones: TRUE | FALSE
SENDNOTIFICATION_ADDRESS "info@migueltroyano.com"
PHYSICALADDRESS "info@migueltroyano.com"
DEVICE "Correo Web"
USEDATASETCACHE TRUE; // Opciones: TRUE | FALSE

Modificar suscripciones

Recuerda que para modificar una suscripción debes tener su GUID y que a pesar de contener letras y números no debe ir entrecomillado. Puedes obtener el GUID listando la suscripción con las opciones anteriormente vistas. Otra opción es modificar la suscripción escribiendo el nombre directamente. En los siguientes ejemplos se modificara la suscripción de tipo email por medio del nombre y la de tipo cache con su GUID para que veas las diferencias. Si necesitas buscar y remplazar una suscripción lee este otro articulo.

Modificar una suscripción de tipo email

ALTER EMAILSUBSCRIPTION "Mi Primera Suscripción Email" 
OWNER "migueltroyano_com" 
SCHEDULE "DAILY" 
CONTACT "Miguel"
CONTENT "Nuevo(a) Informe" 
IN FOLDER "\Objetos públicos\Informes"  // puedes sustituir esta linea por CONTENT GUID xxxxxxx
CONTENTTYPE REPORT // Opciones: REPORT | DOCUMENT
IN PROJECT "MicroStrategy Tutorial" 
DELIVERYFORMAT PDF //Opciones: PLAINTEXT | EXCEL | CSV | HTML | PDF | FLASH 
FILENAME "MiSuscripcion" 
COMPRESSCONTENTS ZIPFILENAME "zip.txt" 
ZIPFILEPASSWORD "password" 
SUBJECT "Mi Primera Suscripcion" 
MESSAGE "Mi Primer Mensaje Modificado" 
INCLUDELINK TRUE  // Opciones: TRUE | FALSE
SENDPREVIEWNOW FALSE  // Opciones: TRUE | FALSE
SENDTOHISTORYLIST TRUE // Opciones: TRUE | FALSE
INCLUDEDATA TRUE
MODIFICATIONBYRECIPIENTS FALSE; // Opciones: TRUE | FALSE

Modificar una suscripción de tipo caché

ALTER CACHEUPDATESUBSCRIPTION GUID 6158DD25465BC9B1149B17833C9497A2
NAME "Mi Primera Suscripción" 
OWNER "migueltroyano_com"
SCHEDULE  "DAILY" 
USER "Demo" // Opciones USER | GROUP
CONTENT "Nuevo(a) Informe" 
IN FOLDER "\Objetos públicos\Informes"  // puedes sustituir esta linea por CONTENT GUID xxxxxxx
CONTENTTYPE REPORT // Opciones: REPORT | DOCUMENT
IN PROJECT  "MicroStrategy Tutorial"
DELIVERYFORMAT PDF //Opciones: PLAINTEXT | EXCEL | CSV | HTML | PDF | FLASH
SENDNOTIFICATION TRUE // Opciones: TRUE | FALSE
SENDNOTIFICATION_ADDRESS "info@migueltroyano.com"
PHYSICALADDRESS "info@migueltroyano.com"
DEVICE "Correo Web"
USEDATASETCACHE TRUE // Opciones: TRUE | FALSE;

Incluir un usuario a una suscripción

ADD USER "mtroyano" 
    TO SUBSCRIPTION GUID F8888B8888D8E888E88DB8AE888E08C8
    FOR PROJECT "Microstrategy Tutorial";

Incluir un contacto en una suscripción

ADD CONTACT "contact1" 
    TO SUBSCRIPTION GUID F8888B8888D8E888E88DB8AE888E08C8
    FOR PROJECT "Microstrategy Tutorial";

Eliminar suscripciones (opciones)

Eliminar una suscripción en concreto

DELETE SUBSCRIPTION GUID F8888B8888D8E888E88DB8AE888E08C8 FROM PROJECT "MicroStrategy Tutorial";

Eliminar un usuario de una suscripción

REMOVE USER "mtroyano" 
    FROM SUBSCRIPTION GUID F8888B8888D8E888E88DB8AE888E08C8
    FOR PROJECT "Microstrategy Tutorial";

Eliminar todas las suscripciones de un proyecto

DELETE ALL SUBSCRIPTIONS FROM PROJECT "MicroStrategy Tutorial";

Eliminar todas las suscripciones de un determinado tipo de entrega

DELETE ALL SUBSCRIPTIONS 
    FOR DELIVERYTYPE (EMAIL | FILE | PRINT | HISTORYLIST | CACHE | MOBILE ) 
    FROM PROJECT "MicroStrategy Tutorial";

En el código anterior se debe escoger una opción de las indicadas entre paréntesis antes de ejecutarlo.

Eliminar todas las suscripciones de un determinado usuario

DELETE ALL SUBSCRIPTIONS 
    FOR OWNER "mtroyano" 
    FROM PROJECT "MicroStrategy Tutorial";

Eliminar todas las suscripciones de un determinado informe o documento

DELETE ALL SUBSCRIPTIONS 
    FOR CONTENT ("NOMBRE_DOCUMENTO" IN FOLDER "RUTA") 
    FROM PROJECT "NOMBRE_PROYECTO";

Eliminar todas las suscripciones de una planificación

DELETE ALL SUBSCRIPTIONS 
    FOR SCHEDULE "NOMBRE_PLANIFICACION"  
    FROM PROJECT "NOMBRE_PROYECTO";