Skip to content

Ideal for Government agencies looking to fast-track digital transformation with secure, compliant, and user-friendly digital products.

Notifications You must be signed in to change notification settings

jspirkosn/Digital-Product-Factory-Core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

Digital-Product-Factory-Core

The Digital Product Factory fast-tracks digital transformation by automating the builds of secure, compliant, and user-friendly digital products and services that run on the ServiceNow platform.

Using the Digital Product Factory

There are two ways to use the Digital Product Factory: install it on your instance following the installation instructions below or use the current version on our shared instance.

  • Get a Link to our shared instance (Request in email)
    • Once logged in to an instance with the factory installed, go to the Employee Center (https://[your_instance].service-now.com/esc) and click on the "Digital Factory Services" menu image

    • Select one of the available factories and fill out the form

      Note: If the developer you specify is not a user, the factory will create the user and assign them development privileges to this app only

    • Submit the form

    • Within five minutes, an email will be sent to the developer and the submitter with instructions on interacting with and further developing the digital product. See the example below: image

    Factory Installation Instructions

    1. Install the following pre-requisite plugins onto the target instance (instance that will contain the factory application)
      • Workflow Studio
      • ServiceNow IntegrationHub Action Step - JSON Builder
      • App Engine Studio
    2. GitHub Access - use an existing account or GitHub Create Account
    3. Log into your GitHub Account
    4. In the browser where you logged in to GitHub, paste this URL: [https://github.com/jspirkosn/Digital-Product-Factory-Core]
    5. In the upper right-hand corner of the page, you should see a button to fork the repo. Click to create your fork
    6. Create a ServiceNow Credential - if you have a GitHub credential for ServiceNow, skip this step
      • Go to https://github.com/settings/tokens, and under Tokens (classic), click on "Generate new token"
      • Copy the token you generated; you'll need it in the next step
      • In the ServiceNow Navigator, go to "Connections & Credentials" -> "Credentials"
      • Click on "New" to create a new credential
      • Chose "Basic Auth Credential"
      • Give it a name and enter your GitHub User Name and Enter the token from above as your password (Note: your GitHub password won't work)
    7. In the ServiceNow Navigator, go to "System Applications" -> "Studio"
    8. A dialog appears - click on "Import from Source Control"
    9. Post Installation Instructions
      • On the target instance, set the permission for these four tables as shown below (You must be an admin to do this) image These are direct links to the permission pages:
        • Sys_user_group: https://[your_instance].service-now.com/now/nav/ui/classic/params/target/sys_db_object.do%3Fsys_id%3Dsys_user_group%26sysparm_refkey%3Dname
        • Sc_category: https://[your_instance].service-now.com/now/nav/ui/classic/params/target/sys_db_object.do%3Fsys_id%3Dsc_category%26sysparm_refkey%3Dname
        • Sc_cat_item: https://[your_instance].service-now.com/now/nav/ui/classic/params/target/sys_db_object.do%3Fsys_id%3Dsc_cat_item%26sysparm_refkey%3Dname
        • Sc_cat_item_category: https://[your_instance].service-now.com/now/nav/ui/classic/params/target/sys_db_object.do%3Fsys_id%3Dsc_cat_item_category%26sysparm_refkey%3Dname
    10. Access the Employee Service Center - [your instance]/esc
      • Click on the "Digital Factory Services" topic
      • Select the "Digital Product Factory for Government Agencies" catalog item Note: You can not run the Digital Product Factories until you have installed at least one template
    11. See the "Installing Factory Templates" section for your Industry

    Note: The factory will need to have the appropriate templates before it can build a product

    The core install is now complete!

    Installing Factory Templates

    The factory runs purpose-built factory templates. This section will walk you through how to install the available templates.

    Public Sector Factory Templates All Public Sector template repositories are pre-fixed with PST; for example, "PST- HHS Program Support Desk." The Digital Product Factory for Public Sector is part of the Digital Product Factory Core. Still, you will need to install the templates below or create templates for the factory to function.

    The list below contains a series of templates. Follow these instructions for each template. The illustration below the templates shows a list of dependent plugins.

    1. Log into your GitHub Account (see the factory installation section above for more details)
    2. In the browser where you logged in to GitHub, paste the template URL you want to install from the List of Available Public Sector Factory Templates below
    3. In the upper right-hand corner of the page, you should see a button to fork the repo. Click to create your fork
    4. Note the URL of your new repository that was created. It should be similar to the name of the repo you forked in the last step
    5. You should already have a GitHub credential in your ServiceNow instance, if you don't (see the factory installation section above for more details on how to get one)
    6. In the ServiceNow Navigator, go to "System Applications" -> "Studio"
    7. A dialog appears - click on "Import from Source Control"
      • URL: https://github.com/[your github user]/[template repository] (this is a reference to the forked repo you created above)
      • Branch: main
      • Credential: chose GitHub credential

    List of Available Public Sector Factory Templates:

    1. PST - HHS Program Support Desk https://github.com/jspirkosn/PST---HHS-Program-Support-Desk image
    2. PST - Licensing and Permitting https://github.com/jspirkosn/PST---Licensing-and-Permitting image
    Financial Services Factory Templates All Financial Services template repositories are pre-fixed with FST; for example, "FST - Power of Attorney." The Digital Product Factory for Financial Services is part of the Digital Product Factory Core but you will need to install the templates below or create your own templates for the factory to function.

    List of Available Financial Service Factory Templates:

    1. Coming Soon
    2. Coming Soon

    Creating New Factory Templates

    This section provides the details needed to build and add a new template to the Digital Product Factory.

    1. Open App Engine Studio and Go to Templates image

    2. hover over any of the existing factory templates and choose "use template"

    3. When the app creator comes up, choose a name that represents your new template but don't name it the same as your template

    4. In the example below, I'm creating a template for licensing and permitting, so I named it "Pub Sub" to represent a Public Sector Sub-App and "licenses and permits" to represent the type of services the app will provide image

    5. You now have an app that your template will be based on, as shown below image

    6. Configure the app that will be the basis for the template

      • Configure Tables
        • Use the {program name} tag in your table labels (A factory workflow will replace that tag with the Product Name)
        • In the next step, you will create at least one record producer for each of these tables (these tables should extend the industry model tables and comply with the industry reference architecture)
      • Configure the record producers
        • There are two types of record producers: one used on the Service Delivery Side and the other on the Service Support side. The difference between the two is in the objects associated with them by the factory. The support side records producers are classified according to the CSDM, and the delivery side uses the industry data models provided by the ServiceNow industry teams.

        • For the support type, the factory populates the business service and provides a list selector for the offering (Note: you can only submit tasks against the services contained in this product)

        • For the support type, use the {program name support} tag in the label; this is how the factory knows to pre-populate the business service, and the service offering selector is dependent on it

        • For the support type, you must leave the Business Service ID and the Service Offering questions on the record producer for the factory to populate them; see example below image

        • For the delivery type, the factory populates the product model, service (CSM Service, not CSDM service), and assignment group

        • For the delivery type, use the {program name deliver} tag in the label; this is how the factory knows to pre-populate the product model, assignment group, and case type

        • For the delivery type, you must leave the Product, Service, and Assignment Group questions on the record producer for the factory to populate them; see example below image

      • Configure the playbook and flows
        • Do not alter the {program name} Initialize flow; the factory calls this flow to configure the application
        • Use the {program name} tag in your table labels (A factory workflow will replace that tag with the Product Name) image
    7. In App Engine Studio, Go to Templates

    8. Click "Create new template" in the upper right and select "Existing app"

    9. Open Workflow Studio and open the "Build a New Digital Product" flow

    10. Copy one of the sections shown in steps 13 through 17 below image

    11. In the navigator, type "sys_app_template.list" to open the App Template table

    12. Find your template and open the template record

    13. Open the hamburger menu and copy the sys_id as shown below image

    14. Go back to the Workflow "Build a New Digital Product" workflow and past your sys_id in the "Invoke Product Templates" Action Step as shown below image

    15. After the "Invoke Product Templates" call the "Initialize Product" action as shown below (this is a call back to the newly build app to configure names) image

    16. After the "Initialize Product" set flow variables as shown below image

    17. After the flow variables configure the developer notification email as shown below image image

    About

    Ideal for Government agencies looking to fast-track digital transformation with secure, compliant, and user-friendly digital products.

    Resources

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published