Report
Report permet de lancer l'édition d'un état Crystal Report à partir d'un traitement.
Syntaxe
Report param = id_serveur with liste_param
Paramètres
Elément | Description | Restrictions |
param |
|
|
id_serveur | identification du serveur d'impression sous la forme : |
|
liste_param | Liste de id_param séparées par le caractère ','. | Les expressions doivent être alphanumériques et sont limitées à 255. |
id_param | chaîne de caractères sous la forme : | Les expressions doivent être alphanumériques et sont limitées à 255. |
Exemples
# lancement de l'état ITMMASTER.RPT
# sur le serveur d'impression mach1.domaine1
# avec sortie sur imprimante
# avec sélection des articles commençant par la lettre A
Local Char RETOUR(6)
Report RETOUR="mach1.domaine1@" With
& "__REPORT="+chr$(1)+"ITMMASTER.RPT",
& "__DESTINATION="+chr$(1) + "2",
& "__DBSERVER="+chr$(1) + "x73",
& "__DBPASSWORD="+chr$(1) + "PASSE",
& "__APPLICATION="+chr$(1) + "GX3APP;gailf40;1801",
& "__APPRPT="+chr$(1) + "GX3APP;gailf40;1801",
& "_PreVisuOptions="+chr$(1) + "11111111111111111111",
& "X3DOS="+chr$(1) + "GX3APP;gailf40;1801",
& "X3EDT="+chr$(1) + "Adonix",
& "X3ETA="+chr$(1) + "ITMMASTER",
& "X3TIT="+chr$(1) + "truc",
& "X3OPE="+chr$(1) + "Dupond",
& "itmrefdeb="+chr$(1) + "A",
& "itmreffin="+chr$(1) + "AZZZZZZZZZZZZZZZZZZZ"# impression d'une pièce jointe
Report "" With
& "__DOCUMENT="+chr$(1) + "C:\document.xls",
& "__APPLICATION="+chr$(1) + "GX3APP;gailf40;1801",
Description
L'instruction Report permet de lancer l'édition d'un état directement à partir d'un traitement. Elle permet depuis la version 130 d'imprimer une pièce jointe.
Les états se trouvent sur le serveur, dans le sous-répertoire ETA de l'application courante ou d'une des applications de référence. L'instruction Report met à niveau, si nécessaire, à partir de l'état du serveur, l'état sur le poste client dans le répertoire Application_Serveur_Port.
L'etat Crystal Report peut être soit :
- Pré-visualisé
- Imprimé directement
- Envoyé par la messagerie
- Sauvegardé dans un ficher
Si le serveur n'est pas renseigné, l'impression est envoyée sur le serveur courant.
L'élément param est un paramètre de sortie qui est valorisé avec le numéro de job affecté à la demande d'édition. Sa présence est facultative.
Les paramètres à renseigner peuvent être classés en trois catégories :
- système : nécessaire à l'appel de l'état Crystal Report
- standards : paramètres fonctionnels transférés à l'état. Ils sont disponibles sur tous les états.
- particuliers : paramètres fonctionnels transférés à l'état. Ils sont particuliers à chaque état.
Paramètres système :
Paramètre | Description | Valeur |
__REPORT | Nom de l'état Crystal Report |
|
__DESTINATION | Destination de l'impression | 0 = pré-visu |
__TYPDBA | Type de base de données | 1 = Oracle |
__DBSERVER | Source de données ODBC | paramètre ODBC du chapitre SUP |
__DBDATABASE | Nom de la base de donnée |
|
__DBUSER | Utilisateur de connexion à la base de données |
|
__DBPASSWORD | Mot de passe se connecter à la base de données |
|
__APPLICATION | Nom de l'application courante sous forme : | nomap;adxmac(-1);num$(adxtcp) ou |
__APPRPT | Nom de l'application ou sont les états sous forme : |
|
__REQUETE | Numéro de requête | uniqid([ARP]) |
__JOBLINKED | Numéro de la demande d'édition précédente | |
_DOCUMENT | nom de la pièce jointe | peut être sur client ex : c:\doc.xls |
_PreVisuOptions | Option pour la pré-visualisation | "11111111111111111111" |
_EMailToList | Destinataires pour le message |
|
_EMailCCList | Destinataires en copie pour le message |
|
_EMailSubject | Sujet du message |
|
_EMailMessage | Contenu du message |
|
_PrinterDriver | Driver d'imprimante |
|
_PrinterName | Nom de l'imprimante |
|
_PrinterPort | Port de l'imprimante |
|
_PrinterDescription | Description de l'imprimante |
|
_PrinterCopies | Nombre de copies |
|
_PrinterStartPage | Première page à imprimer |
|
_PrinterStopPage | Dernière page à imprimer |
|
_PrinterCollate | Mode de groupage |
|
_Orientation | mode portrait ou paysage |
|
_FormatExport | Format du fichier Exporté |
|
_ExportFile | Nom du fichier Exporté |
|
_FormatDelString | Délimiteur de string |
|
_FormatDelRecord | Délimiteur d'enregistrement |
|
_FormatFileHTML | Fichier HTML |
|
Paramètres standard :
Paramètre | Description | Valeur |
X3DOS | Nom de l'application courante sous forme : | nomap;adxmac(-1);num$(adxtcp) ou |
X3CLI | Intitulé du dossier X3 | [V]GRAISON |
X3EDT | Information de l'éditeur | mess(4,135,1)-mess(5,135,1) |
X3ETA | Nom de l'état Crystal Report | [F:ARP]RPTCOD |
X3TIT | Titre de l'état | [F:ARP]DES |
X3OPE | Opérateur de lancement de l'état | [F:AUS]NOMUSR |
X3SIT1 | Sites autorisés |
|
X3SIT2 | Sites interdits |
|
Remarques
Dans le traitement standard "ETAT" de lancement d'édition, le nom du serveur d'impression est alimenté par défaut par le paramètre SERIMP du chapitre superviseur, lorsque l'impression est envoyée sur imprimante.
les paramètres supplémentaires
__DOCUMENT pour les pièces jointes
_ExportFile
Pour __DESTINATION = 3 (c'est à dire fichier), le paramètre _ExportFile permet d'indiquer le nom du fichier résultat de l'export.
Pour __DESTINATION = 1 (c'est à dire Imprimante), alors l'impression ne sera pas envoyée physiquement sur l'imprimante identifiée par les paramètres "_PrinterDriver;_PrinterName;_PrinterPort;_PrinterDescription", mais elle sera dirigée dans le fichier spécifié par "_ExportFile" (fichier de types "Raw Printer data" d'extensions PRN ou PS), en s'appuyant sur le driver PCL ou PostScript identifié via les paramètres "_PrinterDriver;_PrinterName;_PrinterPort".
les pièces jointes
Pour une impression de pièce jointe, 2 paramètres sont nécessaires et obligatoires :
__DOCUMENT
__APPLICATION
Le paramètre _DOCUMENT ne peut contenir qu'une seule pièce jointe.
La syntaxe sur serveur NT est : \\serveur\chemin\document
La syntaxe sur serveur UNIX est : /répertoire/document (répertoire est l'arborescence sous le dossier)
Remarque : Une pièce jointe est imprimable si le programme associé permet l'impression.
Attention ! Actuellement, il n'est pas possible d'imprimer des pièces jointes quand on passe par un serveur d'édition. Autrement dit, pour des problèmes techniques, le serveur d'édition néglige l'argument "__DOCUMENT" de l'instruction Report.
Génération d'un fichier trace (disponible à partir de la 133)
Pour chaque demande d'édition avec une destination "Fichier" (Cf paramètre __DESTINATION), un fichier trace est généré en fin d'exécution de la demande dans le réperoire "Temp" du réperoire d'installation du poste client X3 (ou du serveur d'impression X3IMP). Ce fichier trace se nomme "reportjobstatus.njob", où njob correspond au numéro de job affecté à la demande d'édition (Cf description du paramètre "param"). S'il était déjà présent dans le répertoire "Temp", ce fichier trace est préalablement supprimé en début de soumission.
Si la taille de ce fichier est nulle, cela indique que la demande d'édition s'est correctement terminée. Dans le cas contraire, le fichier contient le message d'erreur associé au problème d'exécution détecté.
Ce fichier trace peut être exploité dans le cas d'éditions soumises en batch, ou en différée, pour contrôler la fin effective et le bon déroulement de l'exécution de la demande.
Evolutions
Pour des besoins de protocole, un chr$(1) est maintenant nécessaire devant la valeur de chaque paramètre.
Un paramètre s'exprime maintenant sous la forme :
"param="+chr$(1)+"valeur_param"
Mécanisme visant à garantir l'ordre de sortie d'un lot d'impressions chainées
Une demande d'impression chaînée ne sera exécutée qu'une fois la demande précédente terminée (qu'elle se soit terminée correctement ou en erreur).
Pour réaliser ce chaînage, on a ajouté dans le composant 15i.010, le paramètre __JOBLINKED à l'instruction L4G Report. La présence de ce paramètre valorisé avec le numéro de demande de l'édition chaînée fera, qu'en sus de son ordre d'arrivée, la demande ne sera exécutée qu'à partir du moment ou la demande liée se sera terminée.