Skip to main content
Kinetic Community

Kapp Model

The kapp object represents the Kapp that is being accessed. Many of the properties and methods are accessible within the bundle.

Properties

afterLogoutPath

The route to redirect the user after logging out of the application from somewhere within the Kapp.

${kapp.afterLogoutPath}

attributes

A list of all attributes applied to the kapp.

${kapp.attributes}

categories

A list of categories defined in there kapp.

${kapp.categories}

categorizations

A list of categorizations for the kapp. A categorization is a relationship between a Category and a Form.

${kapp.categorizations}

categoryAttributeDefinitions

A list of attribute definitions that apply to categories in the kapp.

${kapp.categoryAttributeDefinitions}

completedCoreState

The value to set the Core State field on a Submission when the confirmation page is reached for that submission. For Kapps like Kinetic Request, this value should be ‘Submitted’. For a Kapp that doesn’t have any followup processing (such as an Incident system), this value would be ‘Closed’.

${kapp.completedCoreState}

defaultFormConfirmationPage

The JSP to use by default for the confirmation page on all forms within the Kapp. The application will search for this JSP file in the Kapp bundle path. Any form can override this value by setting the Display JSP value on the confirmation page within the Form Builder. If this value is not set, the implicit default value (confirmation.jsp) will be used.

${kapp.defaultFormDisplayPage}

defaultFormDisplayPage

The JSP to use by default for all forms within the Kapp. The application will search for this JSP file in the Kapp bundle path. Any form can override this value by setting the Display JSP value on each content page within the Form Builder. If this value is not set, the implicit default value (form.jsp) will be used.

${kapp.defaultFormDisplayPage}

defaultSubmissionLabelExpression

Defines what the label of the submission should be. Any form can override this value by setting the Submission Label Expression property on the Form. This allows each submission to have a friendly label that is easy to read, such asJoe’s Pencil Request 2016-03-02 using properties from the form and submission. If this value is not set, the implicit default which is the id property of the submission ({submission.id}).

${kapp.defaultSubmissionLabelExpression}

displayType

Indicates the type of action that should happen when a user navigates to the home page of a Kapp. Possible actions are to display a JSP page, or to redirect to a URL.

  • Display Page
  • Redirect
${kapp.displayType}

displayValue

The value that corresponds to the displayType property. When Display Page is selected, it indicates the name of the JSP page to render within the Kapp bundle. The implicit default is kapp.jsp. When Redirect is selected, the application will redirect the user to the URL indicated by this value

${kapp.displayValue}

fields

A list of fields defined on the Kapp. Each of these fields apply to all forms in the Kapp.

${kapp.fields}

formAttributeDefinitions

A list of attribute definitions that apply to forms in the kapp.

${kapp.formAttributeDefinitions}

formTypes

A list of form types defined in the kapp.

${kapp.formTypes}

forms

A list of forms in the kapp.

${kapp.forms}

initialCoreState

The value to set the Core State field on a Submission when it is created. For Kapps like Kinetic Request, this value should be ‘Draft’. For a Kapp that doesn’t have the concept of draft modes (such as an Incident system), this value would be ‘Submitted’.

${kapp.initialCoreState}

kappAttributeDefinitions

A list of attribute definitions that apply to the Kapp.

${kapp.kappAttributeDefinitions}

loginPage

The name of the JSP to use when logging into the application while trying to access the Kapp or a form within the Kapp. The application will search for this JSP file in the Kapp bundle path. If not provided, the application will search for the implicit defaultlogin.jsp within the bundle path. If that JSP does not exist, the built-in application login page will be rendered.

${kapp.loginPage}

name

The name of the Kapp.

${kapp.name}

resetPasswordPage

The name of the JSP to use for resetting a user’s password. The application will search for this JSP file in the Kapp bundle path. If not provided, the application will search for the implicit default resetPassword.jsp within the bundle path. If that JSP does not exist, the built-in application reset password page will be rendered.

${kapp.resetPasswordPage}

securityPolicies

A list of security policies that apply to the Kapp.

${kapp.securityPolicies}

securityPolicyDefinitions

A list of security policy definitions that exist on the Kapp.

${kapp.securityPolicyDefinitions}

slug

The slug value of the kapp. This value must be unique within the Space.

${kapp.slug}

space

The space the kapp belongs to.

${kapp.space}

title

The title of the kapp contains the name of the Space the kapp belongs to, and name of the Kapp. The format is {space.name} > {kapp.name}.

${kapp.title}

webhooks

A list of webhooks for the Space.

${kapp.webhooks}

Methods

getAttribute(name)

Returns the attribute identified by the name parameter if it exists.

${kapp.getAttribute(name)}

getAttributeValue(name)

Returns the value of the attribute identified by the name parameter if it exists and if the attribute only supports a single value. This is a shortcut for ${kapp.getAttribute(name).value} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${kapp.getAttributeValue(name)}

getAttributeValues(name)

Returns a list of values of the attribute identified by the name parameter if it exists and if the attribute support multiple values. This is a shortcut for ${kapp.getAttribute(name).values} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${kapp.getAttributeValues(name)}

hasAttribute(name)

Tests if the attribute identified by the name parameter exists. Returns true if the attribute does exist, otherwise false.

${kapp.hasAttribute(name)}

hasAttributeValue(name, value)

Tests if the attribute identified by the name parameter has the value identified by the value parameter. Returns true if the attribute does have the value, otherwise false.

${kapp.hasAttributeValue(name, value)}

getCategorization(categorySlug, formSlug)

Returns the Categorization object that corresponds to the category identified by the categorySlug parameter, and the form identified by the formSlug parameter.

${kapp.getCategorization(categorySlug, formSlug)}

getCategory(categorySlug)

Returns the Category object identified by the name parameter.

${kapp.getCategory(categorySlug)}

getCategoryAttributeDefinition(name)

Returns the Attribute Definition object that corresponds to the name parameter, and is Category type.

${kapp.getCategoryAttributeDefinition(name)}

getFieldByKey(key)

Returns the Kapp field identified by the key parameter. This method looks up the field using the field key.

${kapp.getFieldByKey(key)}

getFieldByName(name)

Returns the Kapp field identified by the name parameter. This method looks up the field using the field name.

${kapp.getFieldByName(name)}

getForm(slug)

Returns the Form object identified by the slug parameter.

${kapp.getForm(slug)}

getFormAttributeDefinition(name)

Returns the Attribute Definition object that corresponds to the name parameter, and is Form type.

${kapp.getFormAttributeDefinition(name)}

getFormType(type)

Returns the Form Type object identified by the type parameter.

${kapp.getFormType(type)}

getFormsByType(type)

A list of forms that are the same type identified by the type parameter.

${kapp.getFormsByType(type)}

getKappAttributeDefinition(name)

Returns the Attribute Definition object that corresponds to the name parameter, and is Kapp type.

${kapp.getKappAttributeDefinition(name)}

getSecurityPolicy(name)

Returns the Security Policy object identified by the name parameter.

${kapp.getSecurityPolicy(name)}

getSecurityPolicyDefinition(name)

Returns the Security Policy Definition object identified by the name parameter.

${kapp.getSecurityPolicyDefinition(name)}

getWebhook(name)

Returns the Webhook object identified by the name parameter.

${kapp.getWebhook(name)}

Related