You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

User defined parameters in shell scripts

  • Job parameters and order parameters are accessible by environment variables to shell jobs.
  • There is a simple rule for the naming of environment variables: 
    • The name of the environment variable for a parameter is SCHEDULER_PARAM_NAMEOFPARAM
    • For example the job parameter param1 is available by the environment variable SCHEDULER_PARAM_PARAM1
    • Environment variables are used with uppercase letters
    • If you wanted not to use the prefix SCHEDULER_PARAM_ and instead use the parameter names as environment variables then you could add the following setting to your ./config/scheduler.xml file:

      <params>
          <param name="scheduler.variable_name_prefix" value="*NONE"/>
          ...
      </param>

      (info) Hint: You have been warned, JobScheduler would overwrite existing environment variables with the same name for the respective shell.

Examples

Example for Windows
 <job>
    <params>
        <param name="param1"  value="Test"/>
    </params>
    <script language="shell">
        <![CDATA[
 rem This is an example shell script to show the use of parameters
 echo Param1 has the value %SCHEDULER_PARAM_PARAM1%
        ]]>
    </script>
    <run_time/>
 </job>
Example for Unix
 <job>
    <params>
        <param name="param1" value="Test"/>
    </params>
    <script language="shell">
        <![CDATA[
 # This is an example shell script to show the use of parameters
 echo "Param1 has the value $SCHEDULER_PARAM_PARAM1"
        ]]>
    </script>
    <run_time/>
 </job

 

If you want to use parameters as command line arguments for a script then just add the environment variables as arguments in the command line:

Example for command line (Unix)
  anyshellscript.sh $SCHEDULER_PARAM_PARAM1 $SCHEDULER_PARAM_PARM2 ...

Passing parameters to subsequent shell jobs in a job chain

  • With every change of status in job chains JobScheduler parses a temporary file for name=value pairs. 
    • The name of the temporary file is available with the environment variable SCHEDULER_RETURN_VALUES
    • The name/value pairs are automatically added as order parameters

.

Example for First Job
 <job order="yes"
     stop_on_error="no">
    <params>
        <param name="param1"  value="Test"/>
    </params>
    <script language="shell">
        <![CDATA[
 rem This is an example shell script to demonstrate the use of parameters 
 echo newParam=an example value >> %SCHEDULER_RETURN_VALUES%
        ]]>
    </script>
    <run_time/>
 </job>
Example for Second Job
 <job order="yes">
    <params>
        <param name="param1" value="Test"/>
    </params>
    <script language="shell">
        <![CDATA[
 echo newParam has the value %SCHEDULER_PARAM_NEWPARAM%
        ]]>
    </script>
    <run_time/>
 </job>
Example for Job Chain
 <job_chain>
    <job_chain_node state="100"
                    job="job_sample_shell_with_parameter"
                    next_state="200"
                    error_state="error"/>
    <job_chain_node state="200"
                    job="job_sample_shell"
                    next_state="success"
                    error_state="error"/>
    <job_chain_node state="success"/>
    <job_chain_node state="error"/>
 </job_chain>

Related Downloads

 

  • No labels