The RQE generator tool assists in creating entries in the RQE files for the labels or reports. Its user interface provides means to view all the direct properties, properties of related objects, navigate multiple relationships and create entries to use in an RQE file.
Typical work flow:
1. Select object (or multiple objects) for which the label needs to be created. These objects are added to the “Objects List”
2. Start the command, below window is displayed.
SP3D Automation Toolkit - Common Commands
3. Relationships View: This displays object’s relationships (RelationName and RelatedObject) for each Relationship. Selecting a Related Object displays its properties. Double-clicking a Related Object adds it to the Related Objects List (which can be traversed back using buttons 5,6) and also makes it the root node. Clicking the Add to Objects List button adds it to the Objects List (manipulated by buttons 1,2,3,4).
4. Properties View: Displays properties of the object representing the node in Relationships View.
If the property you wish to make a label for is
A direct property on the object, select it from Properties view.
A property on a related object (or object across multiple relations), then use the Relationships View to traverse through related objects – you can navigate multiple relations by double clicking on the related object at each relation level. Once you reach the final related object, you can select the desired property from the Properties View.
A property on an object across several levels of same relationship (eg SystemHierarchy or AssemblyHierarchy), then double-clicking on the relation name brings up a “Hierarchy List”
SP3D Automation Toolkit - Common Commands
window which indicates all the related objects iteratively at different depths on the relation.
You must specify Exit Condition to identify the desired object –specify Depth, or specify an Interface which such object Implements, and then click OK to select that object. Now you can proceed to select a desired property from the Properties View.
Once the desired property is selected, click Add Property button, which brings up a window prompting for inputs required for the label, as explained below.
Returned Property: Specify Name for the Returned Property field. Defaults to DisplayName of the property. User can
specify a different name, or pick an existing Returned Property name to add the label to it.
Source Type: This provides with a way to have unambiguous strokes (relation paths) for different object types. For example, if you want different entries in the RQE for one Returned Property (eg RunName) based on different object types (eg Pipe Supports / Piping Parts / Piping Features).
Concatenate: Specifies the Concatenation options (No/Left/Right) for this property. Useful in scenarios like getting full Hierarchy path of object. If you pick Left/Right, then you can pick or specify a valid character for the “Path Separator” too.
Filter: Specifies the Filter options for this property. It can be First/Last/All. Additionally, you can pick a specific interface for the filter. This is used to process related objects of a certain type.
Note: The Concatenate, Path Separator, Filter and Interface fields are only visible for properties accessed through a related object of the main object being processed.
5. Once all the required properties are added, click the ‘Copy output to Clipboard’ button and
SP3D Automation Toolkit - Common Commands
Example: This example explains how to create an RQE which gets Name, RunName, PipelineName, AreaName for PipeComponents and PipingSupports.
Select one PipeComponent and one PipeSupport and start the command. Observe that, you have two objects in the Objects List.
Go to the 1st Object i.e. PipeComponent (it is selected by default), and select the root node.
Select the Name property from the Properties view, click Add Property button and click OK.
Traverse Run to Part relationship which takes to the Component’s Run. Select it and then select Name property and click Add Property button. Specify Returned Property = RunName and click OK.
Double-click the Run node to display its relationships. Traverse System Hierarchy relationship and select the Pipeline, select the Name property and click Add Property button. Specify Returned Property = PipelineName and click OK.
Double-click the System Hierarchy node to display the Hierarchy List of that relationship. Select the row indicating the Area, select Implements option for Exit Condition and choose IJAreaSystem option and click OK. Observe that the AreaSystem’s properties are displayed; select the Name property and click Add Property button. Specify Returned Property = AreaName and click OK.
Now, click the Next Object button to activate the next object (PipeSupport) in the Object List.
Observe that the details (Relationships and Properties) of the PipeSupport are now displayed.
In the Relationships view, traverse Object to Non-distribution Port relationship and double-click the route feature under it. Now, in the feature’s Relationships displayed, traverse the Run to Feature relationship to go to the Run and select it. Select the Name property and click Add Property button.
Pick RunName from the Returned Property list and pick IJHgrPipeSupport for the source type and click OK. This adds a new PATH specific for PipeSupports for the RunName Returned property.
Follow similar steps to add the PipelineName and AreaName properties specific for the PipeSupport traversing from the PipeRun which we arrived at above.
Click on the Copy output to Clipboard button and paste in the RQE file.
SP3D Automation Toolkit - Marine Product-Specific Commands