FLSSRV - User Manual
Contents
1. 4 gS gt 4 set in the command line Example OVERLAY array LINE TRIANGLE LINE RECTANGLE Example for a OVERLAY RECTANGLE de limes flssrv RUN PORT TYPE STRING HELP Port number 17996 de limes flssrv RUN CLIENT YPE OBJECT HELP Client IPN Parameter de limes flssrv RUN CLIENT HOST YPE STRING HELP IP address localhost de limes flssrv RUN CLIENT PORT YPE STRING HELP Port number 17996 de limes flssrv RUN ROOTPATH TYPE STRING HELP Root path to use for local files de limes flssrv RUN HLEN TYPE NUMBER HELP Initial buffer length for header de limes flssrv RUN DLEN YPE NUMBER HELP Initial buffer length for data de limes flssrv RUN HANDLE CLIENT TYPE UMBER HELP How to handle client connection THREAD de limes flssrv RUN DAEMONIZE YPE SWITCH HELP run server in background OFF de limes flssrv RUN LOG TYPE OBJECT HELP Logging Parameter de limes flssrv RUN LOG MESSAGE TYPE OBJECT HELP Select type of messages to log AN de limes flssrv RUN LOG MESSAGE NONE TYPE SWITCH HELP2. SYNOPSIS HELP Show current properties PATH de limes flssrv TEXAS BUTILI IEN FUNCTION SYNTAX gt flssrv GETPROP command sjoreticlal D EPTH1 EPTH9 D EPALL D EFALL DESCRIPTION All or certain properties can be shown for a dedicated path The path is a dotted keyword list according to the syntax of the corresponding command command paral para2 para3 A help message for a certain parameter will also show the assigned property value See Appendix C for the current property file content OPTIONS DEPTH1 DEPTH2 DEPTH9 Specifies the depth of the output Default is DEPTHI DEPALL Shows all properties to the specified path not just DEPTH 1 DEFALL Shows all defined properties to the specified path EXAMPLES gt FLSSRV GETPROP gt FLSSRV GETPROP gt FLSSRV GETPROP gt FLSSRV GETPROP gt FLSSRV GETPROP command command DEFALL command para command para DEPALL FLSSRV User Manual 20 41 4 10 FUNCTION SETOWNER SYNOPSIS RELE Defines the current owner PATH de limes flssrv TERES PULT ST UNGT SYNTAX gt flssrv SETOWNER name DESCRIPTION The current owner id prefix or separation can be changed The owner concept is very powerful to separate different property settings You can run the same command with different properties simply by switching the owner The ow
3. STDENV DD gt FLSSRV CONFIG FILE GLOBAL FLSSRV CONFIG LANG de DE IBM 1141 HOME u hugo USER hugo Often it will be useful to have a dedicated environment per user on mainframes In such case it makes sense to define the environment in a dedicated file for each user STDENV DD DSN USER ENVIR amp SYSUID DSP SHR Beside all the environment variables managed by CLE you can also set all properties as environment variables to overrule the hard coded default values with CLP If a property defined as environment variable and over a property file then the value in the property file overrules the settings over the environment The environment variable name for each property are builded by the rules below convert all letters to upper case replace all dots by underline _ To get a list and help for all properties pleas use the built in function GENPROP to generate property files The properties can be defined per owner per program and general The owner specific definition overrules the program specific definition and the program specific definition overrules the general definition Examples CONV READ TEXT ENL2LF OFF in general the 0x15 to 0x25 conversion is off HUGO FLCL CONV READ TEXT ENL2LF ON for owner hugo the conversion is ont The value string behind the sign including the comment will be used as supplement for the command line processor Alia
4. flssrv OWNER oid command argument list MAXCC num flssrv OWNER oid command parameter file name MAXCC num I Beans une bfonsr aa be MS SS NES command pa En POEL O AD EO ee sellsisiay Eau Eonrendis edn DEP sos DeSTEG AGGJ ENTES flssrv MANPAGE function command path filename filename flssrv GENDOCU command path filename NONBR flssrv GENPROP command filename flssrv SETPROP command filename flssrv CHGPROP command path value flssrv DELPROP command IS SAGE ROA C Omman cl Paca EEE EH 25 5 IIPS IDET DE EPA GE flssrv SETOWNER name flssrv GETOWNER flssrv SETENV variable value flssrv GETENV flssrv DELENV variable flssrv TRACE ON OFF FILE filename flssrv CONFIG CLEAR flssrv GRAMMAR DES ES SABE ASS ENSIE ES SETER SION Elsser ANOUM ES SY ERRORS 2 4 HELP Here you can see the static main help for this program This content is printed on the screen if the built in function HELP is used without any further arguments Help for program flssrv Commands to execute powerful subprograms se EEES SE RUN run server FLSSRV User Manual 6 41 Built in functions to give interactive support for the commands above
5. OWNER PROGRAM COMMAND PROPERTY FILENAME If no home directory is defined then the current working directory is used as default directory to save the property files On mainframes SYSUID is used for the first level qualifier to represent the home directory Property files are managed per owner This means updates are only done for the current owner To delete a property you can simply specify the path without the root and with out a sign See Appendix C for the current property file content EXAMPLES FLSSRV CHGPROP command overlay object argument value FLSSRV CHGPROP command overlay object argument FLSSRV CHGPROP command object argument valuel argument value2 VEV 4 8 FUNCTION DELPROP SYNOPSIS HELP Remove a property file from configuration PATHE derlkmeseltssev Tre BUNT ENAB UN SIMON SYNTAX gt flssrv DELPROP command FLSSRV User Manual 19 41 DESCRIPTION Without a command the current global property file is deleted from the configuration data A command specific property file can be deleted from the configuration data when the command name is given Property files are managed per owner this means delete is only done for the current owner We recommend to work only with command specific property files See Appendix C for the current property file content EXAMPLES gt FLSSRV DELPROP gt FLSSRV DELPROP command 4 9 FUNCTION GETPROP
6. I EE ES SES NAS Provides the syntax for each command NES SVR ES Provides quick help for arguments flssrv MANPAGE Provides manual pages detailed help flssrv GENDOCU Generates auxiliary documentation flssrv GENPROP Generates a property file ES SS EP ROPE bid el oroS ney alle flssrv CHGPROP Change a property value in the currently active property file flssrv DELPROP Remove a property file from configuration flssrv GETPROP Show current properties me ES SS EMO NE Defines the current owner flssrv GETOWNER Show current owner setting ES SEAS EDEN Set an environment variable EE SV GENE NN Show the environment variables TED EEE SED BEEN Delete an environment variable Elsser AACS Manage trace capabilities ed ae slissiay COND IE Shows or clear all the current configuration settings flssrv GRAMMAR Shows the grammar for commands and properties Elssi v 10940 Shows the regular expressions accepted in a command flssrv LICENSE List license information for the program eey ARSON TNISEEVEers onginTFormatsonsrorschesprogram ES S VEAB OUN Show information about the program ee ESS EVE RRORS Show information about return and reason codes of the program For more information please use the built in function MANPAGE FLSSRV User Manual 7 41 Chapter 3 Available commands Commands are used
7. No message will be logged de limes flssrv RUN LOG MESSAGE ERROR TYPE SWITCH HELP Error message will be logged de limes flssrv RUN LOG MESSAGE ERRTRACE TYPE SWITCH HELP Error trace will be logged de limes flssrv RUN LOG MESSAGE WARNING TYPE SWITCH HELP Warning will be logged de limes flssrv RUN LOG MESSAGE NOTICE TYPE SWITCH HELP Notice will be logged de limes flssrv RUN LOG MESSAGE DEBUG TYPE SWITCH HELP Debug infos will be logged de limes flssrv RUN LOG MESSAGE ABOUT TYPE SWITCH HELP About infos will be logged de limes flssrv RUN LOG MESSAGE VERSION TYPE SWITCH HELP Version infos will be logged de limes flssrv RUN LOG MESSAGE INPUT TYPE SWITCH HELP Input data will be logged dangerous for passwords de limes flssrv RUN LOG MESSAGE PARAMETER YPE SWITCH HELP Parsed parameter will be logged de limes flssrv RUN LOG MESSAGE STATISTIC VEE SWil TCH AEB Status tale oso y ge gt de limes flssrv RUN LOG MESSAGE INFO TYPE SWITCH HELP Requested information will be logged de limes flssrv RUN LOG MESSAGE LICID TYPE SWITCH HELP License ID will be logged de limes flssrv RUN LOG MESSAGE LICENSE TYPE SWITCH HELP License summary will be logged de limes flssrv RUN LOG MESSAGE PROGRESS TYPE SWITCH HELP Progress bar will be logged de limes flssrv RUN LOG MESSAGE ALL TYPE SWITCH HELP All messages are logged de limes flssrv RUN LOG
8. 1141 gt FLSSRV SETENV LANG DE_DE UTF 8 FLSSRV User Manual 21 41 4 13 FUNCTION GETENV SYNOPSIS HELP Show the environment variables PATH de limes flssrv TERES BUILT IN FUNCTION SYNTAX gt flssrv GETENV DESCRIPTION This function lists all environment variables which are set within the configuration file for a certain owner All shown environment variables are placed in the environment table of the process Attention The environment variables will be temporary overwritten EXAMPLES gt FLSSRV GETENV 4 14 FUNCTION DELENV SYNOPSIS HELE Delete an environment variable PATH de limes flssrv TERES BUILT IN FUNCTION SYNTAX gt flssrv DELENV variable DESCRIPTION This function will delete environment variables from the configuration file for a certain owner EXAMPLES gt FLSSRV DELENV LANG 4 15 FUNCTION TRACE SYNOPSIS HELP Manage trace capabilities PATH de limes flssrv TR BUILT IN FUNCTION SYNTAX gt flssrv TRACE ON OFF FILE filename DESCRIPTION Tracing for command line parser and commands can be enabled or disabled A trace is only required to diagnose errors In such a case a trace file must be defined first then the trace can be activated the erroneous command executed and the trace file sent to the support team If no trace file is defined stdout stderr is used as default To pre
9. For each command execution you can define the owner and environment variables which are managed over the configuration file The default trace file is stdout If you activate the trace before a trace file is defined the trace will be printed on the screen Last but not least you can determine license version and other information about the program This is the RELEASE build version of the FLAMCLEP 1 1 USED ENVIRONMENT VARIABLES LANG to determine the CCSID on EBCDIC systems HOME to determine the home directory on UNIX WIN USER to determine the current user id on UNIX WIN OWNERID used for current owner if not already defined FLSSRV_CONFIG_FILE the configuration filename default is HOME fissrv config on UNIX WIN or amp SYSUID FLSSRV CONFI on mainframes FLSSRV DEFAULT OWNER ID the default owner ID default is de limes owner FLSSRV command PROPERTY FILENAME To overrule default property file names path_argument to overrule the hard coded default property value Environment variables can be set from the system or in the program configuration file with the build in function SETENV Es pecially on mainframe systems the configuration file is an easy way to define environment variables Additional on host the DD name STDENV is supported The DD STDENV allows you to define the FLSSRV_CONFIG_FILE FLSSRV DEFAULT OWNER ID LANG and other environment variables for example direct in your JCL FLSSRV User Manual 2 41
10. MQ Additionally it can act as a gateway to forward the client requests to another server Search requests for segments are also possible thereby making the limes access method network transparent The segements transferred on the network are compressed and encrypted by the client if this was requested This keeps control on the client side and reduces the amount of network traffic 2 2 1 USED ENVIRONMENT VARIABLES LANG to determine the default CCSID for this platform Format de DE UTF 8 e FLSSRV CONFIG FILE defines the config filename if not set default is flssrv config e FLSSRV DEFAULT OWNER ID defines the default owner ID if not set default is de limes The enviroment variables can be set over the system or over the FLSSRV config file with build in function SETENV Especially on mainframe systems the config file is a easy way to define environment variables for FLSSRV FLIES Frankenstein Limes Integrated Extended Security 2 3 SYNTAX Below you can see the main syntax for this program This content is printed on the screen if the built in function SYNTAX is used Each command can be entered as an argument list on the command line or in a parameter file To define a parameter file the assignment character must be used For an argument list a blank or if the command main table is of type overlay a dot or if the command is of type object a round bracket open must be given If the round bracket open is used th
11. data set name SYSUID FLSSRV CONFIG is used SYSUID as high level qualifier is a kind of replacement for the current home directory on distributed system in this case EXAMPLES gt FLSSRV CONFIG gt FLSSRV CONFIG CLEAR 4 17 FUNCTION GRAMMAR SYNOPSIS HELP Shows the grammar for commands and properties PATH de limes flssrv ENDS BUTLT IN FUNCTION SYNTAX gt flssrv GRAMMAR DESCRIPTION The grammar used for interpreting the command line and property files is shown This is helpful for under standing how the commands and property files are interpreted by the command line processor See Appendix B for an explanation and the output of this command EXAMPLES gt FLSSRV GRAMMAR 4 18 FUNCTION LEXEM SYNOPSIS FLSSRV User Manual 23 41 HELP Shows the regular expressions accepted in a command PATH de limes flssrv ENGER BUILT IN FUNCTION SYNTAX gt flssrv LEXEM DESCRIPTION The regular expression used for the tokens of the command syntax will be shown This could be helpful in understanding how the commands and property files are interpreted by the command line processor Moreover it will be shown how to define a number a string a keyword and other values inside a command See Appendix A for an explanation and the output of this command EXAMPLES gt FLSSRV LEXEM 4 19 FUNCTION LICENSE SYNOPSIS HELP List license information for th
12. for arguments PATH de limes flssrv TPB BUILT IN FUNCTION SYNTAX gt flssrv HELP command path DEPTH1 DEPTH9 ALL MAN DESCRIPTION The help function can provide extensive information about each parameter which is adjustable on the command line With the help functionality you get a structured list of arguments keyword the keyword for the argument e TYPE the type of this argument help message the short help text e PROPERTY the current hard coded property value optional The keyword can be abbreviated but it must be unique for this list The required letters are upper case if case sensitive mode is used With the case sensitive mode an additional line is required to mark the appropriate letter The path is a dotted keyword list in accordance with the syntax of the corresponding command command paral para2 para3 Help can also be used to show the corresponding detailed description of the manual pages with keyword MAN OPTIONS DEPTH1 DEPTH2 DEPTH9 Specifies the depth of the output Default is DEPTH1 ALL Shows complete help below specified path not just DEPTH1 and includes all aliases defined for a certain argument MAN Shows additionally the detailed description for this program command or parameter and the next level of arguments including the aliases EXAMPLES BLSSPKV HELP gt FLSSR
13. the command execution FLSSRV User Manual 34 41 Appendix E REASON CODES Below you can find the list of reason codes returned after command execution Each command returns a reason code for the corresponding warning return code 4 or error return code 8 This content is printed on the screen with the built in function ERRORS e Fatal error may not happen e 2 System error wrong size of data types e 3 Handle error not in right shape e 4 Interface error parameter incorrect e 5 Activity not possible e 6 Memory allocation failed not enough memory 7 Length error encountered unexpected length 8 Control code wrong 9 Version not supported 10 Function not supported 11 Mode not supported 12 Suite not supported 13 Confidentiality mode not supported 14 Integrity mode not supported 15 Verification mode not supported 16 Wrong header checksum 17 Wrong pot checksum 18 Wrong data checksum 19 Wrong checksum 20 Wrong message authentication code MAC 21 Wrong key test value 22 Syntax error file not formatted correctly FLSSRV User Manual 35 41 23 Count error supplied or calculated amount wrong 24 End of list handle points behind last or first element 25 Delete error element already deleted 26 Type error supplied or calculated type wrong 27 Rebuild required flush not possible 28 No change inform
14. to run powerful subprograms The command line processor compiles a table defined syntax in a correspond ing preinitialized data structure This structure will be mapped to the parameter structure of the corresponding subprogram The subprogram can be executed with the defined arguments parameters To support these variable commands several built in functions are available and described in the next section Each supported command is explained in a separate section in this document Each section contains a synopsis including the help message the path the type and the syntax followed by a detailed description If an argument of this command is an object or overlay or if a detailed description is available for this argument a separate section with synopsis help path type syntax and description is written otherwise a bullet list is printed which contains the keyword the syntax and the help message For the syntax of an overlay braces are used to keep all possible arguments of an overlay logically together These braces are not part of the real syntax The braces are only written to demonstrate clearly that one of these arguments must be selected with the DOT operator optional for defining the overlay To be compatible with certain shells the features below are implemented mm Strings can be enclosed with single or double quotation marks Integrated strings without spaces can also defined without quotes wow Keyw
15. 4 44044 Sram a he oe eS Y Re eee ne 13 4 Available built in functions 14 4 1 FUNCTION SYNTAX 22 Coon rear rea 14 42 BUNCTION HELP y fag sa wu wet eR ke GEA eek db er sa era Ea 15 4 3 FUNCTION MANPAGE 22 verre 16 4 4 FUNCTION GENDOCU 22 no onen 16 FLSSRV User Manual iv 4 5 FUNCTION GENPROP ooa n 4 6 FUNCTION SETPROP 2 Co om nn 17 4 7 FUNCTION CHGPROP m mm nn 18 4 8 FUNCTION DELPROP 2 Cm onen 18 49 FUNCTION GETPROP ooa 19 4 10 FUNCTION SETOWNER 2 0 mn 20 4 11 FUNCTION GETOWNER mm mn 20 4 12 FUNCTION SETENV oo om 20 4 13 FUNCTION GETENV 2 Coon zi 4 14 FUNCTION DELENV 2 Coon 21 4 15 FUNCTION TRACE 2 om mm zj 4 16 FUNCTION CONFIG 2 2 m mm 22 4 17 FUNCTION GRAMMAR 2 2 m m nenn 22 4 18 FUNCTION LEXEM oc men 2 4 19 FUNCTION LICENSE 2 2 m mm nn 23 4 20 FUNCTION VERSION ooo a 23 4 21 FUNCTION ABOUT 2 oo Corn 23 4 22 FUNCTION ERRORS u u ae un a Dos OE 4D RR os a 24 A LEXEM 25 B GRAMMAR 27 C PROPERTIES 29 D RETURN CODES 32 E REASON CODES 34 F VERSION 38 G ABOUT 39 5 Index 40 FLSSRV User Manual V Frankenstein Limes Integrated Extended Security FLIES Copyright limes datentechnik gmbh All rights reserved Trademarks Below you can find all trademarks or registered trademarks of limes datentechnik gmbh These trademarked terms are marked below with the appropriate symbol or TM indicating registered or common law trademarks owned by l
16. 5 Geschaeftsfuehrer Diplom Mathematiker Heinz Ulrich Wiebach limes datentechnik R efficiency at the limit of possibility
17. D EBCDIC CODE PAGES FOR COMMAND ENTRY MEM IL LO AB AA REM AA E MAS EM AA A BM ASA BM LAGT TBM EA TEM AS MI Me OF MSM aL ILE Sh 5 4 EBM aL IL Sy VING BM AA Walco BIST MMS MEMOS BUS za You can define the code page explicit LANG de_DE IBM 1141 or only the language code LANG de_DE LANG C If only the language code defined then the CCSID is derived from the language code DE IBM 1141 US IBM 1047 C IBM 1047 2 If it possible these critical characters are also converted for print outs At output it is not possible to convert anything correctly because some strings for print out are coming from other sources like system messages and others Only all known literals are converted for unknown variables such a conversion is not possible and CLEP expect that such strings are encoded in the correct system code page but we can not guaranty this On ASCH UTE 8 platforms a miss interpretation of punctuation characters smaller then 128 is not possible On such platforms the LANG variable is not used for command interpretation or printouts FLSSRV User Manual 4 41 Chapter 2 PROGRAM flssrv 2 1 SYNOPSIS HELPS FLIES Server Remote FLAM PATH de limes BRER PROGRAM SYNTAX gt flssrv COMMAND FUNCTION 2 2 DESCRIPTION The FLIES server allows remote read and write access to a FLAMARCHIVE file database VSAM by using a network connection with one of the supported protocols IP
18. E mylog3 txt Unix path name NAME lt HOME gt logs mylog4 txt Windows path name FLSSRV User Manual 13 41 ATTENTION Parallel process cannot share the same log file ARGUMENTS e NUMBER FORMAT STANDARD DIALOG Format of log message STANDARD STANDARD Standard logging format timestamp ident levelx message DIALOG For dialog processing ident levelx message e STRING IDENT str Ident of component for logging STRING NAME str Filename to append log messages stderr 3 1 11 OBJECT SYSTEM SYNOPSIS HELP Use system logging facility FATH RUN LOG DESTINATION INGA E OBJECT SYNTAX SYSTEM IDENT str DESCRIPTION The SYSTEM destination allows the log messages to be written to the logging system of the operating system On Unix and z OS systems the syslog call is used On Windows the event logging facility is used NOTE On Windows R this requires the registry key entry HKEY LOCAL MACHINE SYSTEM CurrentControlSet Services EventLog Application FLM This registry key will be created by using the DLL flevent dll ARGUMENTS e STRING IDENT str Ident of component for logging FLSSRV User Manual 14 41 Chapter 4 Available built in functions Numerous built in functions are available to obtain extensive help about syntax errors commands and func
19. EP value list EMPTY Glojeer Lise gt object SEP object list EMPTY ovanie dsc gt overlay SEP overlay_list EMPTY value gt NUMBER FLOAT STRING KEYWORD A list of objects requires parenthesis to enclose the arguments Property File Parser properties gt property_list property_list gt property SEP property_list EMPTY property gt keyword list SUPPLEMENT KEYTA ise gt KEYWORD keyword list FLSSRV User Manual 28 41 SUPPE KEYWORD EM ENT is a string in double quotation marks property FLSSRV User Manual 29 41 Appendix C PROPERTIES Below you can see the properties This content can be written to the global property file with the built in function GENPROP The first comment shows the valid root path for the property file A property file can contain properties for more than one root path The property file parser will only interpret properties where the root matches i e if the property file is assigned to a certain owner and possibly to a certain command then only properties for this owner the program itself and possibly the command will be accepted all other properties are ignored The second long comment gives some help for handling a property file Thereafter the generated properties for this root are listed for all supported commands The format is path SUPPLEMENT Type tttttt H
20. FLSSRV User Manual FLSSRV User Manual FLSSRV User Manual COLLABORATORS TITLE FLSSRV User Manual ACTION NAME DATE SIGNATURE WRITTEN BY limes datentechnik Aug 21 2015 gmbh REVISION HISTORY NUMBER DATE DESCRIPTION NAME 5 1 8 Aug 21 2015 released LDG FLSSRV User Manual ii Contents 1 COMMAND LINE PROCESSOR 1 1 1 USED ENVIRONMENT VARIABLES enken aan 1 12 FILENAME MAPPING erasana pen pper anea A een 2 1 3 SPECIAL EBCDIC CODE PAGE SUPPORT 3 2 PROGRAM fissrv 4 2 1 SYNOPSIS ut hd ar dedo bh dee Pe daw eee he dk Ger GE bek he ee 4 22 DESCRIPTION 2 4 a sh be GE bg Sr SS be KE be bags ee Greg din nd 4 2 2 1 USED ENVIRONMENT VARIABLES 2 2 CE a 4 23 ESYNTAR cz a dn a a aa ica a Ren A dd ee eo Ge SEG a ee 56 4 24 HEGRE ar ST NNN 3 3 Available commands 7 3 1 COMMAND RUN ice renses edga eee e e E E E akika e aek p a ik EE o a T 3 1 1 PARAMETER PORT rennene 8 3 1 2 OBJECT CLIENT 2 22 44 sense e Aa a a a a a e Ee a et 9 3 1 3 PARAMETER ROOTPATH mm nn nee 9 3 14 PARAMETER HANDLE CLIENT o 9 3 15 PARAMETER DAEMONIZE nn ee 10 3 1 6 OBJECT LOG s 2 acme ble na rs S dk sa Gre det bie 10 3 1 7 OBJECT MESSAGE revne 11 3 1 8 OVERLAY DESTINATION 2 0 ker e 12 3 19 OBJECT STREAM 1 ee 12 3 1 10 OBJECT FILE 2 224830 24 40 ae S r be eed EPA he a 12 3 1 11 OBJECTSYSTEM
21. H RUN TYPE OBJECT SYNTAX LOG MESSAGE DESTINATION DESCRIPTION The LOG parameter allows flexible adjustment for the logging of messages It is possible to specify the destination as well as which kind of message will be written For more information please have a look at the man pages for each parameter of LOG FLSSRV User Manual 11 41 3 1 7 OBJECT MESSAGE SYNOPSIS HELP Select type of messages to log ALL FAR RUN LOG TYPE OBJECT SYNTAX MESSAGE STATISTIC INFO LICID LICE NONE ERROR ERRTRACE WARNING NOTICE NSE PROGRESS ALL DEFAUL MINIMAL ERRONLY DEBUG ABOUT VERSION INPUT PARAMETE DESCRIPTION The log message specification is a classification of the messages to write to the selected log destination Each type is selectable individually by adding its argument inside this object For added convenience the special types NON ALL MINIMAL select the proper message types with just one argument If no message specification is given aDEFAULT is used which writes out messages of these types e ERROR e ERRTRACE e WARNING e NOTICE e PARAMETER e STATISTIC e INFO e LICID ARGUMENTS e SWITCH NONE No message will be logged e
22. IPTION The complete user manual is generated when only the filename is given If a command or command path is specified the corresponding section of the user manual is written to a file The generated files are in ASCIIDOC format to be readable as normal text document on all platforms and easily convertible into HTML PDF or other formats with ASCHDOC The numbering will vary in places where the complete manual uses a bullet list for arguments and constants when no detailed description is available and some of these arguments are required for the path The numbering can be disabled by setting the optional keyword NONBR This is useful if numbering is generated by a post processing utility for example pdflatex Do not use space characters between the key assignment character and filename EXAMPLES FLSSRV GENDOCU flssrv manual txt NONBR FLSSRV GENDOCU command command manual txt FLSSRV GENDOCU command argument argument manual txt We WE NYE FLSSRV User Manual 17 41 4 5 FUNCTION GENPROP SYNOPSIS HETER Generates a property file PATH de limes flssrv TSR 8 BUILT IN FUNCTION SYNTAX gt flssrv GENPROP command filename DESCRIPTION A property file is generated for all commands if only a filename is provided If a command is specified a property file for this specific command is created Property files can be used to define default settings for commands For each parameter a property ent
23. MESSAGE DEFAULT TYPE SWITCH HELP Relevant messages ar e logged de limes flssrv RUN LOG MESSAGE MINIMAL TYPE SWITCH HELP Important messages ar 4 gt FLSSRV User Manual 31 41 logged de limes flssrv RUN LOG MESSAGE ERRONLY TYPE SWITCH HELP Only errors and error trace are logged de limes flssrv RUN LOG DESTINATION TYPE OVERLAY HELP Destination for log messages de limes flssrv RUN LOG DESTINATION STREAM TYPE OBJECT HELP Log to a stream de limes flssrv RUN LOG DESTINATION STREAM FORMAT TYPE NUMBER HELP Format of log message STANDARD de limes flssrv RUN LOG DESTINATION STREAM IDENT TYPE STRING HELP Ident of component or Logging A i de limes flssrv RUN LOG DESTINATION STREAM STDOUT TYPE SWITCH HELP Log messages to stdout STDERR de limes flssrv RUN LOG DESTINATION FILE TYPE OBJECT HELP Log to a flat file de limes flssrv RUN LOG DESTINATION FILE FORMAT TYPE NUMBER HELP Format of log message STANDARD de limes flssrv RUN LOG DESTINATION FILE IDENT TYPE STRING HELP Ident of component tor logia 1241 i de limes f
24. PE VERS Oo semen Ja octal ratio rl Veh setkeaes Jae decimal awi O ERE hexadecimal num 0t yyyy mm tt hh mm ss relativ or absolut time LEAL lee digit digit e E digit decimal default gt ae aloe gekmepkes ars gekemes nes Sebkeyalic 8 ae decimal STRENG er ERE 77 default if binary c else s A LSS escorias e 7977 null terminated string gt Sur Kee om E O binary string in local character set FLSSRV User Manual 26 41 Str RSESEZZZE aanne e 47 bimamyesitiringseinz AS CH SE ESRA ers 77 binary string in EBCDIC SEG EMPATA EEE binary string in hex notation gt Strings can contain two to represent one Strings can also be enclosed in instead of Strings can directly start behind a without enclosing In this case the string ends at the next separator or operator and keywords are preferred To use keywords separators or operators in strings enclosing quotes are required SUPPLEMENT UV Renee TY null terminated string properties Supplements can contain two to represent one Supplements can also be enclosed in instead of FLSSRV User Manual 27 41 Appendix B GRAMMAR Below you can see the grammar used by the command line compiler This content is printed on the screen if the built in function GRAMMAR is used There ar
25. SWITCH ERROR Error message will be logged SWITCH ERRTRACE Error trace will be logged e SWITCH WARNING Warning will be logged e SWITCH NOTICE Notice will be logged SWITCH DEBUG Debug infos will be logged SWITCH ABOUT About infos will be logged SWITCH VERSION Version infos will be logged e SWITCH INPUT Input data will be logged dangerous for passwords e SWITCH PARAMETER Parsed parameter will be logged SWITCH STATISTIC Statistic will be logged SWITCH INFO Requested information will be logged SWITCH LICID License ID will be logged SWITCH LICENSE License summary will be logged SWITCH PROGRESS Progress bar will be logged SWITCH ALL All messages are logged SWITCH DEFAULT Relevant messages are logged SWITCH MINIMAL Important messages are logged SWITCH ERRONLY Only errors and error trace are logged FLSSRV User Manual 12 41 3 1 8 OVERLAY DESTINATION SYNOPSIS HELP Destination for log messages PATH RUN LOG TEORIER OVERLAY SYNTAX DESTINATION STREAM FILE SYSTEM DESCRIPTION The log destination parameter defines where the log messages will be written Each log message starts with the current time and date All the possible destinations allow to specify a custom identification string which will be printed after time and date of each message This is done with the IDENT argument If no IDENT specified t
26. V HELP MAN gt FLSSRV HELP command gt FLSSRV HELP command MAN gt FLSSRV HELP command ALL gt FLSSRV HELP command para gt FLSSRV HELP command para MAN gt FLSSRV HELP command para ALL FLSSRV User Manual 16 41 4 3 FUNCTION MANPAGE SYNOPSIS HETER Provides manual pages detailed help PATH de limes flssrv TENGS AS BULLT IN FUNCTION SYNTAX gt flssrv MANPAGE function command path filename filename DESCRIPTION Shows the manual pages of the program all commands and built in functions and if available for each argument up to selections constant definitions This function prints the corresponding section from the user manual on the screen doctype book If a filename is given then the doctype manpage of ASCHDOC is written to the file Do not use space characters between the key assignment character and filename The files in ASCHDOC format can be used to generate manpages with the tool ASCIIDOC EXAMPLES gt FLSSRV MANPAGE gt FLSSRV MANPAGE filename gt FLSSRV MANPAGE command gt FLSSRV MANPAGE command filename gt FLSSRV MANPAGE function gt FLSSRV MANPAGE function filename gt FLSSRV MANPAGE command para gt FLSSRV MANPAGE command para filename 4 4 FUNCTION GENDOCU SYNOPSIS HELP Generates auxiliary documentation PATH de limes flssrv EXA BUTLT IN FUNCTION SYNTAX gt flssrv GENDOCU command path filename NONBR DESCR
27. ason codes of the program PATH de limes flssrv NB BUILT IN FUNCTION SANTA SS VEROS DESCRIPTION This built in function prints explanations for the return condition exit codes of the executable and if available the reason codes of executed commands The command line executer CLE initialized the CLP structure Calls the command line processor CLP Calls the mapping function which converts the CLP structure in a corresponding command structure Then it runs the command and as last step it calls the finish function with the command structure to close all files and free all the allocated memory If one of these steps fails then a corresponding return condition exit code is given back from the executable Only the command execution can result in a error return code 8 or in a warning return code 4 The command it self must return a reason code for such a warning or error Means the return condition exit code can be used to control the batch processing The reason code gives more information about the error or warning See Appendix D and Appendix E for an explanation and the output of this command EXAMPLES gt FLSSRV ERRORS FLSSRV User Manual 25 41 Appendix A LEXEM The regular expressions used by the command line compiler are shown below This content is printed on the screen with the built in function LEXEM To describe the regular expression the following character classes are used e print all
28. ated size wrong 71 Invalid character encountered 72 Incomplete character encountered 73 Error with byte order mark BOM 74 Format wrong or not supported 75 Auto conversion not possible 76 Error from BZIP2LIB 77 Environment variable are not or cannot be defined 78 Dynamic load of a function failed 79 Access control or license violation 80 Compression limit not reached 81 Error from LXZ 82 Error from EXPAT 83 Whole first block is padding 84 Command line parser failed 85 Mapping failed 86 Open of temporary file failed 87 Wrong magic bytes 88 Corrupted FLAMFILE 89 Initialization error 90 Parameter not formatted correctly 91 Binary data detected 92 From and to are equal FLSSRV User Manual 37 41 93 Data is encrypted key required 94 Key value wrong 95 Reallocation required 96 Invalid username 97 Authentication failed 98 Hash calculation failed 99 Processing of one or more files failed 100 Hash checksum file is empty 101 Read of hash checksum file failed 102 Name of hash checksum file is not valid 103 Hash checksum file is not formatted correctly 104 Open of code table failed 105 Code table is not formatted correctly 106 Attribute settings not supported 107 Option wrong or not supported 108 Invalid parameter combination 109 Open of info file failed 110 Protocol wrong or not supported 111 Diff
29. ational 29 Status error handle not in right state 30 Orientation not supported 31 Split method not supported 32 Maximum delimiter amount achieved 33 Error at compression 34 Error at decompression 35 Maximum header length achieved 36 Maximum data length achieved 37 Open of FLAMFILE failed 38 Record format not supported 39 Writing to file failed 40 Reading from file failed 41 Get position of file pointer failed 42 Set position of file pointer failed 43 End of file informational 44 Rename of FLAMFILE failed 45 Delete of FLAMFILE failed 46 Close of FLAMFILE failed 47 Seek in file does not work 48 Set of buffer size for FIO failed 49 FLAMFILE format not supported 50 No FLAMFILE 51 No entry found 52 Construct is empty informational 53 Error of IP native function 54 Unsupported FLAM ID 55 Remote procedure call failed 56 Method not supported 57 Open of original file failed FLSSRV User Manual 36 41 58 Error from ZLIB GZIP 59 Character set not supported 60 Space too small 61 Logging facility not available 62 Error from character conversion module 63 Open of hash output file failed 64 Close of original file failed 65 Error with FKME 66 Error at character conversion 67 Info not supported 68 Band not supported 69 Open of report file failed 70 Size error supplied or calcul
30. d e Path names on mainframes must contain a least one slash Data set names on USS must start with Full qualified names with HLQ must enclose in apostrophes If apostrophes are not used the SYSUID is prefixed as HLQ e Normal file names on other platforms could be relative ATTENTION If a requested environment variable not defined the replacement is done with a empty string This could result in a unexpected behavior non To use a lt or as a part of a filename the character must be specified twice Beside this rules you can also use the replacement technologies of your shell but on some platforms HOME USER or something like this are not available for such cases the possibilities above are implemented This file name mapping is provided over the library CLEPUTL and should also be used for file names managed by the commands supported with this program 1 3 SPECIAL EBCDIC CODE PAGE SUPPORT To interpret commands correctly the punctuation characters below are on different code points depending on the EBCDIC CCSID used to enter these values CRITICAL PUNCTUATION CHARACTERS SHE 1 2 These critical characters are interpreted dependent on the environment variable LANG If the environment variable LANG is not defined then the compilation default CCSID f e IBM 1047 on USS and IBM1141 on ZOS is used Below you can find the current list of supported CCSIDs on EBCDIC systems SUPPORTE
31. e program PATH de limes flssrv ESPES BUILT IN FUNCILO SANTA ESS RV ENS E DESCRIPTION The license string of the software product is shown This string is provided to the command line executer CLE by the calling program and should reflect the current license text for this program EXAMPLES gt ELSSRV LICENSE 4 20 FUNCTION VERSION SYNOPSIS HELP List version information for the program PATH de limes flssrv TYPE BUILT IN FUNCTION SANTAS ES SE NVE ROTON DESCRIPTION The version of the software product is shown This string is provided to the command line executer CLE by the calling program and should reflect the current version information for this program See Appendix F for the output of this command EXAMPLES gt FLSSRV VERSION 4 21 FUNCTION ABOUT SYNOPSIS FLSSRV User Manual 24 41 HELP Show information about the program PATH de limes flssrv ENGER BUILT IN FUNCTION SYNTAX gt flssrv ABOUT DESCRIPTION Shows information about the software product like version copyright external libraries license and other attributes This string is provided to the command line executer CLE by the calling program and should reflect the current about information for this program fissrv See Appendix G for the output of this command EXAMPLES gt FLSSRV ABOUT 4 22 FUNCTION ERRORS SYNOPSIS HELP Show information about return and re
32. e two context free grammars one is used for the command line the other for the parameter file The parameter file contains mainly the same argument list as the command line The property file defines the default settings For this a different grammar is applied Properties can be set for each argument i e for arguments not used or arguments in overlays Based on that properties are set by using the path dotted keyword list A property is always a SUPPLEMENT for the argument list on the command line or parameter file Thus all defined properties have the same effect as arguments on the command line property sets this argument to the corresponding value if it is not defined on the command line Grammar for argument list parameter file or property file Command Line Parser command ea rameter aeS EK main object gt parameter main overlay parameter_list gt parameter SEP parameter_list EMPTY parameter gt switch assignment object overlay array Sven gt KEYWORD assignment gt KEYWORD value Goes gt KEYWORD parameter list KEYWORD STRING parameter file lt overlay gt KEYWORD parameter KEYWORD STRING parameter file Ebel KEYWORD TT alte last Et KEMNORDEAZEObI ECTS 4 4 KEYWORD NOV Srl lies 2 vals list gt value S
33. elp hhh hhh The path denotes the unique dotted keyword list for one argument The SUPPLEMENT is a string normally in double quotation marks containing the value list for this argument in accordance with the syntax of the command line parser strings then normally in single quotation marks a opposite usage of the quotation marks is possible but not recommended This means for example that a string that requires apostrophes must be included in apostrophes The supplement string is returned by the corresponding command line parser if no value for this argument is entered on the command line or is included in the parameter file Behind the property definition the type and help message are printed as comment to help in editing the generated property file The property values can be related to the current default settings at time of generation what means that if hard coded default values or another property file is already in use then these values are taken over into the new property file The property file can contain parameter which are not available on the command line Such parameter are only documented in the property file On the other side not all command line parameter are available as property If a description for a property argument is available which is not a part of the user manual this description is written as comment in front of the corresponding property definition Property file for de limes flssr
34. en the FLSSRV User Manual 5 41 corresponding round bracket close at the end of the command is mandatory The dot and parenthesis are in accordance with the normal syntax If an argument list is used all parameters argv are concatenated to one long string and this string is passed to the parser to allow usage of all features of the shell to build the command line input To make sure that anything you enter is passed one by one to the parser please use double WINDOWS UNIX or single z OS quotation marks at the beginning and end of the argument list If the dot for overlays or parenthesis for objects are used then the complete command must be included in double quotation marks The examples below show all possible command entries for the type object gt FLSSRV command temp dummy str gt FLSSRV command temp dummy str gt FLSSRV command temp dummy str gt FLSSRV command temp dummy str For a command of type overlay it looks like LSSRV command temp LSSRV command temp LSSRV command temp LSSRV command temp 131 Il Fl In VVV MV In a parameter file you can start with a dot for an overlay or with parenthesis for an object or with the argument overlay or argument list object directly SWE oz jowogieem Elsy Commands RUN
35. enerated with the built in function GENDOCU provided by the CLE P library by calling the command below flssrv gendocu flssrvbk txt Based on that the document is always in sync with the implementation but some redundancies are the result of such generated documentation This manual was designed as a reference book and in this context it is useful for a parameter to be described in all places where it is of relevance FLSSRV User Manual 1 41 Chapter 1 COMMAND LINE PROCESSOR This command line parser provides a list of commands and some built in functions please use MANPAGE HELP and SYNTAX to get extensive information about these capabilities Additional You can use the build in function GENDOCU to generate a complete or parts of the user manual To read the parameter of a command a compiler command line processor CLP is applied To see the regular expressions lexems and the corresponding grammar please use the build in functions LEXEM and GRAMMAR The return condition exit codes of the executable and the reason codes of the different commands can be reviewed with the built in function ERRORS See Appendix D and if available Appendix E for the meaning of the used return and reason codes The command line executer CLE uses an owner management in order to separate the settings for different clients and a property management for each command If problems occur you can activate a trace and manage all configuration settings
36. ents HOST and PORT The HOST argument is required and is the IP addres of the remote system where another FLIES Server is running The PORT argument defines the IP port number used by the remote server to listen for incoming connect requests If not spefified 17996 is used NOTE The host and port arguments must be specified as strings EXAMPLES BESSRV RUNKE IEC miter hose OZ EOS ES Sci ARGUMENTS e STRING HOST str IP address localhost e STRING PORT str Port number 17996 3 1 3 PARAMETER ROOTPATH SYNOPSIS HELP Root path to use for local files PATH RUN T PE STRING SYNTAX ROOTPATH str DESCRIPTION The ROOTPATH parameter allows to set the root directory for the server The directory specification in all requests received from a client will be regarded relative to this root directory If omitted the root directory will be set to the current working directory EXAMPLES FLSSRV RUN rootpath srv flam 3 1 4 PARAMETER HANDLE CLIENT SYNOPSIS HELP How to handle client connection THREAD PATH RUN EPE NUMBER SYNTAX HANDLE_CLIENT THREAD PROCESS DESCRIPTION The HANDLE_CLIENT parameter allows to define how the server will handle a client connection With each successful connect of a client the server ether starts a new thread or a new process to handle the requests of this client Usually a thread is started more quickly than a process but wil
37. erences found 112 Try again with an ASCII code page LATIN1 for read 113 Data incomplete FLSSRV User Manual 38 41 Appendix F VERSION Here you can see the version of the program and its components This content is printed on the screen if the built in function VERSION is used CORRETTE STS EVERI VERS TON ONS FO SB UTE DERE EA SEA uge 2 OS 20 ls FLSSRV User Manual 39 41 Appendix G ABOUT This is the about information for the program flssrv Its content is printed on the screen if the built in function ABOUT is used 00 Frankenstein Limes Integrated Extended Security Server FLIES R Server OL Hitt SS SEVER VERS LON cm orme 210827 PUND ERE KE AS BA UG OO AS Copyright C limes datentechnik R gmbh All rights reserved The FLIES R server is a convenient method to access a remote FLAMARCHIVE On LINUX systems we use additionally the glibc as part of the operating system FLIES R server is a work that uses the library glibc in unmodified form based on the LGPL license Copyright C 1991 2012 Free Software Foundation Inc More information to this license you can find under http www fsf org http www gnu org licenses lgpl 3 0 txt FLSSRV User Manual 40 41 Chapter 5 Index A Appendix About 39 Appendix Grammar 28 Appendix Lexem 26 Appendix Properties 31 Appendix Reasoncodes 37 Appendix Ret
38. he default will be owner program command If no log destination defined stream will be used as default 3 1 9 OBJECT STREAM SYNOPSIS HELP Log TO a stream PATH RUN LOG DESTINATION DURER OBJECT SYNTAX STREAM FORMAT STANDARD DIALOG IDENT str STDOUT DESCRIPTION The STREAM object allows the log messages to be written to the standard output or the standard error output Standard error output is used if STDOUT is not specified ARGUMENTS e NUMBER FORMAT STANDARD DIALOG Format of log message STANDARD STANDARD Standard logging format timestamp ident levelx message DIALOG For dialog processing ident level message STRING IDENT str Ident of component for logging SWITCH STDOUT Log messages to stdout STDERR 3 1 10 OBJECT FILE SYNOPSIS HELP Log to a flat file PATH RUN LOG DESTINATION TYPES OBJECT SYNTAX FILE FORMAT STANDARD DIALOG IDENT str NAME str DESCRIPTION The flat file option allows the log messages to be written to anormal file The name of the file must be specified for this destination The log messages will be appended to this file if it already exists For the log file all rules and replacements are valid which are described under FILENAME HANDLING above For example NAME MYLOG LOG1 EDS ROLE OS NAME lt SYSUID gt MYLOG0O2 PS dataset on z OS NAM
39. imes datentechnik gmbh at the time this information was published The following terms are trademarks of the limes datentechnik gmbh in Germany other countries or both limes datentechnik Company name of the owner of this document FLCL Frankenstein Limes Command Line FLCCO Frankenstein Limes Control Center FLAM Frankenstein Limes Access Method FLUC Frankenstein Limes Universal Converter FLIES Frankenstein Limes Integrated Extended Security FLAMFILE A file based on FLAM syntax Abstract This document provides information about using the Frankenstein Limes Integrated Extended Security FLIES Server It contains advanced guidelines and information to run this network server With the FLIES server FLAMFILES can be accessed over the net FLSSRV User Manual vi PREFACE The FLSSRV command line is implemented with the CLE P library The CLE P library was developed by limes datentechnik and released as open source under the ZLIB license CLE P is a compiler to provide a platform independent command line interface for each kind of batch processing environment The CLE P library provides a lot of features including all the built in functions below For example We use this library to automatically create this document as part of our build process If we add a parameter to the CLE P tables and build the FL5 project this manual will be regenerated as well in order to be always up to date This manual is g
40. l run in the same address space as other threads of the same process Handling client connections in processes needs more resources but is more secure than threads The decision how to handle client connections is dependent on the security requirements and the average traffic load the server must be able to handle EXAMPLES FLSSRV User Manual 10 41 FLSSRV RUN handle_client process SELECTIONS THREAD handle client connection in thread PROCESS handle client connection in process 3 1 5 PARAMETER DAEMONIZE SYNOPSIS EREB run server in background OFF PATH RU TAPRE SWITCH SYNTAX DAEMONIZE DESCRIPTION The DAEMONIZE parameter will cause the server to run as a UNIX daemon EXAMPLES FLSSRV RUN daemonize On WINDOWS this parameter has no effect To run the FLIES server as a WINDOWS service 2 utility programs are provided flsrun and flscontrol To install the FLIES server as a WINDOWS service LS ee must be executed once with system administrator privileges The service name of the FLIES server is FLM Control of this service can be done from the command line with flscontrol enable FLM flscontrol disable FLM Tis Eltcuas JPM flseontrol stop ELM flscontrol delete FLM to start stop enable disable or deleting the service This control is of course also possible with the WINDOWS service manager 3 1 6 OBJECT LOG SYNOPSIS HELP ogging Parameter PAT
41. lssrv RUN LOG DESTINATION FILE NAME TYPE STRING HELP Filename to append log messages stderr de limes flssrv RUN LOG DESTINATION SYSTEM TYPE OBJECT HELP Use system logging facility de limes flssrv RUN LOG DESTINATION SYSTEM IDENT TYPE STRING HELP Ident of component for logging FLSSRV User Manual 32 41 Appendix D RETURN CODES The return codes of the program are also called completion codes and returned at program termination This content is printed on the screen with the built in function ERRORS e 0 command line command syntax mapping execution and finish of the command was successful e 2 command line command syntax mapping execution was successful but cleanup of the command failed may not happened e 4 command line command syntax and mapping was successful but execution of the command returned with a warning e 8 command line command syntax and mapping was successful but execution of the command returned with an error e 12 command line and command syntax was OK but mapping of the parameter for command execution failed e 16 command line was OK but command syntax was wrong error from command line parser 20 command string was wrong please use built in function SYNTAX for more information e 24 initialization of the parameter structure for the command failed may not happened 28 configuration is wrong determination of configuration data failed configura
42. ner is a general solution to separate all settings and can be used for environment client and other purposes If not already defined the owner is written to the environment table under the key word OWNERID This environment variable can for example used as replacement in file names lt OWNERID gt dat or to refer a signature key EXAMPLES gt FLSSRV SETOWNER com company 4 11 FUNCTION GETOWNER SYNOPSIS HELP Show current owner setting PATH de limes flssrv EINGEBEN BUILT IN FUNCTIO SYNTAX gt flssrv GETOWNER DESCRIPTION The current owner id prefix for separation will be shown The owner concept allows to manage different configurations as alogical separation of what is done with this id EXAMPLES gt FLSSRV GETOWNER 4 12 FUNCTION SETENV SYNOPSIS HEGER Set an environment variable PATH de limes flssrv NBI BUILT IN FUNCTION SYNTAX gt flssrv SETENV variable value DESCRIPTION This function allows to set environment variables within the configuration file for a certain owner All defined environment variables are placed in the current environment table of the process before a command is executed Do not use space characters between the key assignment character and value Attention The environment variables will be temporary overwritten EXAMPLES gt FLSSRV SETENV LANG DE_DE IBM
43. nual page for a parameter please use FLSSRV MANPAGE RUN parameter parameter To generate the user manual for the RUN command use FLSSRV GENDOCU RUN filename Parameters can be defined by the command line directly or per file or by properties read from the corresponding property file EXAMPLES FLSSRV RUN rootpath srv flam FLSSRV RUN handle client process ARGUMENTS NUMBER HLEN num Initial buffer length for header e NUMBER DLEN num Initial buffer length for data 3 1 1 PARAMETER PORT SYNOPSIS HELP Port number 17996 PATH RUN TAPER STRING SYNTAX PORT str DESCRIPTION The PORT parameter allows to set the IP port number the server will listen on for incoming connection requests If not specified the default port 17996 is used NOTE The port number has to be specified as a string EXAMPLES FLSSRV RUN port 3192 FLSSRV User Manual 9 41 3 1 2 OBJECT CLIENT SYNOPSIS HELE Client IPN Parameter PATH RUN TAPE OBJEC SYNTAX CLIENT HOST str PORT str DESCRIPTION The CLIENT parameter determines where to forward incoming requests to If specified the server acts as a gateway and will forward all requests received from a client to another server and all answers from this other server are send to the requesting client This is transparent for the client The CLIENT parameter is an object with 2 argum
44. ords can also start with or in front of the qualifier e If it unique then parenthesis and the dot can be omit for object and overlays Commands can be declared in deep hierarchical depth In order to simplify their handling the path is a powerful instrument for managing only relevant parts of it Because of that the path is printed for each synopsis To run commands under different owners the owner id can be defined in front of the command For job control the maximum condition code MAXCC num of the command execution can optionally be set as the last parameter for each command flssrv OWNER oid command argument list MAXCC num flssrv OWNER 0id command parameter file name MAXCC num The parameter for each command can be provided as argument list on the command line or as parameter file 3 1 COMMAND RUN SYNOPSIS FLSSRV User Manual 8 41 HELP run server PATH de limes flssrv TYPES OBJECT SYNTAX gt flssrv RUN PORT str CLIENT ROOTPATH str HLEN num DLEN num HANDLE CLIENT gt THREAD PROCESS DAEMONIZE LOG DESCRIPTION The RUN command must be used to to execute the FLIES server It is an object containg all parameters needed to configure its behaviour To run the server with default values FLSSRV RUN is sufficient To get help for a parameter use FLSSRV HELP RUN parameter parameter To read the ma
45. perties of a command can be updated at once by separating them with a space character please do not use spaces between key assignment character and the value This set of properties is parsed by the CLP If no property is provided the property file for the command is either parsed or generated if it does not exist and then activated without updating properties This behavior can be used to generate and activate command specific property files for the different commands The built in function reads and parses the currently active property file Then it parses the provided property list and writes the updated property file back to disk The currently active property file could be a global not command specific property file In such a case a new command specific property file is generated and activated Properties from the global property file are copied into the newly generated one If no property file is defined see SETPROP that corresponds to the owner program and command a property file is generated The filename formats below are used to read or write property files from to the home directory On non mainframe systems WINDOWS UNIX MAC owner program command properties On mainframe systems ZOS VSE BS200 lt SYSUID gt OWNER PROGRAM COMMAND PROPS If the default filenames and or path are not sufficient you can change the filename of each property file by setting environment variables using the following naming convention
46. printable characters e space all blanks tabs and new lines e cntr all control characters e alpha all letters e alnum all letters and digits 0 9 e digit all decimal numbers 0 9 e xdigit all hexadecimal numbers All comments and separators are ignored by the scanner and not passed with the token to the parser This means the separators SEP are used in the grammar but will never be part of or own tokens If a binary entry for a string is possible and no classification is done it is taken as a binary string in local character set repre sentation c without null termination This default can be changed In this case the help message for this argument should be described the default interpretation of the binary string For binary strings it is still possible to enter a null terminated string but then the prefix s must be used If no binary entry is feasible only a null terminated string in local character representation s can be built and taken per default Lexemes regular expressions for argument list or parameter file COMMENT Daal leas a Tr will be ignored E COMMENT enl will be ignored OR PARATOR ES paco Ene RE abbreviated with SEP OLE RATO YS f 75 90 I eye FE GAGE SEN ED O ERE ORRE O me BONES BE KEYWORD Le 4 J a A eo ee SES always predefined NUMBER isl orblejae e 1147 decimal default ALI ar Os sebes Ns binary Sal
47. property file but there will be no effect until you change the settings inside the property file because the current default settings are written The file name can contain replacement mapping rules lt HOME gt lt USER gt Do not use space characters between the key assignment character and filename We recommend to work only with command specific property files because the built in function CHGPROP can be used to generate update and activate a property file for a certain command See Appendix C for the current property file content EXAMPLES gt FLSSRV SETPROP general properties gt FLSSRV SETPROP command command properties FLSSRV User Manual 18 41 4 7 FUNCTION CHGPROP SYNOPSIS HELP Change a property value in the currently active property file PATH de limes flssrv TSR 8 BUILT IN FUNCTION SYNTAX gt flssrv CHGPROP command path value DESCRIPTION The built in function CHGPROP updates property values in the currently active see SETPROP property file for a dedicated command If no property file is activated a property file is generated see GENPROP updated with the provided property list and activated see SETPROP The first argument of CHGPROP is the command name All other arguments are key value pairs of properties that should be updated The key is internally prefixed with the root owner program command The values are enclosed in double quotation marks Multiple pro
48. ry is written to a text file The text file contains comments to help in editing the properties A property file can be activated with the built in function SETPROP Property files will be activated by their owner A property file overrules hard coded properties and properties defined over environment variables A specific property file overrules the general property file At time of generation all current default settings are written to the property file We recommend to work only with command specific property files because the built in function CHGPROP can be used to generate update and activate a property file for a certain command Do not use space characters between the key assignment character and filename To optimize the program performance one can remove all unnecessary properties See Appendix C for the current property file content EXAMPLES gt FLSSRV GENPROP owner general properties gt FLSSRV GENPROP command owner command properties 4 6 FUNCTION SETPROP SYNOPSIS HELP Activate a property file PATH de limes flssrv TEN S BUILT IN FUNCTION SYNTAX gt flssrv SETPROP command filename DESCRIPTION The file name is set as current global property file when no command is specified The file name is set as current local property file when a command is given The property file can be generated with GENPROP and will be activated for the current owner After generation you can activate the
49. ses are not supported in this case You can only define properties for the main argument If a string must be enclosed with apostrophe please don t use double quotation marks because these are used additional if a new property file build based on the environment settings FLCL ICNV FROM IBM 1141 this is the best solution FLCL ICNV TO UTF 8 UTF 8 could result in errors See Appendix C for the current property file content 1 2 FILENAME MAPPING All filenames used by CLEP are additionally mapped based on the rules below The tilde character is replaced with the string lt HOME gt Each value enclosed with angle brackets lt gt are replaced with the corresponding environment variable lt OWNERID gt If the environment variable not defined the replacements below are still possible lt S Y SUID gt Current user id in upper case lt USER gt Current user id case sensitive lt CUSER gt Current user id in upper case lt SYSUID gt lt Cuser gt Current user id in title case lt cuser gt Current user id in lower case lt HOME gt Replaces with the users data directory if this not available the replacements below are done x On UNIX with home lt USER gt FLSSRV User Manual 3 41 On USS with u lt USER gt x On ZOS with lt SYSUID gt DD names on mainframes must be prefixed with DD Data set names on mainframes are always full qualifie
50. tion file might be damaged 32 table error something within the predefined tables is wrong internal error 36 system error e g memory allocation failed 40 access control or license error e 44 interface error e g parameter pointer equals NULL only at call of subprogram interface 64 fatal error basic things are damaged e gt 64 special condition codes from the command for job control The command line is interpreted by CLE the command string by CLP For example gt flcl conv read file test txt write flam file test adc the command string is compiled by CLP and might result in a syntax error conv is part of the command line flel is part of the command line eee one parat para txt is part of the command line but the content of para txt might contain a CLP syntax error conv is part of the command line flel is part of the command line FLSSRV User Manual 33 41 A command execution run will return 0 on success 4 if a warning occurs 8 in case of an error or special condition codes greater then 64 can be returned If the command execution was successful return code 0 a return code of 2 indicates that a call to the finish function failed Such a fail of the finish function is not recognizable if the run function command execution returns with a warning or an error All completion codes bigger than 8 and smaller or equal to 64 indicate an error in front of
51. tions of a program with help messages manual pages and documentation Other built in functions can be used for owner property environment and trace management All built in functions have the purpose to simplify handling of powerful and sometimes complex commands 4 1 FUNCTION SYNTAX SYNOPSIS HELP Provides the syntax for each command PATH de limes flssrv TNS BULDISIN FUNCTION SYNKER Srey NDA Common O DEIA 4 5 DEE OA DESCRIPTION The syntax function shows how the arguments can be set on the command line Depending on depth the syntax is printed in one line or in structured form structured print out means that you have a question or exclamation mark before the argument e question mark optional parameter exclamation mark required parameter The path is a dotted keyword list in accordance with the syntax of the corresponding command command paral para2 para3 OPTIONS DEPTH1 DEPTH2 DEPTH9 Specifies the depth of the output Default is DEPTHI If the depth is greater than 1 the structured print out is used ALL Shows complete syntax for the specified path not just DEPTH1 Structured print out is used EXAMPLES FLSSRV SYNTAX LSSRV SYNTAX command LSSRV SYNTAX command ALL LSSRV SYNTAX command para LSSRV SYNTAX command para ALL Wh WENA NE NG H E E E FLSSRV User Manual 15 41 4 2 FUNCTION HELP SYNOPSIS HELP Provides quick help
52. urncodes 33 Appendix Version 38 Argument CLIENT 9 Argument DAEMONIZE 10 Argument DESTINATION 12 Argument FILE 13 Argument HANDLE_CLIENT 10 Argument LOG 10 Argument MESSAGE 11 Argument PORT 8 Argument ROOTPATH 9 Argument STREAM 12 Argument SYSTEM 13 Available built in functions 14 Available commands 7 B Built in function ABOUT 24 Built in function CHGPROP 18 Built in function CONFIG 22 Built in function DELENV 21 Built in function DELPROP 19 Built in function ERRORS 24 Built in function GENDOCU 16 Built in function GENPROP 17 Built in function GETENV 21 Built in function GETOWNER 20 Built in function GETPROP 19 Built in function GRAMMAR 22 Built in function HELP 15 Built in function LEXEM 23 Built in function LICENSE 23 Built in function MANPAGE 16 Built in function SETENV 20 Built in function SETOWNER 20 Built in function SETPROP 17 Built in function SYNTAX 14 Built in function TRACE 21 Built in function VERSION 23 C Command line processor 3 COMMAND RUN 8 D Description for program fissrv 4 H Help for program flssrv 6 S Synopsis for program flssrv 4 Syntax for program fissrv 5 FLSSRV User Manual 41 41 COLOPHON limes datentechnik R gmbh Louisenstrasse 21 D 61348 Bad Homburg v d H phone 49 0 6172 5919 0 fast AMD ELV2 59G19 350 mail info flam de web www flam de or www limes de Amtsgericht Bad Homburg vor der Hoehe HRB 3288 gegr 198
53. v The property file can be used to overwrite the default values used if the argument is not defined on the command line The values is assigned between conforming to the syntax Example NUMBER Ra AS Hemp SES IRAN CRA SS OSOS RO Example FLOAT array gt 123 32 AS EE MPN es Cons PENE The last example shows that one can use key words if a list of constants is defined for this argument FLSSRV User Manual 30 41 Foren OG that this command 1 line For Ap OY on the command lin Examples for an OBJECT For a SWITCH one can us disable the SWITCH or defin Examples for a SWITCH J th special key words ON OFF to enable or cla lu Va ECT only the special key word INIT can b as a number VON W V ORE MATO us OBJECT will be initialized if it was not set ine then th TENNE sno Eser will be initialized only if you type at least obj If you want an object to be initialized when you then th lements of ERLAY it is of the element to ini in ele o ns on the the special key word must be set WATT OBJE the command don t use it the same logic as for objects but the keyword tialize must be used if the overlay is not TE em
54. vent tracing on the screen please define a trace file first before tracing is switched on Do not use space characters between the key assignment character and filename EXAMPLES gt FLSSRV TRACE FILE filename gt FLSSRV TRACE ON gt FLSSRV TRACE OFF FLSSRV User Manual 22 41 4 16 FUNCTION CONFIG SYNOPSIS HETE Shows or clear all the current configuration settings PATH de limes flssrv TENGS BULLT IN FUNCTION SYNTAX gt flssrv CONFIG CLEAR DESCRIPTION The actual configuration list with owner id property file names trace setting environment variables and more are shown With the option CLEAR the configuration data including the corresponding file will be deleted The configuration file name can be defined by the environment variable FLSSRV_CONFIG_FILE config file name This can be used to work with a global configuration file If this location not defined then the configuration file are stored on distributed systems in the current home directory under the file name flssrv config If no home directory defined for the current user this case is very improbable then the working directory is used To read the configuration file and the environment variable above is not defined CLE looks first in the working and then in the home directory This enables you to prefer a property file by coping it to the current working directory On mainframes as default the
Download Pdf Manuals
Related Search