Creating a workflow
We recommend that you plan your workflow before you create it. Outline the processing steps that your jobs pass through, and make sure that the step templates required to create those steps exist. If any of the step templates that you need do not exist, create them before you create the workflow.
To create a workflow corresponding to the processing steps that your jobs pass through, you can add steps to processing phases in the order that you want RICOH ProcessDirector to do them.
Step chains must have one entry point, a single step at the beginning of the step chain that all jobs process through. They can, however, have multiple endpoints, or steps with no outbound connector. When a step chain is placed in a workflow, it might be connected to one or more steps for jobs both entering and exiting the step chain. If the step chain has multiple endpoints, all of the end points continue processing following the outbound connector. If there are multiple outbound connectors, each endpoint is evaluated against the connectors following the order of execution and the job proceeds down the correct path.
- We strongly recommend that all workflows begin with a SetJobPropsFromTextFile step and end with a RemoveJobs step.
- When they are added to a workflow, step chains are treated like steps. In all of the actions below, references to steps apply to step chains as well.
- If files for data streams that a workflow does not support can enter the workflow,
we recommend these best practices:
- Add a DetectInputDataStream step after the SetJobPropsFromTextFile step.
- After the DetectInputDataStream step, add a branch with 1 step: FailWithMessage. Set the value of the Failure message property to Unexpected datastream encountered. On the connector from the DetectInputDataStream step to the next step in the workflow, set a conditional processing rule that defines the input data streams. For example, specify that the Input data stream property equals PDF.
- Click the Workflow tab.
- In the left pane, click Workflows.
- Right-click a workflow that you want to use as a model and select Copy.
- If you want to start with a workflow that has two steps, SetJobPropsFromTextFile and RemoveJobs, with a connector between them, click Add.
- Name the copy of the workflow, fill in or edit other values that you need, and click
Continue.You see the workflow's steps in the workflow editor.
- Review the steps in each phase of the workflow.The default processing phases in the base product are Receive, Prepare, Print, and Complete. Some features add other phases such as Assemble or Insert.
- The default phase names can be changed to match the functions that you perform in that phase.
- Delete any steps that you do not need. Select the step and press the Delete key or right-click the step and select Delete.
- Add each new step or step chain:
- To add a step, click Step Templates in the top right corner of the workflow editor; to add a step chain, click Step Chains in the top right corner of the workflow editor.
- Click a step template or step chain and drag it into the workflow editor. Place the
step where you want it. If you add a step on a connector, the connector will divide
in two, one from the source to the new step and one to the destination step. The execution
order of the connectors from the original source are preserved on the new connectors.
- If you drop the step on top of a connector, the connector divides into two parts and the step is included in the workflow at that point.
- If you drop a step directly on top of another step, the dropped step replaces the existing step after you confirm that action. The existing step is removed from the workflow.
- To add another instance of an existing step in the workflow, right-click it and select Copy. Position your mouse where you want to place the step, right-click and select Paste.
- You can use the same name for more than one step.
When you add a step with the same name as an existing step in the same processing phase, RICOH ProcessDirector assigns the new step a Step identifier property value. The value has a number at the end of the step name, for example, AssignJobValues2.
Each time you add another step with the same name in the same phase, RICOH ProcessDirector increments the number by one, for example, AssignJobValues3. You see the Step identifier property value in the step and job properties notebooks, messages, and system logs.
- Connect the steps:
- Hover over the edge of the step that sends jobs to the new step. Click and hold a highlighted section () to make the connector appear.
- Drag the connector onto the step that receives jobs from the new step and release
the mouse button.
- You can attach the connector to the top, bottom, either side of the step, or release over the center of the circle.
- If a step uses conditional processing, RICOH ProcessDirector uses the values specified in the Order of execution property of each connector to determine which connector to try first.
If a step sends jobs to three different steps, RICOH ProcessDirector first attempts to send each job through the connector with an Order of execution value of 1. If a job does not meet the conditions for that connector, RICOH ProcessDirector attempts to send the job through the connector with an Order of execution value of 2. If a job does not meet those conditions either, RICOH ProcessDirector attempts to send the job through the next connector in the execution order.
If a connector processes all jobs that do not meet the conditions specified by the other connectors, make sure that connector has the highest Order of execution value.
- Optional: To change the layout of the steps, click a step and drag it to a new position in the Workflow Editor. The connectors reposition themselves as the step moves.
- Optional: To change the order of the steps, click the arrowhead on a connector and move it to a different step. Repeat until all of the connectors follow the new route through your steps. Then, rearrange the steps on the Workflow Editor to match the progression of steps.
- Optional: To select a set of steps that are contiguous, press and hold the Shift key and drag your mouse to draw a box around the steps you want to select. Release
the mouse button.
To select a set of steps that are not contiguous, press and hold the Ctrl key. While holding Ctrl key, click on the steps you want to select.
- To save a selected group of connected steps as a step chain, right-click on the highlighted area, and select Save as Step Chain.
- To move the selected group, press the left mouse button down inside the box and drag the group to where you want to place it and lift the mouse button up.
- To delete the selected group, press the Delete key or right-click inside the box to bring up the context menu and select Delete.
- Specify property values for each step:
- Right-click the step and select Properties.
- On each tab in the properties notebook, fill in or edit values for any required properties.An asterisk, *, indicates that a property is required.
- Fill in or edit values for any optional properties that you plan to use.You can also specify default values for job properties without editing each step, using the Manage job defaults action. Right-click on the Workflow editor and select Manage job defaults.
- When you are finished, click OK.
- RICOH ProcessDirector remembers the values that you enter for each step but does not save them until you save the workflow.
- If a step sends jobs to multiple steps, right-click each connector from the sending step to a receiving step, and select Properties. Specify a conditional processing rule for the connector, and click OK.
- Save the workflow by selecting Save workflow from the More menu to the left of the workflow name. You can save an incomplete workflow.
- When you are ready to use the workflow, enable it by selecting Enable workflow from the More menu to the left of the workflow name.RICOH ProcessDirector validates the workflow when you enable it. To be valid, only one step must start the workflow. That step does not receive jobs from other steps. All other steps must have connections through which they receive jobs.
- Alert () icons show steps that do not meet the requirements.