› User interface › Forms › Build forms › Build a Create new job form

Build a Create new job form

A Create new job form helps you create jobs.

Generate a Create a new job form with one or more process maps. The generated form has the following format: <Form name>CNJ. For example, in the PersonalInfoCNJ form, PersonalInfo denotes the form name and CNJ denotes the Create new job type of form.

All the process initialization variables and the variables used as input or output to the activity appear as corresponding controls in the form. For example, a String variable appears as a text box, a Boolean variable as a check box, and a Date variable appears as a Calendar control. Any Folder initialization variables appear as File upload controls and allow you to upload documents to the repository without having to edit the form design.

Input variables are read-only; output variables are editable controls.

The generated form contains the following fields by default:

  • Job/Case/Job in Case buttons (depending on the map type)

  • Create button

  • Case Ref text box (only for the case and case fragment maps to enter the reference number for the new job)

For example, the Club Membership case map has three initialization variables.

Variable name Data type
Customer Name String
Membership Bool
Enrollment Date Date

The Create new job form generated on this map creates the controls as shown in the following figure. Create new job form

If a Checklist variable is being used in a map, the CreateNewJob event is mapped to the text property of checklist web controls. See Checklist control.

If a document initialization parameter is used in the map:

  • The form variable holds the document ID.

  • By default, "File selection mode" is "Single". It indicates that you can upload a single file (any file type), in file upload control on the form for each document initialization variable. Once uploaded, the ID of the document created appears in the job. The name of the uploaded document is set to the name of the file that is selected.

  • By default, "Store in repository" is selected.

  • When you regenerate a Create new job form where the process has a newly added document variable, a file upload control is added.

  • When you debug the form, the controls appear, and the form can be debugged.

If a data object is used as an initialization variable in the map:

  • A data model copy is added, and a data object form variable referencing the same model is added to the form.

  • The form controls for each field in the data object are added to the form.

  • An action for getting the fields and generating the corresponding controls is added on form load.

  • An action for updating the data object is added on creating the job.

  • When you regenerate the form, a warning message is displayed stating: The selected form cannot be regenerated. You must delete and recreate the form.

  1. Navigate to User interface > Forms.
  2. On the Generate list, select Create new job form. Alternatively, select Generate CNJ form on the context menu of the process for which you want to build the form.

    The Create new job form dialog box is displayed.

  3. On the Process list, select the process for which you want to build the Create a new job form.

    When you generate a form on a process that exists in GitHub and the process is not checked out to GitHub or checked out with another user, a warning message appears. When you click OK, a Create new job form is generated without increasing the process version.

  4. By default, the form name appears in the Form name field as the process name suffixed with the type of form you are building. For example, if the process name to build the Create new job form is MyProcess, the form name appears as MyProcessCNJ. Change the process name, if needed.
  5. By default, the Category is the same category that the process belongs to. You can update the category that the form should be in.
  6. To associate a Create new job form with a process, select Update process with associated form.

    • When you add this process to a package, the associated Create new job form is automatically included in the package, if Include items associated with forms is selected for the package. See Create a package.

    • When you open the process on which the Create new job form was built, the Job creation form property is updated with the corresponding Create new job form name.

      If the process is already open, close and reopen it to update the Job creation form property.

  7. Click Generate and save to save the generated form. Alternatively, to release the form, click Generate and release.

Edit a Create new job form

  1. Open the Create new job form in the Design view.
    The existing properties of the form are displayed in the properties panel. See Form properties.
  2. Make changes as needed.
    You can and add new controls and actions to the form as appropriate and regenerate the form.
  3. Save the form.