External App Fields: Difference between revisions

From SMTX Wiki
Jump to navigation Jump to search
← Older edit
 
(21 intermediate revisions by the same user not shown)
Line 15: Line 15:
| The trigger causing the flow to start
| The trigger causing the flow to start
| Create version request
| Create version request
|-
| Publication requested - Guid
| Guid of the request
|
|-
| Publication requested - HashCheck
| This hash is required to submit a vote on this request through the webservice
|
|-
| Publication requested - Request comments
| Comments provided when this request was started
|
|-
| Publication requested - Request option
| In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
|
*Code
*Label
|-
| Publication requested - Type
| Type of the request that will steer what happens when publication is approved
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|-
| Publication requested - Type Name
| In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|}
|}


==Custom request==
==Custom request==
This trigger occurs when a (publication) request is started through the API. Custom requests can be used to lock a service while actions in the background are pending to be completed.
This trigger occurs when a (publication) request is started through the API. Custom requests can be used to lock a service while actions in the background are pending to be completed.
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
| Trigger action
| The trigger causing the flow to start
| Custom request
|-
| Publication requested - Guid
| Guid of the request
|
|-
| Publication requested - HashCheck
| This hash is required to submit a vote on this request through the webservice
|
|-
| Publication requested - Request comments
| Comments provided when this request was started
|
|-
| Publication requested - Request option
| In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
|
*Code
*Label
|-
| Publication requested - Type
| Type of the request that will steer what happens when publication is approved
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|-
| Publication requested - Type Name
| In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|}
==Delete request==
==Delete request==
This trigger occurs when the user clicks the button to delete a service
This trigger occurs when the user clicks the button to delete a service
Line 32: Line 117:
| The trigger causing the flow to start
| The trigger causing the flow to start
| Delete request
| Delete request
|-
| Publication requested - Guid
| Guid of the request
|
|-
| Publication requested - HashCheck
| This hash is required to submit a vote on this request through the webservice
|
|-
| Publication requested - Request comments
| Comments provided when this request was started
|
|-
| Publication requested - Request option
| In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
|
*Code
*Label
|-
| Publication requested - Type
| Type of the request that will steer what happens when publication is approved
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|-
| Publication requested - Type Name
| In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|}
|}


Line 108: Line 229:
|Contains the value before the edit
|Contains the value before the edit
|}
|}
Quality Note Saved - Action
Values: Added
Field: Trigger action
Values: Service published


==Lost child==
==Lost child==
This trigger occurs when a child relation is disconnected
This trigger occurs when a child relation is disconnected (using hierarchical relations)
{| class="wikitable"  
{| class="wikitable"  
|-
|-
Line 140: Line 256:
|  
|  
|}
|}
==Lost parent==
==Lost parent==
This trigger occurs when a parent relation is disconnected (using hierarchical relations)
This trigger occurs when a parent relation is disconnected (using hierarchical relations)
Line 153: Line 270:
| The trigger causing the flow to start
| The trigger causing the flow to start
| Lost parent
| Lost parent
|-
| Related service guid
| UniqueId of the unrelated service
|
|-
| Related service id
| Id of the unrelated service
|
|-
| Related service name
| Name of the unrelated service
|
|}
==Lost relation==
This trigger occurs when a relation is disconnected (using flat relations)
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
| Trigger action
| The trigger causing the flow to start
| Lost relation
|-
|-
| Related service guid
| Related service guid
Line 250: Line 394:
==Phase change==
==Phase change==
This trigger occurs when a the phase of a service is changed
This trigger occurs when a the phase of a service is changed
{|class="wikitable"
!colspan="3"|Fields containing specific values for this trigger
|-
!Field
!Field explained
!Possible content
|-
|Trigger action
|The trigger causing the flow to start
|Phase change
|-
|Phase changed - Old phase name
|Contains the old phase name
|Any of the phase names
|-
|Phase changed - Old phase type
|The type of the old phase
|
*Initial = 1,
*Uat = 2,
*Production = 3,
*Retired = 4
|-
|Phase changed - New phase name
|Contains the new phase name
|Any of the phase names
|-
|Phase changed - New phase type
|The type of the new phase
|
*Initial = 1,
*Uat = 2,
*Production = 3,
*Retired = 4
|}
==Publication request==
==Publication request==
This trigger occurs when the service is published
This trigger occurs when the service is published
Line 265: Line 445:
|-
|-
| Publication requested - Guid
| Publication requested - Guid
| Guid of the published service
| Guid of the request
|  
|  
|-
|-
| Publication requested - HashCheck
| Publication requested - HashCheck
| This hash is required to submit a vote on this publication request through the webservice
| This hash is required to submit a vote on this request through the webservice
|  
|  
|-
|-
| Publication requested - Request comments
| Publication requested - Request comments
| Comments provided when this publication was started
| Comments provided when this request was started
|  
|  
|-
|-
| Publication requested - Request option
| Publication requested - Request option
| In case an optional datastore is active for the publication action, the value selected in the dropdown list is in this field
| In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
|  
|  
*Code
*Code
Line 283: Line 463:
|-
|-
| Publication requested - Type
| Publication requested - Type
| Type of the publication that will steer what happens when publication is approved
| Type of the request that will steer what happens when publication is approved
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|-
| Publication requested - Type Name
| In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
|  
|  
*publish
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|}
|}


Line 310: Line 503:
*SolutionAdded
*SolutionAdded
*Deleted
*Deleted
*IsPublicChanged
|-
| Quality note saved - Created by person
| Properties of the person who created the note
|
|-
|-
| Quality note saved - Closed by person
| Quality note saved - Closed by person
| Id of the related service
| Properties of the person who closed the note
|  
|  
|-
|-
| Quality note saved - Created by person
| Quality note saved - Created date
| Name of the related service
| Creation date of the quality note
|  
|  
|-
|-
| Created date
| Quality note saved - Close date
| Creation date of the quality note
| Close date of the quality note
|  
|  
|-
|-
| Id
| Quality note saved - Id
| Unique Id of the quality note
| Id of the quality note
|  
|  
|-
|-
| Is closed
| Quality note saved - Is closed
| Indicator if note is closed
| Indicator if note is closed
|  
|  
*yes
*true (value) / yes (display value)
*no
*false (value) / no (display value)
|-
|-
| Note
| Quality note saved - Note
| Content of the quality note
| Content of the quality note
|  
|  
|-
|-
| Solution
| Quality note saved - Solution
| Solution provided with the quality note
| Solution provided with the quality note
|
|-
| Quality note saved - Guid (7.22.04)
| Guid of the quality note
|
|-
| Quality note saved - Closure code (7.22.04)
| Closure code of the quality note
|  
|  
|}
|}
Line 344: Line 550:
==Service creation==
==Service creation==
This trigger occurs when a new service is created
This trigger occurs when a new service is created
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
|Trigger action
|The trigger causing the flow to start
|Service creation
|}
==Service expired==
==Service expired==
This trigger is not active yet
This trigger is not active yet
Line 358: Line 577:
| Trigger action
| Trigger action
| The trigger causing the flow to start
| The trigger causing the flow to start
| Publication request
| Unpublish request
|-
|-
| Publication requested - Guid
| Publication requested - Guid
| Guid of the published service
| Guid of the request
|  
|  
|-
|-
| Publication requested - HashCheck
| Publication requested - HashCheck
| This hash is required to submit a vote on this publication request through the webservice
| This hash is required to submit a vote on this request through the webservice
|  
|  
|-
|-
| Publication requested - Request comments
| Publication requested - Request comments
| Comments provided when this publication was started
| Comments provided when this request was started
|  
|  
|-
|-
| Publication requested - Request option
| Publication requested - Request option
| In case an optional datastore is active for the publication action, the value selected in the dropdown list is in this field
| In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
|  
|  
*Code
*Code
Line 379: Line 598:
|-
|-
| Publication requested - Type
| Publication requested - Type
| Type of the publication that will steer what happens when publication is approved
| Type of the request that will steer what happens when publication is approved
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|-
| Publication requested - Type Name
| In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
|
*Publish
*Unpublish
*Delete
*Custom
*CreateVersion
|}
 
==Review cycle request (7.22.04)==
This trigger occurs when there is a review cycle request (eg completion)
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
| Trigger action
| The trigger causing the flow to start
| Review cycle request
|-
| Review cycle - Guid
| Guid of the request
|
|-
| Review cycle - HashCheck
| This hash is required to submit a vote on this request through the webservice
|
|-
| Review cycle - Request comments
| Comments provided when this request was started
|
|-
| Review cycle - Type
| Type of the request that will steer what happens when publication is approved
|
*Complete
|}
 
==Review cycle completed (7.22.04)==
This trigger occurs after a review cycle is completed
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
| Service review cycle id
| Id of the review cycle that is completed
|
|-
| Service review cycle guid
| Guid of the review cycle that is completed
|
|-
| Service review cycle request id
| Id of the review cycle request that caused the completion
|
|-
| Service review cycle request guid
| Guid  of the review cycle request that caused the completion
|
|}
 
==Review cycle expired (7.22.04)==
This trigger occurs when a review cycle expires
{| class="wikitable"
|-
! colspan="3" | Fields containing specific values for this trigger
|-
! Field
! Field explained
! Possible content
|-
| Service review cycle id
| Id of the review cycle that is expired
|
|-
| Service review cycle guid
| Guid of the review cycle that is expired
|  
|  
*publish
|}
|}

Latest revision as of 12:33, 26 March 2022

When publishing a service, the external app Services contains a large number of fields. Some of these fields contains codes. In this page an overview is provided of the values that can be expected in these codes:

Template Triggers

Create version request

This trigger occurs when the user clicks the button to create a new version

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Create version request
Publication requested - Guid Guid of the request
Publication requested - HashCheck This hash is required to submit a vote on this request through the webservice
Publication requested - Request comments Comments provided when this request was started
Publication requested - Request option In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
  • Code
  • Label
Publication requested - Type Type of the request that will steer what happens when publication is approved
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion
Publication requested - Type Name In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion

Custom request

This trigger occurs when a (publication) request is started through the API. Custom requests can be used to lock a service while actions in the background are pending to be completed.

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Custom request
Publication requested - Guid Guid of the request
Publication requested - HashCheck This hash is required to submit a vote on this request through the webservice
Publication requested - Request comments Comments provided when this request was started
Publication requested - Request option In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
  • Code
  • Label
Publication requested - Type Type of the request that will steer what happens when publication is approved
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion
Publication requested - Type Name In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion

Delete request

This trigger occurs when the user clicks the button to delete a service

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Delete request
Publication requested - Guid Guid of the request
Publication requested - HashCheck This hash is required to submit a vote on this request through the webservice
Publication requested - Request comments Comments provided when this request was started
Publication requested - Request option In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
  • Code
  • Label
Publication requested - Type Type of the request that will steer what happens when publication is approved
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion
Publication requested - Type Name In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion

Field change

This trigger occurs when a value in a field is changed.

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Field change
Field changed - Field essential phase name Contains the phase name from which onwards the field is essential. Is blank in case there is no essential phase for a field Any of the phase names
Field changed - Field essential phase type The type of the phase in which the service is
  • Initial = 1,
  • Uat = 2,
  • Production = 3,
  • Retired = 4
Field changed - Field internal name Internal name of the changed field
Field changed - Field is language dependent contains yes of field is language dependent, no if not
Field changed - Field name Name of the changed field
Field changed - Field type type of the changed field
  • Single text line
  • Multiple text lines
  • Dropdown list
  • Checkboxes
  • Date
  • Hidden
  • Multiple text lines with bb code
  • Numeric value
  • Radio buttons
  • Reusable content
  • Static html
  • Static text
  • Typeahead multiple selections
  • Typeahead single selections
  • Yes no
Field changed - Language The name of the field language any of the active language names, for example English
Field changed - Language id The id of the field language
  • 1 - English
  • 2 - Dutch
  • 3 - French
  • 4 - German

Other numbers should be checked in the language table

Field changed - New value Contains the value after the edit
Field changed - Old value Contains the value before the edit

Lost child

This trigger occurs when a child relation is disconnected (using hierarchical relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Lost child
Related service guid UniqueId of the unrelated service
Related service id Id of the unrelated service
Related service name Name of the unrelated service

Lost parent

This trigger occurs when a parent relation is disconnected (using hierarchical relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Lost parent
Related service guid UniqueId of the unrelated service
Related service id Id of the unrelated service
Related service name Name of the unrelated service

Lost relation

This trigger occurs when a relation is disconnected (using flat relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Lost relation
Related service guid UniqueId of the unrelated service
Related service id Id of the unrelated service
Related service name Name of the unrelated service

New child

This trigger occurs when a new child relation is set (using hierarchical relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start New child
Related service guid UniqueId of the related service
Related service id Id of the related service
Related service name Name of the related service

New parent

This trigger occurs when a new parent relation is set (using hierarchical relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start New parent
Related service guid UniqueId of the related service
Related service id Id of the related service
Related service name Name of the related service

New relation

This trigger occurs when a new relation is set (using flat relations)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start New relation
Related service guid UniqueId of the related service
Related service id Id of the related service
Related service name Name of the related service

Phase change

This trigger occurs when a the phase of a service is changed

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Phase change
Phase changed - Old phase name Contains the old phase name Any of the phase names
Phase changed - Old phase type The type of the old phase
  • Initial = 1,
  • Uat = 2,
  • Production = 3,
  • Retired = 4
Phase changed - New phase name Contains the new phase name Any of the phase names
Phase changed - New phase type The type of the new phase
  • Initial = 1,
  • Uat = 2,
  • Production = 3,
  • Retired = 4

Publication request

This trigger occurs when the service is published

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Publication request
Publication requested - Guid Guid of the request
Publication requested - HashCheck This hash is required to submit a vote on this request through the webservice
Publication requested - Request comments Comments provided when this request was started
Publication requested - Request option In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
  • Code
  • Label
Publication requested - Type Type of the request that will steer what happens when publication is approved
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion
Publication requested - Type Name In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion

Quality note change

This trigger occurs when a new quality note is added or an existing note is updated

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Quality note change
Quality note saved - Action The action performed on the quality note
  • Added
  • Updated
  • SolutionAdded
  • Deleted
  • IsPublicChanged
Quality note saved - Created by person Properties of the person who created the note
Quality note saved - Closed by person Properties of the person who closed the note
Quality note saved - Created date Creation date of the quality note
Quality note saved - Close date Close date of the quality note
Quality note saved - Id Id of the quality note
Quality note saved - Is closed Indicator if note is closed
  • true (value) / yes (display value)
  • false (value) / no (display value)
Quality note saved - Note Content of the quality note
Quality note saved - Solution Solution provided with the quality note
Quality note saved - Guid (7.22.04) Guid of the quality note
Quality note saved - Closure code (7.22.04) Closure code of the quality note

Service creation

This trigger occurs when a new service is created

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Service creation

Service expired

This trigger is not active yet

Unpublish request

This trigger occurs when the users clicks the unpublish button

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Unpublish request
Publication requested - Guid Guid of the request
Publication requested - HashCheck This hash is required to submit a vote on this request through the webservice
Publication requested - Request comments Comments provided when this request was started
Publication requested - Request option In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field
  • Code
  • Label
Publication requested - Type Type of the request that will steer what happens when publication is approved
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion
Publication requested - Type Name In case of a custom request, the resulting action can be the same as for a predefined request? If so, this value will contain Type which it imitates
  • Publish
  • Unpublish
  • Delete
  • Custom
  • CreateVersion

Review cycle request (7.22.04)

This trigger occurs when there is a review cycle request (eg completion)

Fields containing specific values for this trigger
Field Field explained Possible content
Trigger action The trigger causing the flow to start Review cycle request
Review cycle - Guid Guid of the request
Review cycle - HashCheck This hash is required to submit a vote on this request through the webservice
Review cycle - Request comments Comments provided when this request was started
Review cycle - Type Type of the request that will steer what happens when publication is approved
  • Complete

Review cycle completed (7.22.04)

This trigger occurs after a review cycle is completed

Fields containing specific values for this trigger
Field Field explained Possible content
Service review cycle id Id of the review cycle that is completed
Service review cycle guid Guid of the review cycle that is completed
Service review cycle request id Id of the review cycle request that caused the completion
Service review cycle request guid Guid of the review cycle request that caused the completion

Review cycle expired (7.22.04)

This trigger occurs when a review cycle expires

Fields containing specific values for this trigger
Field Field explained Possible content
Service review cycle id Id of the review cycle that is expired
Service review cycle guid Guid of the review cycle that is expired
Retrieved from "https://wiki.smt-x.com/index.php?title=External_App_Fields&oldid=554"