Create Programs
Programs are created from the Global Explorer Programs node. The Global Explorer is the only tab where programs can be added or edited. Once a program is created, it can be linked to a segment or plan. A program can only be linked to a segment or plan once.
Add a New Program
Programs are added from the Global Explorer tab. A ProgramDefinition.xml file is created for each program to hold all the program characteristics. There are five panes available in the Configuration Area for programs.
- General pane: this pane provides additional general information for the program, such as the version number.
- Fields: this pane is used to configure the fields that are available to a user in OIPA for capturing program details.
- Program Actions: this pane is used to provide a simple method for configuring program actions. A list of available actions is available to the left of the Configuration Area. Clicking on an action will add the opening tag to the Configuration Area. The additional information can be added directly under the tag. When an action has saved configuration, clicking on the action will display that action's XMLin the Configuration Area. This gives a close up view of the specific action configuration. If the complete configuration needs to be viewed, click the XMLSource tab.
- Events: this pane is used to provide a simple method for configuring events and actions. A list of available events and actions is available to the left of the Configuration Area. Clicking on a node will add the opening tag to the Configuration Area. The additional information can be added directly under the tag. When an event or action has saved configuration, clicking on the action will display that action's XML in the Configuration Area. This gives a close up view of the specific even or action configuration. If the complete configuration needs to be viewed, then click the XMLSource tab.
- XML Source: this pane provides a way to configure directly in the XML without using the visual configuration tools.
Steps to Add a New Program
- Navigate to the Global Explorer tab.
- Open the environment folder and right-click the Programs node. Select New Program. The New Program wizard will display.
- Type the name of the new program in the New Program Name field.
- Select a program type from the Program Type drop down box. Types are defined in AsCodeProgramType.
- Select a primary company to associate to the program.
- Click Finish. The new program will be listed under the Program node.
- Double-click the ProgramDefinition.xml file for the new program to open it in the Configuration Area.
- Configure the ProgramDefinition. Refer to the XMLConfiguration Guide in the Help menu for a complete explanation of elements and attributes.
- configure the Fields that will display when the program is added to the Program screen in OIPA.
- configure the Events and Actions needed for the program.
- configure the program actions. The action can be visually configured in the Program Actions tab or straight in the XML using the <ProgramAction> element. The four options are Start, Run, Reinstate and Terminate. From the Program Action tab, click the action in the Program Actions Navigator pane that needs to be added. The opening tag will appear in the Configuration Area. Identify the transaction that kicks off the action in the <Transaction> element. Fields are defined if needed. A special <ReinstateTransaction> element is needed to further define the reinstate process. The program prototype example demonstrates all the configuration options for program actions.
- Check-in the ProgramDefintion.xml file to save the configuration changes.
Link a Program to a Plan or Segment
After a program is created and the ProgramDefinition is configured, it can be linked to plans or linked to segments.