YADE Parameter Reference - JobScheduler

• Schema: CreateOrder
• Mapping:
  • create_order

With this parameter it is possible to specify a file order to be created and launched for execution by JobScheduler. A file order is created for the first filename in the result list of a Selection.

To create a file order for all files see CreateOrderForAllFiles parameter.

To create a file order for new files see CreateOrderForNewFiles parameter.

• Schema: OrderJobChainName
• Mapping:
  • order_jobchain_name

The value of this parameter is the name of the job chain that is to be launched by the order. Should the job chain not be located in the "live" folder but in some sub-folder then the folder names have to be added to the parameter value.

An example: a job chain "Test" is located in the "live/sample/FileOperations" folder. The value to be specfied is then "/sample/FileOperations/Test".

• Schema: CreateOrderForAllFiles
• Mapping:
  • create_orders_for_all_files

With this parameter it is possible to specify that a file order for all files in the result list of a Selection will be created and launched for execution by JobScheduler.

To create file orders only for each new file found see CreateOrderForNewFiles parameter.

• Schema: CreateOrderForNewFiles
• Mapping:
  • create_orders_for_new_files
• Release:
  • YADE-512 Availability starting with 1.12.5.

With this parameter it is possible to specify that a file order for all new files in the result list of a Selection will be created and launched for execution by JobScheduler.

To create file orders for each file found see CreateOrderForAllFiles parameter.

• Schema: NextState
• Mapping:
  • next_state

This parameter specifies the name of the node in the job chain that the job chain should be started with.

• Schema: MergeOrderParameters
• Mapping:
  • MergeOrderParameter

This parameter specifies that the order that is to be created will inherit the parameters of the current order.

• Schema: ParamNameForPath
• Mapping:
  • param_name_for_path
• Release:
  • YADE-512 Availability starting with 1.12.5.

When YADE creates an order the parameter scheduler_file_path contains the name of the transfered file.

Therefore the order is handled as a file order and will be moved to the blacklist if the file will not be removed after the new order reaches the end of the job chain.

If the order should not be handled as an file order the name of the parameter that contains the file name can be change to another value e.g. "filename".

If so the new order will not be moved to the blacklist if the file still exists after the execution of the order.