Define procedure details

To create a new procedure or modify an existing one, go to the procedure's details.

To create or edit a procedure:

Important: Some procedures are marked within Aspen as system-owned. Editing the source code, format definitions, or input definitions will result in the following warning:

1. Log on to the District view.
2. Select Tools > Procedures.  
3. Do one of the following:
• To edit an existing procedure, click the procedure you want to modify.
• To create a new procedure, select Options> Add. The procedure details page appears.
• 

4. Use this table to enter information in the fields on the General sub-tab:

   Field	Description
   Name	Type a name that distinguishes the procedure.
   Procedure ID	Type an identifying number or code for the procedure.
   Category	Click this drop-down to select the appropriate category for the procedure.
   Menu group	Type the name of the Options sub-menu the procedure will appear in, such as Procedures.
   Sequence Number	Type a number to indicate the procedure's placement on the Options menu.
   Weight	Type a number to indicate the procedure’s priority when running multiple procedures used for data manipulation or operations, such as running GPAs simultaneously.
   Source code	Do one of the following: Click to edit the procedure's Java source. Click to upload the procedure's Java source. For an existing procedure, click to download the procedure's Java source.
   Input definition	Do one of the following: Click to edit the procedure's input definition. Click to upload the procedure's input definition. For an existing procedure, click to download the procedure's input definition.
   Custom Java source	Select this checkbox to indicate the procedure's Java source has been customized. Note: If you modify the default version of a procedure rather than making a copy, you must select this checkbox or your customizations might be overwritten during an update.
   Custom input definition	Select this checkbox to indicate the procedure's input definition has been customized. Note: If you modify the default version of a procedure rather than making a copy, you must select this checkbox or your customizations might be overwritten during an update.
   Comment	Type a description of the modifications you are making to the procedure, for documentation purposes.
   Schedulable	Select this checkbox to permit this procedure to be run on a schedule.

5. You can also add external sources (sources of re-usable code) that will be used by the procedure. To do so:
• Beneath the "External sources" table, click Add. The Tool Selection pop-up appears.
• Select a tool type from the Select a tool type drop-down. The pick list refreshes to display all tools of this type currently defined in the system as owned by the organization whose view you are logged in to.
• Select the tool(s) you want to use as external sources of code for the procedure.
• Click OK.

6. Click Save.
7. To add a description of the procedure, including any warnings or directions for running it, click the Description sub-tab. The rich text editor appears.
8. Enter a comment to describe the procedure. This comment appears in a pop-up when the user runs the procedure. The user can then click Run or Cancel on the pop-up.
9. Click Save.
10. To define the locations, including NavID and views, at which users can run the procedure from the Options menu, click the Navigation sub-tab.
    
11. To add a new location at which users can run the procedure from the Options menu:
• Click Add.
• In the NavID field, type the NavID (location name). See Find Screen's NavID (Internal Location Name).
• Select the checkboxes for the views where the procedure appears.
• Click OK.
• Click Save.

12. To change the views at which users can run the procedure from the Options menu:
• Click the NavID.
• Select or deselect the checkboxes for the views to be changed.
• Click OK.
• Click Save.

13. To delete a location at which users can run the procedure from the Options menu:
• Select the checkbox for the NavID.
• Click Delete.
• Click Save.

14. To define which districts, intermediate organizations, or schools have the ability to run the import from the Options menu, click the School sub-tab. By default, all the educational units owned by the organization whose view you are logged on to have this ability.

15. To give or deny specified units the ability to run the procedure in the Options menu:
• Click the Visibility type drop-down, and do one of the following:
  • To deny a unit the ability to run the procedure in the Options menu: Select Exclude.
  • To give a unit the ability to run the procedure in the Options menu: Select Include.
• Click Add.
• Click the Owner type drop-down and select the type of unit to which you want to give or deny the ability to run the procedure from the Options menu. The pick list refreshes to display all units of that type currently defined in the system as owned by the organization whose view you are logged on to.
• Select the district(s), intermediate organization(s), or school(s) you want from the pick list.
• Click OK.
• Click Save.

16. To define which user roles can run the procedure in the Options menu, click the Roles sub-tab.
17. To give or deny specified user roles the ability to run the procedure in the Options menu:
• Click the Role visibility type drop-down, and do one of the following:
  • To deny a specific user role the ability to run the procedure from the Options menu: Select Exclude.
  • To give a specific user role the ability to run the procedure from the Options menu: Select Include.
• Click Multi-Add...
• Select the desired user role(s) from the User Role Pick List.
• Click OK.
• Click Save.