Managing Procedures Manually

You can manually develop your own procedures according to your needs. This section explains the deployment process on the server for Javascript procedures for UDO and UDE. These procedures must be written in a specific format and stored with some additional properties in the database as M1 programs.

Warning: If you modify the procedure directly, the next update of the server will overwrite your modifications and it will not be possible to recover the changes.
Recommendation: To write your own procedure, use the default procedure as a template.

This task shows you how to:

See Also
Available Procedures
Managing and Deploying User-Defined Open and Explore Procedures
Primitives for User-Defined Open and User-Defined Explore
Debugging and Optimization

Edit and Deploy a Procedure

You can edit and deploy procedures using the MQL programming language.

  1. Make a copy of 'Server_Home/server/Apps/VPMMultiDiscipline/Release/java/src/Any_OOTB_Procedure.1.0.0.udoproc.js' in the same folder and rename the copied file My_Custo_Procedure.1.0.0.udoproc.js for example.
  2. Modify the procedure as required. For more information, see About User-Defined Open and Explore Procedures.
  3. Deploy the procedure using MQL and do the followings:
    1. cd Server_Home/server/scripts
    2. ./mql
    3. set context user creator;
    4. verbose on; 

    5. add prog My_Custo_Procedure.1.0.0
file 'Server_Home/server/Apps/VPMMultiDiscipline/Release/java/src/My_Custo_Procedure.1.0.0.udoproc.js'
property isjavascriptprogram value TRUE 
property ProcDisplayName value "Custo_Display_Name"
property ProcShortDescription value "Custo_Short_Description"
property ProcUsageContexts value UserDefCompletionForOpenCmd
property ProcCategory value Custo
property ProcVisibility value ALL
property ProcAction value BOTH
property ProcNodeType value Any
property ProcOpenApp value ProcessPlanning;

    6. mod pack UDOProcedures add member program My_Custo_Procedure.1.0.0

    Recommendation: Stop your interactive session before deploying the procedure and restart it afterward.

    Notes:
    • Server_Home: The home folder of the server. The path 'Server_Home/server/Apps/VPMMultiDiscipline/Release/java/src/My_Custo_Procedure.1.0.0.udoproc.js' above gives you an example and specifies where is the java script file (My_Custo_Procedure.1.0.0.udoproc.js) used to create the program.
    • Release: The release level folder.
    • Any_OOTB_Procedure.1.0.0.udoproc.js: The name of the default procedure file you used to customize your own procedure.
    • My_Custo_Procedure.1.0.0.udoproc.js: The name of your customized procedure file including the version (with the last three numbers) of the program.
    • Custo_Display_Name: The label of the completion procedure that appears in the box of the user interface. It contains more precisely an NLS key.
    • Custo_Short_Description: The short description of the completion procedure displayed in the user interface. It contains more precisely an NLS key.
    • The UserDefCompletionForOpenCmd string ensures that the procedure is displayed only in DELMIA Manufacturing Context Builder.
      Note: To display the procedure also in CATIA Product Finder, specify the ProcUsageContexts value as UserDefCompletionForOpenCmd|ProductFinder.
    • ProcVisibility: There are two possible values.
      • ALL: The customer procedure is ready to be used in production and visible by any user.
      • DEV: The procedure have been created but not yet been validated.
      Note: You can manage the list of available procedures in Me > Preferences > App Preferences > Simulation > Process Engineering > Manufacturing Context Builder > User Defined. For more information, see User Defined.
    • ProcAction: There are three possible values.
      • The MCB_OPEN string ensures that the procedure is available only for the PPR User Defined Open command.
      • The MCB_EXPLORE string ensures that the procedure is available only for the PPR User Defined Explore command.
      • The BOTH string ensures that the procedure is available for PPR User Defined Open and PPR User Defined Explore commands.
      Note: If the ProcAction is not specified, by default the procedure is available in both commands.
    • ProcNodeType: There are two possible values.
      • The <ObjectType> string ensures that the procedure is available only for the defined object type. For example, if you specify EBOM as the object type, the procedure will only be available when selecting an item when launching the UDO or UDE command. Values can be:
        • EBOM
        • MBOM
        • System
        • WorkPlan
        • Resource
      • The Any string ensures that the procedure is available for all input object types.
      Note: If the ProcNodeType is not specified, by default the procedure is available for all input object types.
    • ProcOpenApp: There is one possible value.

      The <AppTitle> string ensure that the UDO procedure opens within the specified authoring app. Values can be:

      AdditivePartPreparation AssemblyDefinition AssemblyEvaluation AssemblyExperience
      AssemblyPathOptimization ConstructionPlanning CuttingToolsBuilder DrillingRiveting
      EquipmentAllocation EquipmentDesign EquipmentSimulation EquipmentVirtualCommissioning
      ErgonomicWorkplaceDesign ErgonomicsatWork ErgonomicsEvaluation FabricatedStepDefinition
      FactoryFlowSimulation HeavyIndustryFluidicFabrication HeavyIndustryManufacturing HeavyIndustryProcessPlanning
      HeavyIndustryStructureFabrication MachiningValidation ManufacturedItemDefinition ManufacturedItemDefinitionwithFasteners
      MaterialDepositionFabrication MillingMachining MillTurnMachining MultiaxisMachining
      PlanningStructure PlantLayoutDesign PrismaticTurningMachining ProcessFlowSimulation
      ProcessPlanning ProcessPlanningwithFasteners RobotArcSimulation RobotOptimization
      RobotProgramming RobotSimulation RobotSpotProgramming RobotSpotSimulation
      RobotSurfaceSimulation RobotVirtualCommissioning ServiceProcessStructure SimulationExperience
      TimeMotionStudy ToolAnalysis WireEDMMachining WorkInstructions
      WorkPlanPublication
      Important: Make sure that the app defined is compatible with the given procedure to open the retrieved data when running this UDO procedure.
      Note: If an incorrect value or no value is defined, the UDO command opens the result in the last used authoring app.

The procedure you have created takes effect immediately; there is no need to restart the server. The changes you make will be implemented the next time you use the PPR User Defined Open or PPR User Defined Explore command.

Tip: If you want to modify the procedure of an already existing program and redeploy it, you need to update the program with the following command: mod prog My_Custo_Procedure.1.0.0 file 'Server_Home/server/Apps/VPMMultiDiscipline/Release/java/src/My_Custo_Procedure.1.0.0.udoproc.js';. In this case, there is no need to stop your interactive session before deploying again the procedure and restart it afterward.

Delete a Procedure

You can delete existing procedures from the server using the MQL programming language.

  1. Deploy the procedure using MQL.
  2. Do the followings:
    1. cd Server_Home/server/scripts
    2. ./mql
    3. set context user creator;
    4. verbose on;
    5. delete prog My_Custo_Procedure.1.0.0

The deletion of your procedure takes effect immediately; there is no need to restart the server.

Tip: To remove a UDO or UDE procedure from the list of the available procedures, use the MQL mod pack UDOProcedures remove member program My_Custo_Procedure.1.0.0 command. In this case, it removes the procedure from the list but it keeps it on the server.