Environment variables
The following overview shows all environment variables used in i-effect and explains their use and meaning.
Name | Level | Function | Value |
|---|---|---|---|
IEFFECT_<Befehl>_RESULT | *JOB | For the commands listed below, an environment variable is set at the end of a function call, from which it can be derived whether the call was successful or not. *OK The call was successful *ERROR An error occurred during the call ADDARCHIVE, ARCPDF, CRTARCHIVE, CVTARCHIVE, DLTARCHIVE, ENCRYPT, DECRYPT, CRTOCSP, EXTARCHIVE, EXTFILEPDF, RCVEMAIL, RCVFTP, RUNMAP, RUNREPORT, SIGNQDATA, SIGNXML, SNDAS2, SNDEMAIL, SNDFTP, SNDHTTP, STRGZIP, STROFTP2, STRPGP, STRSOACLT, VERIFYPDF, MRGFILEPDF, OFTP2CRTX | *OK *ERROR |
IEFFECT_AUTOSTARTSBS | *SYS | Determines whether a non-running i-effect subsystem is started automatically. *YES The subsystem is started if it is not yet active. *NO The subsystem is not started automatically. This environment variable can be used to prevent subsystems from starting when changes are made to the configuration. | *YES *NO |
IEFFECT_COMMAND | *JOB | An internal environment variable of i-effect. It contains the hex-coded name of the last i-effect command used with all its parameters. IEFFECT_COMMAND1 is also used if the length of the command and its parameters exceeds 1024 bytes. | |
IEFFECT_COMMANDNAME | *JOB | The name of the last i-effect command used. | RUNMAP |
IEFFECT_CORRECT_XML_CLRF | *JOB | Remove first occurring CRLF in file. Hotfix for RPLSTRIFS to handle this special case:
CODE
| *YES |
IEFFECT_EMAIL_MSGTEXT | *JOB | Can contain a text that is automatically used as message text by an SNDEMAIL. | ‘Text’ |
IEFFECT_ERRORWORKFLOW_SERVERENTRY | *JOB | Automatically starts the ServerTask specified in the environment variable when a session is cancelled. | 1510 |
IEFFECT_FTP_DELAY | *JOB | Number of seconds to wait between individual FTP transfers. | 60 |
IEFFECT_FTP_REPLACE | *JOB | An existing file is not replaced on the target system in an FTP transfer if this variable is set | *NONE |
IEFFECT_VxRyMz_FTP_SINGLE_RECEIVE | *JOB | The connection is re-established before each transmission if this variable is set | *YES |
IEFFECT_MESSAGEKEY | *JOB | Internal variable. Contains the message key of the first i-effect message after a session start | |
IEFFECT_PARAMETERSETS_SERVERENTRY | *JOB | The environment variable IEFFECT_PARAMETERSETS_SERVERENTRY defines the default settings for the WRKEFSPLF dialogue and for WEBCONTROL spool processing. For this purpose, the corresponding default settings for the individual processing operations are defined in an I-EFFECT server task. The number of the corresponding server task (*SINGLE/*SPOOL) is entered as the value in the environment variable. This means that an entry for *CONVERT/*SPOOL/*PDF in the server task can be used to define the default values for PDF generation from spools.
CODE
| 9999 |
IEFFECT_PGM | *JOB | Internal variable. Name of the last i-effect process started | SNDEMAIL |
IEFFECT_RGZPFM_LOGFILES | *JOB | Overwrites the parameter RGZPFM() in STREFREORG and can thus force the reorganisation of files in the reorg, even if the parameter was not switched on when the reorganisation was started. | *YES |
IEFFECT_RPLSTRIFS_USEBUFFER | *JOB | Forces RPLSTRIFS to use a larger buffer for processing. This accelerates the processing speed for large amounts of data. | *YES |
IEFFECT_RPLSTRIFS_USESEPCHAR | *JOB | Instructs RPLSTRIFS to use a record separator other than the line feed character | | |
IEFFECT_RUNNINGVERSION | *JOB | Internal variable. Contains the i-effect release of the last i-effect command called | V3R1M0 |
IEFFECT_SAVSESNR | *JOB | (Obsolete). Replaced by IEFFECT_SESSION. | 4354 |
IEFFECT_SERVER_CHECKINUSE | *JOB | Specifies whether to check whether a file in the IFS that is to be processed in a server task is currently being used. The default value is *YES | *YES *NO |
IEFFECT_SERVER_ENVVAR | *JOB | (Obsolete). Replaced by %GETENVVAR:<name>% | |
IEFFECT_SERVER_ERROR | *JOB | This environment variable can be used in the i-effect server to continue processing when an error occurs. If this variable is set to *IGNORE, the defined error processing is executed, but processing is then continued. With *IGNORE_WITH_ERROR_WORKFLOW, error handling in the *ERROR workflow is also skipped. | *IGNORE *IGNORE_WITH_ERROR_WORKFLOW |
IEFFECT_SERVER_WORKFLOW | *JOB | This environment variable can be used in the i-effect server to skip all subsequent workflow processing. If this variable is set to *IGNORE, the subsequent workflow processes are not executed. To restore the standard behaviour after a processing step, the environment variable must be deleted again. | |
IEFFECT_SERVER_WORKFLOW_LOG | *JOB | This environment variable can be used in an EMAIL/SEND workflow with MSGTEXT(%STATUS%) to automatically attach all log files from the "/home/ieffect/internal" directory of the affected session in the event of an error. | *ADD |
IEFFECT_SESSION | *JOB | Session number of the last session started. | 4758 |
IEFFECT_SESSIONREADJOBLOG | *JOB | Determines whether messages that were not written by i-effect are also read from the job log. Normally, such messages are only included in the i-effect logbook in the event of an error. | *YES |
IEFFECT_VxRyMz_LNGCATALOG | *SYS | Name of the catalogue with the language objects of the specified i-effect version | IBMIDB |
IEFFECT_VxRyMz_LNGDEVICE | *SYS | Name of the IASP unit or *SYSBAS with the language objects of the specified i-effect version | *SYSBAS |
IEFFECT_VxRyMz_LNGSCHEMA | *SYS | Name of the schema with the language objects of the specified i-effect version | IEF31024 |
IEFFECT_VxRyMz_LNGSYSBASLIB | *SYS | Name of the schema with the Sysbas language objects of the specified i-effect version | IEF31024S |
IEFFECT_VxRyMz_PRIMARY_LANGUAGE | *SYS | The i-effect primary language of the specified i-effect version | 2929 |
IEFFECT_VxRyMz_SECONDARY_LANGUAGE | *SYS | The i-effect secondary language of the specified i-effect version | 2924 |
IEFFECT_VxRyMz_APPCATALOG | *SYS | Name of the catalogue with the application objects of the specified i-effect version | IBMIDB |
IEFFECT_VxRyMz_APPDEVICE | *SYS | Name of the IASP unit or *SYSBAS with the application objects of the specified i-effect version | *SYSBAS |
IEFFECT_VxRyMz_APPSCHEMA | *SYS | Name of the schema with the application objects of the specified i-effect version | IEFFECT |
IEFFECT_VxRyMz_DBCATALOG | *SYS | Name of the catalogue with the database objects of the specified i-effect version | IBMIDB |
IEFFECT_VxRyMz_DBDEVICE | *SYS | Name of the IASP unit or *SYSBAS with the database objects of the specified i-effect version | *SYSBAS |
IEFFECT_VxRyMz_DBSCHEMA | *SYS | Name of the schema with the database objects of the specified i-effect version | IEFFECTDB |
IEFFECT_VxRyMz_DEBUG | *SYS | Additional information is output to the logbook when this environment variable is set. *INFO - Output of extended information messages *DEBUG - Output of detailed debugging information. | *NONE |
IEFFECT_VxRyMz_IFS_DEVICE | *SYS | Name of the IASP unit or *SYSBAS with the IFS objects of the specified i-effect version | *SYSBAS |
IEFFECT_VxRyMz_IFS_PATH | *SYS | Name of the IFS programme directory of the specified i-effect version | /i-effect/v3r1m0 |
IEFFECT_VxRyMz_JAVA_HOME | *SYS | Path to the JAVA Runtime that is used in the specified i-effect version | /QOpenSys/QIBM/ProdData/JavaVM/jdk80/64bit /QOpenSys/QIBM/ProdData/JavaVM/jdk80/32bit |
IEFFECT_VxRyMz_JVMCLIENT | *SYS | Intern Variabel. | |
IEFFECT_VxRyMz_PRVCATALOG | *SYS | Internal variable. Is set during an i-effect upgrade to retain the name of the catalogue of the previous version | IBMIDB |
IEFFECT_VxRyMz_PRVDEVICE | *SYS | Internal variable. Is set during an i-effect upgrade to hold the name of the unit of the previous version | *SYSBAS |
IEFFECT_VxRyMz_PRVSCHEMA | *SYS | Internal variable. Is set during an i-effect upgrade to hold the name of the schema of the previous version | IEFFECT27 |
IEFFECT_VxRyMz_PRVVERSION | *SYS | Internal variable. Is set during an i-effect upgrade to record the version number of the previous version | V2R7M0 |
IEFFECT_VxRyMz_REORG_DELETE_WITH_ROWCOUNT | *SYS | Defines the maximum number of records that are deleted in one call in a STREFREORG. If *NONE is specified, all records are deleted. This is the default. | 10000 |
IEFFECT_VxRyMz_SKIP_CLASSPATH | *SYS | Setting these environment variables avoids the need to (re-)create the class path. This can be set regularly if no changes to the class path are expected and the call start of the JVM needs to be accelerated. | *YES |
IEFFECT_VxRyMz_SYSBASLIB | *SYS | Name of the schema with the Sysbas objects of the specified i-effect version | IEFFECTSYS |
IEFFECT_VxRyMz_USER_HOME | *SYS | Name of the user directory of the specified i-effect version | /home/ieffect |
IEFFECT_VxRyMz_WEBCONTORL_LINK | *SYS | The URL for calling up the i-effect web interface | https://192.168.1.100’ |
IEFFECT_VxRyMz_WEBCONTROL_PORT | *SYS | The port used by the i-effect web interface. | 443 |
IEFFECT_VxRyMz_WEBCONTROL_FPMPORT | *SYS | The FPM port (FastCGI Process Manager) used by the i-effect web interface | 9000 |
