Orchestrator schema

When you create an orchestrator, use the following schema:

Parameter	Type	Description	Required
_name	String	Enter a unique name for the orchestrator.	Required
_description	String	Give the orchestrator a description.	Optional
_namespaces	Array of Strings	Pass an array with the namespaces you want to include.	Optional
_userType	String	Give the orchestrator a userType tag that can be attributed to similar orchestrators.	Optional
_params	Object	Pass an object that contains a “tasks” parameter.	Optional
_params.tasks	Array of Objects	Pass an array of objects with each object a system component you want to use in the orchestrator.	Optional
_params.tasks._orchcomp	String	Enter the unique name of the system component you want to reference.	Required
_params.tasks._name	String	Describe what the component does in the context of your orchestrator.	Optional
_params.tasks._sequenceno	Number	Enter a number that defines the task’s order in the sequence of tasks to execute.	Required
_params.tasks._actualparams	Object	Pass an object that contains the parameters you want to pass to the component as key-value pairs.	Optional

Code example

{ 
  "_name": "BIMPK Uploader", 
  "_description": "BIMPK Uploader", 
  "_namespaces": ["{{nsfilter}}"], 
  "_userType": "bimpk_uploader", 
  "_params": 
    { 
      "tasks": [ 
        {
          "_orchcomp": "default_expressions_target", 
          "_name": "Copy space relationships from previous version", 
          "_sequenceno": 8, 
          "_actualparams": { 
            "userType": "iaf_ext_bimpk_post_imp", 
            "relatedUserType": "iaf_ext_space_coll" 
          } 
        }, 
        { 
          "_orchcomp": "default_expressions_target", 
          "_name": "Copy assets relationships from previous version", 
          "_sequenceno": 7, 
          "_actualparams": { 
            "userType": "iaf_ext_bimpk_post_imp", 
            "relatedUserType": "iaf_ext_asset_coll"
          } 
        }, 
        { 
          "name": "folder_cleaner_target", 
          "_sequenceno": 6 
        }, 
        { 
          "name": "geometry_relations_target", 
          "_sequenceno": 5 
        }, 
        { 
          "name": "scz_relations_target", 
          "_sequenceno": 4 
        }, 
        { 
          "name": "default_expressions_target", 
          "_actualparams": { 
            "userType": "iaf_ext_bimpk_upload" 
          }, 
          "_sequenceno": 3 
        }, 
        { 
          "name": "bimpk_element_extractor", 
          "_sequenceno": 2 
        }, 
        { 
          "name": "bimpk_file_extractor", 
          "_sequenceno": 1 
        } 
      ] 
    } 
}