Session ticket and AJAX

Use ticket while executing AJAX, which provides much of security rather than calling module directly through name.
Following are the syntaxes and examples:

To generate session ticket :

Syntax :

[session_ticket.create {token} set=template.ticket_id /]
[arr.create set=template.clxn]
	[post_type]{either a service slug or collection slug of app}[/post_type]
[/arr.create]

[session_ticket.create {token} set=template.ticket_id /]

[arr.create set=template.clxn]

[post_type]{either a service slug or collection slug of app}[/post_type]

[/arr.create]

Eg:
XHTML

[session_ticket.create {token} set=template.ticket_id /] [arr.create set=template.clxn] [post_type]enq_service[/post_type] [/arr.create]

1
2
3
4

[session_ticket.create {token} set=template.ticket_id /]
[arr.create set=template.clxn]
[post_type]enq_service[/post_type]
[/arr.create]

Set activity for session ticket

Syntax (app – module):
XHTML

[session_ticket.set_activity {template.ticket_id} collection='{collection_name}' module='{module_slug}.{template_slug}' /]

1
2
3

[session_ticket.set_activity {template.ticket_id}
collection='{collection_name}'
module='{module_slug}.{template_slug}' /]
Eg:
XHTML

[session_ticket.set_activity {template.ticket_id} collection='{template.clxn}' module='response_section.handler_mail_send' /]

1
2
3

[session_ticket.set_activity {template.ticket_id}
collection='{template.clxn}'
module='response_section.handler_mail_send' /]
Syntax (app – Service):
XHTML

[session_ticket.set_activity {template.ticket_id} app='system' service='{service_slug}.{module_slug}' /]

1
2

[session_ticket.set_activity {template.ticket_id}
app='system' service='{service_slug}.{module_slug}' /]
Eg:
XHTML

[session_ticket.set_activity {template.ticket_id} app='system' module='response_section.handler_mail_send' /]

1

[session_ticket.set_activity {template.ticket_id} app='system' module='response_section.handler_mail_send' /]

If you need to send any extra parameter in a request, in that case also use a ticket rather than a script attribute

Syntax:
XHTML

[session_ticket.set {template.ticket_id} field='{field_name}' value='{value}' /]

1

[session_ticket.set {template.ticket_id} field='{field_name}' value='{value}' /]
Eg:

[session_ticket.set {template.ticket_id} field='parent_form' value='{module.parent_form}' /]
[session_ticket.set {template.ticket_id} field='dept' value='{module.dept}' /]

1 2	[session_ticket.set {template.ticket_id} field='parent_form' value='{module.parent_form}' /] [session_ticket.set {template.ticket_id} field='dept' value='{module.dept}' /]

At last, write the spa script tag with other details of the script call.

Syantax:

<script type='spa/axn'
	axn='{any of the action of spa ie. form.ajax, form_upload.ajax etc}'
	bind='{bind event}'
	bind_selector="{bind element}"
	route_ajax='t/{ticket_variable}' >
</script>

axn='{any of the action of spa ie. form.ajax, form_upload.ajax etc}'

bind='{bind event}'

bind_selector="{bind element}"

route_ajax='t/{ticket_variable}' >

</script>

Eg:
XHTML

<script type='spa/axn' axn='form_upload.ajax' bind='submit' bind_selector="#[module.token/]" route_ajax='t/[template.ticket_id /]' > </script>

1
2
3
4
5
6

<script type='spa/axn'
axn='form_upload.ajax'
bind='submit'
bind_selector="#[module.token/]"
route_ajax='t/[template.ticket_id /]' >
</script>

URL to use Ticket

- XHTML
  
  Web URL: <site_url>/t/<ticket_id> SPA: route_ajax="t/<ticket_id>"
  
  1
  2
  
  Web URL: <site_url>/t/<ticket_id>
  SPA: route_ajax="t/<ticket_id>"

Use to manually handle ticket validation

- XHTML
  
  route_ajax="ticket-handler/<ticket_id>/submit"
  
  1
  
  route_ajax="ticket-handler/<ticket_id>/submit"

Ticket handler

Please visit: https://awxdocs.com/tutorials/ticket-handler/

Get all ticket data

---- <strong>template.otp_ticket_id</strong> is already set with session ticket data
[session_ticket.get main='{template.otp_ticket_id}' o.set=@template.ticket_data /]

1 2	---- <strong>template.otp_ticket_id</strong> is already set with session ticket data [session_ticket.get main='{template.otp_ticket_id}' o.set=@template.ticket_data /]

Destroy Ticket

- XHTML
  
  [session_ticket.destroy {template.otp_ticket_id} o.set=template.temp/]
  
  1
  
  [session_ticket.destroy {template.otp_ticket_id} o.set=template.temp/]

Update ticket validity

- XHTML
  
  [module.set ticket="5c75188e1d719" /] [session_ticket.set_timeout {module.ticket} time=120 o.set=module.x /] time=120 in minutes
  
  1
  2
  3
  
  [module.set ticket="5c75188e1d719" /]
  [session_ticket.set_timeout {module.ticket} time=120 o.set=module.x /]
  time=120 in minutes

Updated on Apr 05, 2024