F-Script

F-Script Funktion: XCNT

XCNT

Notiz
Notiz
Zur Verwendung in F-Scipt Blöcken siehe hier: XCNT
Funktion
Parameter
Beschreibung
XCNT
Abfrage von Informationen über den Kontext in welchem das Script läuft.
busActive
Ist der Zugang zum BUS möglich? 0/1
boTypes
Alle BO-Typen durch Komma getrennt oder leer.
Achtung
Achtung
Dieser Parameter liefert alle beteiligten BO-Typen. Dies kann je nach Anwendungsfall problematisch sein.
Verwenden Sie anstelle von boTypes das Argument arg:BoType. (Siehe auch entsprechendes Argument beim Service Biz.System_RunScript.)
<BoType>
BoId des abgefragten BO-Typ oder leer.
# Beispiel
«XCNT(Addr)\A»
# Liefert die Adress Nr. (BoId) des BO-Typ Addr (Adresse),
# sofern dieser BO-Typ im Kontext aktiv ist.
Achtung
Achtung
Dieser Parameter liefert für das übergebene BO (Typ) die entsprechende BoId.
Verwenden Sie anstelle dieses Parameters das Argument arg:BoId. (Siehe auch entsprechendes Argument beim Service Biz.System_RunScript.)
Weitere Infos siehe hier:
Ausgeben des Kontext
Arbeiten mit Variablen
Informationen zum F-Script und zur Ausgabe, basierend auf den Subroutinen /GetInfoScriptArg und /GetInfoScriptCol
arg:ScriptName
Name des aktiven F-Script.
arg:PrinterNo
Nummer des Druckers bzw. Nummer der Druckersteuerung deren Einstellungen verwendet werden.
arg:OutputTypeCd
Ausgabetyp:
  • D - Drucker
  • F - File
  • B - Bildschirm
arg:OutputDevice
Name des Ausgabe-Device (Drucker oder Dateiname).
arg:NumberOfCopies
Anzahl Exemplare.
# Beispiel
«XCNT(arg:NumberOfCopies=<n>)»
# Übersteuert zur Laufzeit die Anzahl der zu druckenden Exemplare.
Indem die Anzahl Exemplare zur Laufzeit mit «XCNT(arg:NumberOfCopies=0)» explizit auf 0 gesetzt werden, kann die Ausgabe (Output) unterdrückt werden.
Im Falle von «XCNT(arg:NumberOfCopies=0)» erfolgt die Archivierung des Dokumentes in DMAS ebenfalls korrekt.
arg:PrintCollate
arg:PrintCollate=n
Collation-Einstellung
Abfragen bzw. Setzen der Collation-Einstellung. Mögliche Werte:
  • <leer> - gemäss den Einstellungen des Druckers (default)
  • 0 - false - Dokumente nicht sortieren (Seite 1+1, 2+2, 3+3)
  • 1 - true - Dokumente sortieren (Seiten 1-3, 1-3, 1-3)
arg:PrintFromPage
arg:PrintFromPage=n
Seite von
Abfragen bzw. Setzen der Seite von.
arg:PrintToPage
arg:PrintToPage=n
Seite bis
Abfragen bzw. Setzen der Seite bis.
arg:PrintAsPdf
Ausgabe als PDF.
  • 0 - Nein
  • 1 - PDF
  • 2 - PDF/A-1a
  • 3 - PDF/A-1b
arg:DuplexModeCd
arg:DuplexModeCd=n
Duplex-Modus
Abfragen bzw. Setzen des Duplex-Modus. Über den Duplex-Modus wird die beidseitige Druckausgabe bestimmt.
  • 0 - Standard: Duplex-Modus gemäss aktiver Einstellung beim Drucker.
  • 1 - Simplex: Ausgabe immer einseitig.
  • 2 - Long-Edge: Ausgabe beidseitig, über die lange Seite gedreht.
  • 3 - Short-Edge: Ausgabe beidseitig, über die kurze Seite gedreht.
arg:ImageDpi
arg:ImageDpi=n
Bild-DPI
Abfragen bzw. Setzen der Auflösung (DPI) für die Ausgabe von Bildern. Möglicher Wertebereich: 1 - 9999.
0 = Default (72 DPI). Der Defaultwert 0 wird berücksichtigt, sobald bei der Bild-Qualität ein Wert > 0 erfasst ist.
arg:ImageQuality
arg:ImageQuality=n
Bild-Qualität
Abfragen bzw. Setzen der Bild-Qualität (in %) für die Ausgabe von Bildern. Möglicher Wertebereich: 1 - 100.
0 = Default (50%). Der Defaultwert 0 wird berücksichtigt, sobald bei Bild-DPI ein Wert > 0 erfasst ist.
arg:BackgroundPdfModeCd
arg:BackgroundPdfModeCd=n
Abfragen bzw. Setzen des Hintergrund-PDF Modus.
  • 0 - Generell (Das Hintergrund-PDF wird beim Drucken und beim Archivieren verwendet.)
  • 1 - Nur Druck (Das Hintergrund-PDF wird nur beim Drucken verwendet.)
  • 2 - Nur Archivierung (Das Hintergrund-PDF wird nur beim Archivieren verwendet.)
arg:BackgroundPdfFirstPage
arg:BackgroundPdfLastPage
arg:BackgroundPdfOtherPages
Abfragen der aktuellen Hintergrund-PDF Einstellungen.
arg:BackgroundPdfFirstPage=...
arg:BackgroundPdfLastPage=...
arg:BackgroundPdfOtherPages=...
Setzen/Übersteuern der Hintergrund-PDF Einstellungen.
# Beispiel
«XCNT(arg:BackgroundPdfFirstPage=IP\BRIEFPAPIER.PDF)»
arg:LangNo
Sprachnummer
arg:BoType
BO-Typ gemäss des System_RunScript Aufrufs (z.B. AsstDoc).
arg:BoId
BoId gemäss des System_RunScript Aufrufs.
arg:BoOrganizerCd
Business-Object-Organizer
Beeinflussen der Priorität von Druck-Jobs, sofern via Print-Agent gedruckt wird.
Wichtig
Wichtig
Beachten Sie, dass die Priorität 99 die höchstmögliche Priorität ist. Druckaufträge mit Priorität 99 werden also vor Druckaufträgen mit Priorität 1 berücksichtigt.
Mögliche Werte für PrintJob.Priority sind 0 bis 99.
arg:PrintJobPriority
Abfragen der aktuellen Priorität des Druck-Jobs.
arg:PrintJobPriority=<0-99>
Setzen der Priorität des Druck-Jobs.
Beispiele
# Priorität abfragen:
«XCNT(arg:PrintJobPriority)»

# Setzen der Priorität mit Wert 2
«XCNT(arg:PrintJobPriority=2)»

# Blockscript Priorität abfragen:
XCNT.GetPrintJobPriority()

# Blockscript Setzen der Priorität mit Wert 0
XCNT.SetPrintJobPriority(0)
Freie Argumente und Attribute (basierend auf den Subroutinen /GetInfoScriptArg und /GetInfoScriptCol)
freeArgCount
Anzahl der Argumente basierend auf der Subroutine /GetInfoScriptArg
freeArg:<n>
Argument über dessen Nummer abfragen.
Liefert den vom Anwender eingegebenen Wert bzw. den im Script definierten Defaultwert zurück.
freeArg:<Name>
Argument über dessen Name abfragen.
Liefert den vom Anwender eingegebenen Wert bzw. den im Script definierten Defaultwert zurück.
freeArg:myArg>myVar
Direkte Übergabe eines Arguments in eine X-Variable.
Diese Funktionalität ist insbesondere beim Handling von Textblöcken mit mehr als 4096 Zeichen hilfreich.
Beispiele
«nXCNT(freeArg:MyArg1>MyXVar)»

«nXCNT(freeArg:1>MyXVar)»
colCount
Anzahl Attribute (Spalten) basierend auf der Subroutine /GetInfoScriptCol
colName:<n>
Name des Attributs über dessen Nummer abfragen.
colNo:<Name>
Nummer des Attributs über dessen Name abfragen.
colType:<n>
Datentyp des Attributs über dessen Nummer abfragen.
colType:<Name>
Datentyp des Attributs über dessen Name abfragen.
colActive:<n>
Status (aktiv/passiv) des Attributs über dessen Nummer abfragen.
colActive:<Name>
Status (aktiv/passiv) des Attributs über dessen Name abfragen.
scriptExecution=0|1|7|9
Setzen des F-Script Execution Mode.
0 - Setzt die F-Script Ausführung für die Laufzeit des F-Scrpts auf 0 - Legacy.
1 - Setzt die F-Script Ausführung für die Laufzeit des F-Scripts auf 1 - Restricted.
7 - Setzt die F-Script Ausführung für die Laufzeit des F-Scripts auf 7 - Whitelist.
9 - Setzt die F-Script Ausführung für die Laufzeit des F-Scripts auf 9 - Final.
Siehe Interpretieren von F-Script Befehlszeichen in Textblöcken für Details.
scriptStopOnError
scriptStopOnError=0|1
Abfragen der aktuellen Einstellung.
0 - Setzt zur Laufzeit des F-Scripts den Abbruch im Fehlerfall auf false/nein. Die Einstellung gilt auch für allfällig aufgerufene Sub-Scripts.
1 - Setzt zur Laufzeit des F-Scripts den Abbruch im Fehlerfall auf true/ja. Die Einstellung gilt auch für allfällig aufgerufene Sub-Scripts.
consumer:WindowsUser
consumer:WindowsDomain
consumer:Computer
consumer:Process
Informationen zu Windows-Benutzer, -Domäne, Computername und Prozess.
session:ClientNo
session:UserAddrNo
session:UserNo
session:UserGroupNo
session:UserAdminLevelCd
session:ImpersonatorNo (Leerstring, wenn keine Impersonation.)
session:UiLangNo
session:DataLangNo
Session-Informationen