Studio Jobs
For RapidIdentity to process the settings and configurations in Data Provider or Data Consumer applications, you will first need to run an associated job. Provider Jobs and Consumer Jobs are run at certain points of the configuration process as described below. Consumer and Metaverse Template Jobs construct the records listed in their job name by processing all applicable record mappings that target the given type.
Each of these can be accessed from Jobs in RapidIdentity Studio. Once jobs have been populated in this screen, they can be scheduled by clicking Configure in the rightmost column.
Note
A job can be run manually before a schedule is Enabled to verify the job results, and must be Enabled before the schedule will activate.
Note the Search and Filter options at the top to better focus Jobs searches. The filter is for choosing job type and the search is helpful for finding specific job names.
 |
Enabling Jobs
Once a job has been scheduled, it will need to be enabled before the schedule will apply. To do this, simply select the job from the list and click the Enable button in the bottom Action Bar.
 |
Once a job has been enabled to run on schedule, the checkmark in the selection column will change from a muted grey (
) to a dark green (
).
Job Actions
Once a job is running, its logs can be viewed as it runs, or the job can be canceled if needed.
 |
Viewing the log will open another tab and display the actions log of that job while it runs. Canceling a job will create a confirmation screen, and once that is accepted, the job will be marked as Cancelled.
Note
Canceling a job does not have an immediate effect. It will allow the current iteration or batch of the job to complete and then exit before the next iteration or batch starts. After a job is successfully canceled, the Job history will display it as such.
Job History
To download the logs once a job has been successfully run, select that job from the Jobs page and click History in the bottom Action Bar.
Note
Select one job or multiple jobs at a time to activate the History button.
With the job(s) selected, the right column menu appears providing the ability to Download Logs or View Logs. Downloading a Log will download a .log file that can be opened and examined further if necessary.
 |
Provider Jobs
The most commonly run jobs for Providers begin with provider: and are installed when the Community application is imported. Once the Data Provider settings and options have been fully configured and verified, select the jobs that begin with this prefix and click Run in the Action Bar.
Note
It is possible to run jobs in parallel. Some jobs may be dependent on other jobs; for example, Metaverse Jobs will not be able to populate data in the Metaverse namespace until at least one Provider Job has been run, and these can be run in sequential groups.
 |
If the import is successful, you can then access the imported records through the Data Explorer.
Template Jobs
Template Jobs are set up by the RapidIdentity Studio Application during configuration and are prefixed with either metaverse: or consumer:, depending on the namespace they are intended to populate. Run these jobs in parallel groups as needed to transfer data between namespaces.
Note
Metaverse Template jobs have the naming convention namespace:type and populate the Metaverse namespace, and Consumer Template Jobs also have the naming convention namespace:type but interact with the Consumer namespace.
There will be one job per type for any existing template that maps to that type.
 |
Depending on the Template Job type run, either the Metaverse namespace or the Consumer namespace will be updated.
Consumer Jobs
The most commonly run jobs for Consumers have the naming convention consumer:Application Name and are installed when the Community application is imported. Once the Data Consumer settings and options have been fully configured and verified, select the jobs that begin with this prefix and click Run in the Action Bar.
 |
This will push the finalized data to the final consumer.
Note
There are no jobs for pushing data downstream for REST Consumers.
Scheduling Jobs
Jobs can be scheduled for subsequent runs, though it is recommended to run each job at least once manually for verification. This can be done by clicking the Configure button in the rightmost column of the job in the main screen.
 |
The resulting screen will allow users with the Studio Admins role to predetermine when jobs will be run repeatedly. There are setting options for Minutes, Hours, Days, and Months as well as a Log Level option.
Note
Entering this menu will set a default starting schedule of 12:00 AM until settings are altered. The job will not retain a schedule until you click Save, at which point the schedule will be shown in the Schedule column of the Jobs menu.
In this menu, you have the option to run the job every X minutes beginning at a certain time, or multiple times per hour based on individual time placement choices. The default options are shown below.
 |
Jobs can be scheduled to run every X number of hours with a beginning start time or at certain hours of the day. This option would combine with the Minutes menu for a start time of 5:30, for example.
 |
The menu for Day options provides three ways of determining day choices. Schedule jobs every X number of days beginning on a certain day of the month, on certain days of the week, or specific days of the month.
 |
 |
The Month menu allows you to schedule jobs every X months starting in a certain month, or choose which months to apply to the schedule.
 |