Using the Process Flow Compiler

Process flows allow an organization to configure business functionality within Aptify without the use of custom code. The system interprets each process flow at run time, contacting the database for any required information in order to process the logic. In most cases, simpler process flows that consist of only a few steps will run efficiently using interpreted mode. However, operation in interpreted mode may be less efficient for more complex process flows that consist of numerous process steps or include more complex rule logic or iterative processing.

One method to improve the efficiency of process flows, especially the more complex flows or those that are run often within the system, is to make use of the process flow compiler. Compiling a process flow automatically generates a VB.NET assembly and class, which incorporate all logic included within the process flow into code.

This topic covers the following sub-topics:

• Compiling a Process Flow
• Recompiling a Process Flow

Compiling a Process Flow

Follow these steps to compile a process flow:

1. Open a Process Flows record and select the Details tab.
   • By default, when a Process Flows record is created, the Compile Mode is set to Interpreted, and the Compile Status is set to Incomplete.
     
     
     
     
2. Change the Compile Mode to Compiled and save the record.
   • This starts the Compile process.
   • The system compiles the process flow into a .NET assembly and stores the object on the client computer in the following location: C:\Documents and Settings\<user name>\Local Settings\Application Data.
   • The names of the files generated by this process are in the following format: Aptify_PF[Process Flow ID]{_}.
   • The system also adds to the object to the Aptify Object Repository.
     
3. Close and reopen the record to refresh the record's contents. Click the Details tab.
   • The Compile Status field automatically changes to Complete, and the Compiled Object, Compiled Assembly Name, and Compiled Class fields populate automatically with the name of the object, assembly, and class created to incorporate the logic for the Process Flows record.
     
     

4. Close the record.
   
   

   If the Compile Status is set to Error after attempting to compile a process flow, select the Session Exceptions viewer for more information. The Session Exceptions viewer can be accessed from the Aptify > Session Exceptions menu item. See Using the Desktop Client Session Exception Viewer for details.

Recompiling a Process Flow

If you modify a compiled process flow, you should recompile the process flow so that the .NET assembly can be updated to include the changes that you made. Follow these steps to recompile a process flow that has previously been compiled:

1. Close and reopen the Aptify Desktop client.
   • You cannot compile the same process flow more than once during the same session. Therefore, if in doubt, you should close and reopen Aptify before attempting to recompile a process flow.
2. Open the Process Flows record and modify the process flow as necessary.
3. Click the Details tab.
4. Change the Compile Mode to Interpreted and Compile Status to Incomplete.
5. Save the record.
6. Change the Compile Mode to Compiled and save the record.
   • The process flow is recompiled. If you close and reopen the record, the Compile Status will automatically update to Completed (or Error if a problem occurred). If an error occurs during the compile process, select the Session Exceptions viewer for more information. The Session Exceptions viewer can be accessed from the Aptify > Session Exceptions menu item. See Using the Desktop Client Session Exception Viewer for details.