Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/JobParameters"

m (Example)
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
= Job Parameters =
 
= Job Parameters =
 
<span style="color:#ff0000">'''This page is work in progress.'''</span>
 
  
 
The Job Manager entities can be parameterized to be configured for an actual use case.
 
The Job Manager entities can be parameterized to be configured for an actual use case.
Line 17: Line 15:
 
* [[SMILA/Documentation/WorkerAndWorkflows|Workflow definitions]]
 
* [[SMILA/Documentation/WorkerAndWorkflows|Workflow definitions]]
 
** Global workflow parameters
 
** Global workflow parameters
** Local worker parameters
+
** Local action parameters
 
* [[SMILA/Documentation/DataObjectTypesAndBuckets|Bucket definitions]]
 
* [[SMILA/Documentation/DataObjectTypesAndBuckets|Bucket definitions]]
  
 
The parameter priority increases from top to bottom, meaning that the parameters in job definitions, for example, have a lower priority than those in workflow definitions.  
 
The parameter priority increases from top to bottom, meaning that the parameters in job definitions, for example, have a lower priority than those in workflow definitions.  
  
Workflow definitions are special entities in as far as they allow you to define general parameters in the global workflow section and worker-specific parameters in local worker sections. It is important to know that the latter do not affect the buckets that the respective worker is using. As a consequence, parameters declared in a data object type can only be initialized using global workflow parameters or job parameters alternatively.
+
Workflow definitions are special entities in as far as they allow you to define general parameters in the global workflow section and worker-specific parameters in local action sections. It is important to know that the latter do not affect the buckets that the respective worker is using. As a consequence, parameters declared in a data object type can only be initialized using global workflow parameters or job parameters alternatively.
 +
 
 +
=== Example ===
 +
 
 +
Job:
 +
<pre>
 +
  {
 +
    "name":"...",
 +
    "workflow":"...",
 +
    "parameters":{
 +
      "p1":"a"  // job parameter
 +
    }
 +
  }
 +
</pre>
 +
 
 +
Workflow:
 +
<pre>
 +
  {
 +
    "name":"...", 
 +
    "parameters":{
 +
      "p1":"b"  // global workflow param, overwrites "a" from job def
 +
    },
 +
    ...
 +
    "actions":[
 +
      ...
 +
      {
 +
        "worker":"...",
 +
        "parameters":{
 +
          "p1":"c"  // lokal workflow param, overwrites "b" from global
 +
        },
 +
    ...
 +
  }
 +
</pre>

Revision as of 10:57, 27 May 2014

Note.png
Available since SMILA 0.9!


Job Parameters

The Job Manager entities can be parameterized to be configured for an actual use case.

Entities that declare parameter variables are:

Entities that initialize or set parameters are:

The parameter priority increases from top to bottom, meaning that the parameters in job definitions, for example, have a lower priority than those in workflow definitions.

Workflow definitions are special entities in as far as they allow you to define general parameters in the global workflow section and worker-specific parameters in local action sections. It is important to know that the latter do not affect the buckets that the respective worker is using. As a consequence, parameters declared in a data object type can only be initialized using global workflow parameters or job parameters alternatively.

Example

Job:

  {
    "name":"...",
    "workflow":"...",
    "parameters":{
      "p1":"a"   // job parameter
    }
  }

Workflow:

  {
    "name":"...",  
    "parameters":{
      "p1":"b"   // global workflow param, overwrites "a" from job def
    },
    ...
    "actions":[
       ...
      {
        "worker":"...",
        "parameters":{
          "p1":"c"  // lokal workflow param, overwrites "b" from global
        },
     ...
  }

Back to the top