Material#

The Material Tasks are categorized into several types: GUI Default Value (Merge Material), Hold Reasons for Material, Material Container, Material Container Single, Material Details, Materials for Resource, Materials for Storage Resource, Merge Material, Non-Dispatchable Materials for Resource, Release Hold Reasons for Material, Step Materials, and Sub Materials Data Source. Each type is further described below.

GUI Default Value (Merge Material)#

The GUI Default Value (Merge Material) Task is used to retrieve the default value for a GUI element, particularly useful in the Merge Material Wizard. It can be utilized as a dashboard task to get the container for a single material. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

Hold Reasons for Material#

The Hold Reasons for Material Task is used to provide the necessary data for the Material Hold Wizard. It supplies the Material Hold Reasons object, allowing users to put a Material on Hold. Although it is specifically tailored for the Material Hold Wizard, it can be used in any UI Page. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you should input the Material that you want to put on Hold and it will output a list of Material Hold reason which you can select to put the Material on Hold.

Material Container#

The Material Container Task filters materials and retrieves the material container for a given material list. It is mainly used in the Materials Selection step, the Merge Wizard, and the FabExplorer, but can also be used as a dashboard task. To configure the Material Container task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh - When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start - When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes - When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

The inputs for the Material Container Task include a list of materials and an entity filter that filters the Materials by name. The output is a list of Materials along with their Material Containers, the materialsCollection.

Material Container Single#

The Material Container Single Task retrieves the container for a single Material. It can be used as a dashboard task and is primarily used in the Materials Selection step and the Merge Wizard. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

The input for this task is a single Material, and the output is the Material with Material Container, the materialComplex.

Material Details#

The Material Details Task retrieves additional details about the selected Material. It can be used as a dashboard task and is primarily used in the Step View and Resource View pages. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input a list of Materials or a single Material, and it will output a complex object aggregating all the Material information, including protocols, documents, holds, off-flows, and more.

Materials for Resource#

The Materials for Resource Task provides the necessary data for the Resource View page. It supplies Materials associated with the current Resource, taking into account any optional filters passed. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input the Resource and, optionally, you can apply filters for the Material system state, name, and entity. The outputs are a list of Materials currently associated with the Resource selected, adhering to the input filters, and a complex object, MaterialsForResourceData, containing the Materials for that Resource.

Materials for Storage Resource#

The Materials for Storage Resource Task is similar to the Material for Resource but is specifically used when the Resource is of type Storage. Likewise, to configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input the Resource and, optionally, you can apply filters for the Material system state, name, and entity. The outputs are a list of storable Materials, and a list of stored Materials.

Merge for Material#

The Merge for Material Task retrieves materials that can be merged with the selected Material. It can be used as a dashboard task and is primarily used in the Materials Selection step and the Merge Wizard. To configure this task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

The inputs for the Material Container Task include a list of materials and an entity filter that filters the Materials by name. The output is a list of Materials along with their Material Containers, the materialsCollection.

Non Dispatchable Materials for Resource#

The Non Dispatchable Materials for Resource Task provides the necessary data for the Resource View page, supplying Materials associated with the current Resource while considering any optional filters passed. Although specifically tailored for the Resource View page, it can be used in any UIPage. To configure the Non Dispatchable Materials for Resource Task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input the Resource and, optionally, you can apply filters for the Material system state, name, and entity. The outputs include a list of Materials and the number of planned and unplanned Materials.

Release Hold Reasons for Material#

The Release Hold Reasons for Material Task provides the necessary data for the Material Release Wizard, supplying the Material Hold Reasons that you can use. Although specifically tailored for the Release Wizard, it can be used in any UI Page. To configure the Release Hold Reasons for Material Task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

The inputs for this task include a Material from which you want to retrieve the release Reasons and a boolean indicating whether it is a special release. The outputs include a list of Material Hold Reasons that you can choose from, and an error message in case of failure.

Step Materials#

The Step Materials Task fetches the Materials associated with a given Step; while specifically designed for the Step View page, it can be used in any UI Page. To configure the Step Materials Task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input the Step for which you would like to load the Material data and, optionally, include filters such as Facility, ignore Last Service ID, include Scheduling Jobs, and load TopMost Only. The output is a list of Materials associated with the filters applied.

Sub Materials Data Source#

The Sub Materials Data Source Task provides the Sub Materials of a given Material. Although it is specifically tailored for the Fab Explorer, it can be used in any UI Page. To configure the Sub Materials Data Source Task, you need to provide a name and, optionally, a description. Additionally, you can customize its behavior by adjusting the following settings:

• Auto Refresh: When enabled, the page will automatically update its data at defined intervals. You can set the specific interval according to your needs. The default setting is false.
• Retrieve Data on Start: When enabled, the system will fetch and display relevant data as soon as the page loads. The default setting is true.
• Retrieve Data on Changes: When enabled, the system will update the data displayed whenever there are changes. The default setting is true.

To use this task, you must input the Material from which you want to load the Sub Materials, and the output will be the resulting list of Sub Materials currently associated with the chosen Material.